Booster.Microservices

<back to all web services

SitesRequest

Requires Authentication
The following routes are available for this service:
GET/warranty/v1/sites
import Foundation
import ServiceStack

public class SitesRequest : BaseRequest<SitesResponse>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class BaseRequest<TResponse : Codable> : IRequest, Codable
{
    public var sid:String
    public var app:String
    public var _os:String
    public var _appVersion:String
    public var _searchMethod:String

    required public init(){}
}

public class SitesResponse : BaseResponse
{
    public var sites:[Site] = []

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

    private enum CodingKeys : String, CodingKey {
        case sites
    }

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

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if sites.count > 0 { try container.encode(sites, forKey: .sites) }
    }
}

public class BaseResponse : IRespose, Codable
{
    public var _xmlns:String
    public var _type:String
    public var _source:String
    public var _tstamp:String
    public var _user:String
    public var _env:String
    public var _uri:String
    public var _query:String

    required public init(){}
}

public class Site : ILookupInt, Codable
{
    public var object:String
    public var id:Int
    public var name:String
    public var address:Address
    public var brands:[Brand] = []
    public var users:[User] = []
    public var isNfcActive:Int
    public var isIOsEmbReaderEnable:Int
    public var crmPrivacyPolicyMandatory:Bool
    public var crmAllowStoreDataAbroadVisible:Bool
    public var displayFirstLastNameNotLatin:Bool
    public var languageTransliteration:String
    public var crmPrivacyPolicyTimeValleeMandatory:Bool
    public var crmAllowStoreDataAbroadTimeValleeVisible:Bool
    public var allowToCreateEndCustomerOutsideChina:Bool
    public var isTimeVallee:Bool
    public var doNotDisplayPOSDataInDisclaimers:Bool
    public var crmFirstNameMandatory:Bool
    public var manageOwnStock:Bool
    public var crmCityMandatory:Bool

    required public init(){}
}

public class Address : Codable
{
    public var line1:String
    public var city:String
    public var zipCode:String
    public var countryCode:String

    required public init(){}
}

public class Brand : Codable
{
    public var brand:String
    public var lastStockTakingDate:String
    public var isAutomaticInvoiceNumberEnabled:Int
    public var saleRepRequired:Bool
    public var crmSaleRepRequired:Bool
    public var showPromoterType:Bool
    public var stockOwner:Int

    required public init(){}
}

public class User : ILookupString, Codable
{
    public var object:String
    public var id:String
    public var brand:String
    public var displayName:String

    required public init(){}
}


Swift SitesRequest 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 /warranty/v1/sites HTTP/1.1 
Host: qp-microservices-booster.richemont.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SitesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Pos">
  <_env xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_env>
  <_query xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_query>
  <_source xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_source>
  <_tstamp xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_tstamp>
  <_type xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_type>
  <_uri xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_uri>
  <_user xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_user>
  <_xmlns xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_xmlns>
  <sites>
    <Site>
      <address>
        <city>String</city>
        <countryCode>String</countryCode>
        <line1>String</line1>
        <zipCode>String</zipCode>
      </address>
      <allowToCreateEndCustomerOutsideChina>false</allowToCreateEndCustomerOutsideChina>
      <brands>
        <Brand>
          <brand>String</brand>
          <crmSaleRepRequired>false</crmSaleRepRequired>
          <isAutomaticInvoiceNumberEnabled>0</isAutomaticInvoiceNumberEnabled>
          <lastStockTakingDate>String</lastStockTakingDate>
          <saleRepRequired>false</saleRepRequired>
          <showPromoterType>false</showPromoterType>
          <stockOwner>0</stockOwner>
        </Brand>
      </brands>
      <crmAllowStoreDataAbroadTimeValleeVisible>false</crmAllowStoreDataAbroadTimeValleeVisible>
      <crmAllowStoreDataAbroadVisible>false</crmAllowStoreDataAbroadVisible>
      <crmCityMandatory>false</crmCityMandatory>
      <crmFirstNameMandatory>false</crmFirstNameMandatory>
      <crmPrivacyPolicyMandatory>false</crmPrivacyPolicyMandatory>
      <crmPrivacyPolicyTimeValleeMandatory>false</crmPrivacyPolicyTimeValleeMandatory>
      <displayFirstLastNameNotLatin>false</displayFirstLastNameNotLatin>
      <doNotDisplayPOSDataInDisclaimers>false</doNotDisplayPOSDataInDisclaimers>
      <id>0</id>
      <isIOsEmbReaderEnable>0</isIOsEmbReaderEnable>
      <isNfcActive>0</isNfcActive>
      <isTimeVallee>false</isTimeVallee>
      <languageTransliteration>String</languageTransliteration>
      <manageOwnStock>false</manageOwnStock>
      <name>String</name>
      <object>String</object>
      <users>
        <User>
          <brand>String</brand>
          <displayName>String</displayName>
          <id>String</id>
          <object>String</object>
        </User>
      </users>
    </Site>
  </sites>
</SitesResponse>