#Script Pages

<back to all web services

QueryCustomers

import Foundation
import ServiceStack

public class QueryCustomers : QueryDb<Customer>
{
    public var customerId:String
    public var companyNameContains:String
    public var countryIn:[String]

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

    private enum CodingKeys : String, CodingKey {
        case customerId
        case companyNameContains
        case countryIn
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        customerId = try container.decodeIfPresent(String.self, forKey: .customerId)
        companyNameContains = try container.decodeIfPresent(String.self, forKey: .companyNameContains)
        countryIn = try container.decodeIfPresent([String].self, forKey: .countryIn) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if customerId != nil { try container.encode(customerId, forKey: .customerId) }
        if companyNameContains != nil { try container.encode(companyNameContains, forKey: .companyNameContains) }
        if countryIn != nil { try container.encode(countryIn, forKey: .countryIn) }
    }
}

public class Customer : Codable
{
    public var customerId:String
    public var companyName:String
    public var address:String
    public var city:String
    public var region:String
    public var postalCode:String
    public var country:String
    public var phone:String
    public var fax:String
    public var orders:[Order] = []

    required public init(){}
}

public class Order : Codable
{
    public var orderId:Int
    public var customerId:String
    public var orderDate:Date
    public var total:Double

    required public init(){}
}

public class GithubRepo : Codable
{
    public var id:Int
    public var name:String
    public var Description:String
    public var homepage:String
    public var language:String
    public var watchers_Count:Int
    public var stargazes_Count:Int
    public var forks_Count:Int
    public var open_Issues_Count:Int
    public var size:Int
    public var full_Name:String
    public var created_at:Date
    public var pushed_At:Date?
    public var updated_At:Date?
    public var has_issues:Bool
    public var has_Downloads:Bool
    public var has_Wiki:Bool
    public var has_Pages:Bool
    public var fork:Bool
    public var owner:GithubUser
    public var svn_Url:String
    public var mirror_Url:String
    public var url:String
    public var ssh_Url:String
    public var html_Url:String
    public var clone_Url:String
    public var git_Url:String
    public var `private`:Bool

    required public init(){}
}

public class GithubUser : Codable
{
    public var id:Int
    public var login:String
    public var avatar_Url:String
    public var url:String
    public var followers:Int?
    public var following:Int?
    public var type:String
    public var public_Gists:Int?
    public var location:String
    public var company:String
    public var html_Url:String
    public var public_Repos:Int?
    public var created_At:Date?
    public var blog:String
    public var email:String
    public var name:String
    public var hireable:Bool?
    public var gravatar_Id:String
    public var bio:String

    required public init(){}
}


Swift QueryCustomers 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.

POST /xml/reply/QueryCustomers HTTP/1.1 
Host: sharpscript.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SharpScript">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <CompanyNameContains>String</CompanyNameContains>
  <CountryIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CountryIn>
  <CustomerId>String</CustomerId>
</QueryCustomers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCustomerA703xr44 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/SharpScript">
    <d2p1:Customer>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:Orders>
        <d2p1:Order>
          <d2p1:CustomerId>String</d2p1:CustomerId>
          <d2p1:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
          <d2p1:OrderId>0</d2p1:OrderId>
          <d2p1:Total>0</d2p1:Total>
        </d2p1:Order>
      </d2p1:Orders>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
    </d2p1:Customer>
  </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>
</QueryResponseOfCustomerA703xr44>