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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	sites: 
	[
		{
			object: String,
			id: 0,
			name: String,
			address: 
			{
				line1: String,
				city: String,
				zipCode: String,
				countryCode: String
			},
			brands: 
			[
				{
					brand: String,
					lastStockTakingDate: String,
					isAutomaticInvoiceNumberEnabled: 0,
					saleRepRequired: False,
					crmSaleRepRequired: False,
					showPromoterType: False,
					stockOwner: 0
				}
			],
			users: 
			[
				{
					object: String,
					id: String,
					brand: String,
					displayName: String
				}
			],
			isNfcActive: 0,
			isIOsEmbReaderEnable: 0,
			crmPrivacyPolicyMandatory: False,
			crmAllowStoreDataAbroadVisible: False,
			displayFirstLastNameNotLatin: False,
			languageTransliteration: String,
			crmPrivacyPolicyTimeValleeMandatory: False,
			crmAllowStoreDataAbroadTimeValleeVisible: False,
			allowToCreateEndCustomerOutsideChina: False,
			isTimeVallee: False,
			doNotDisplayPOSDataInDisclaimers: False,
			crmFirstNameMandatory: False,
			manageOwnStock: False,
			crmCityMandatory: False
		}
	],
	_xmlns: String,
	_type: String,
	_source: String,
	_tstamp: String,
	_user: String,
	_env: String,
	_uri: String,
	_query: String
}