Booster.Microservices

<back to all web services

SitesRequest

Requires Authentication
The following routes are available for this service:
GET/warranty/v1/sites
"use strict";
/** @typedef TResponse {any} */
export class BaseRequest {
    /** @param {{sid?:string,app?:string,_os?:string,_appVersion?:string,_searchMethod?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    sid;
    /** @type {string} */
    app;
    /** @type {string} */
    _os;
    /** @type {string} */
    _appVersion;
    /** @type {string} */
    _searchMethod;
}
export class BaseResponse {
    /** @param {{_xmlns?:string,_type?:string,_source?:string,_tstamp?:string,_user?:string,_env?:string,_uri?:string,_query?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    _xmlns;
    /** @type {string} */
    _type;
    /** @type {string} */
    _source;
    /** @type {string} */
    _tstamp;
    /** @type {string} */
    _user;
    /** @type {string} */
    _env;
    /** @type {string} */
    _uri;
    /** @type {string} */
    _query;
}
export class Address {
    /** @param {{line1?:string,city?:string,zipCode?:string,countryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    line1;
    /** @type {string} */
    city;
    /** @type {string} */
    zipCode;
    /** @type {string} */
    countryCode;
}
export class Brand {
    /** @param {{brand?:string,lastStockTakingDate?:string,isAutomaticInvoiceNumberEnabled?:number,saleRepRequired?:boolean,crmSaleRepRequired?:boolean,showPromoterType?:boolean,stockOwner?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    brand;
    /** @type {string} */
    lastStockTakingDate;
    /** @type {number} */
    isAutomaticInvoiceNumberEnabled;
    /** @type {boolean} */
    saleRepRequired;
    /** @type {boolean} */
    crmSaleRepRequired;
    /** @type {boolean} */
    showPromoterType;
    /** @type {number} */
    stockOwner;
}
export class User {
    /** @param {{object?:string,id?:string,brand?:string,displayName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    object;
    /** @type {string} */
    id;
    /** @type {string} */
    brand;
    /** @type {string} */
    displayName;
}
export class Site {
    /** @param {{object?:string,id?:number,name?:string,address?:Address,brands?:Brand[],users?:User[],isNfcActive?:number,isIOsEmbReaderEnable?:number,crmPrivacyPolicyMandatory?:boolean,crmAllowStoreDataAbroadVisible?:boolean,displayFirstLastNameNotLatin?:boolean,languageTransliteration?:string,crmPrivacyPolicyTimeValleeMandatory?:boolean,crmAllowStoreDataAbroadTimeValleeVisible?:boolean,allowToCreateEndCustomerOutsideChina?:boolean,isTimeVallee?:boolean,doNotDisplayPOSDataInDisclaimers?:boolean,crmFirstNameMandatory?:boolean,manageOwnStock?:boolean,crmCityMandatory?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    object;
    /** @type {number} */
    id;
    /** @type {string} */
    name;
    /** @type {Address} */
    address;
    /** @type {Brand[]} */
    brands;
    /** @type {User[]} */
    users;
    /** @type {number} */
    isNfcActive;
    /** @type {number} */
    isIOsEmbReaderEnable;
    /** @type {boolean} */
    crmPrivacyPolicyMandatory;
    /** @type {boolean} */
    crmAllowStoreDataAbroadVisible;
    /** @type {boolean} */
    displayFirstLastNameNotLatin;
    /** @type {string} */
    languageTransliteration;
    /** @type {boolean} */
    crmPrivacyPolicyTimeValleeMandatory;
    /** @type {boolean} */
    crmAllowStoreDataAbroadTimeValleeVisible;
    /** @type {boolean} */
    allowToCreateEndCustomerOutsideChina;
    /** @type {boolean} */
    isTimeVallee;
    /** @type {boolean} */
    doNotDisplayPOSDataInDisclaimers;
    /** @type {boolean} */
    crmFirstNameMandatory;
    /** @type {boolean} */
    manageOwnStock;
    /** @type {boolean} */
    crmCityMandatory;
}
export class SitesResponse extends BaseResponse {
    /** @param {{sites?:Site[],_xmlns?:string,_type?:string,_source?:string,_tstamp?:string,_user?:string,_env?:string,_uri?:string,_query?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {Site[]} */
    sites;
}
export class SitesRequest extends BaseRequest {
    /** @param {{sid?:string,app?:string,_os?:string,_appVersion?:string,_searchMethod?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript 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>