MyApp

<back to all web services

QueryTodos

todos
The following routes are available for this service:
GET/todos
import Foundation
import ServiceStack

public class QueryTodos : QueryData<Todo>
{
    public var id:Int?
    public var ids:[Int]
    public var textContains:String
    // @DataMember(Order=1)
    public var skip:Int?

    // @DataMember(Order=2)
    public var take:Int?

    // @DataMember(Order=3)
    public var orderBy:String

    // @DataMember(Order=4)
    public var orderByDesc:String

    // @DataMember(Order=5)
    public var include:String

    // @DataMember(Order=6)
    public var fields:String

    // @DataMember(Order=7)
    public var meta:[String:String]

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case ids
        case textContains
        case skip
        case take
        case orderBy
        case orderByDesc
        case include
        case fields
        case meta
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        ids = try container.decodeIfPresent([Int].self, forKey: .ids) ?? []
        textContains = try container.decodeIfPresent(String.self, forKey: .textContains)
        skip = try container.decodeIfPresent(Int.self, forKey: .skip)
        take = try container.decodeIfPresent(Int.self, forKey: .take)
        orderBy = try container.decodeIfPresent(String.self, forKey: .orderBy)
        orderByDesc = try container.decodeIfPresent(String.self, forKey: .orderByDesc)
        include = try container.decodeIfPresent(String.self, forKey: .include)
        fields = try container.decodeIfPresent(String.self, forKey: .fields)
        meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if ids.count > 0 { try container.encode(ids, forKey: .ids) }
        if textContains != nil { try container.encode(textContains, forKey: .textContains) }
        if skip != nil { try container.encode(skip, forKey: .skip) }
        if take != nil { try container.encode(take, forKey: .take) }
        if orderBy != nil { try container.encode(orderBy, forKey: .orderBy) }
        if orderByDesc != nil { try container.encode(orderByDesc, forKey: .orderByDesc) }
        if include != nil { try container.encode(include, forKey: .include) }
        if fields != nil { try container.encode(fields, forKey: .fields) }
        if meta.count > 0 { try container.encode(meta, forKey: .meta) }
    }
}

public class Todo : Codable
{
    public var id:Int
    public var text:String
    public var isFinished:Bool

    required public init(){}
}


Swift QueryTodos DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /todos HTTP/1.1 
Host: vue-vite-api.jamstacks.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfTodotlJ4_P31p xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
    <d2p1:Todo>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsFinished>false</d2p1:IsFinished>
      <d2p1:Text>String</d2p1:Text>
    </d2p1:Todo>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfTodotlJ4_P31p>