Booster.Microservices

<back to all web services

SitesRequest

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

export class BaseRequest<TResponse> implements IRequest
{
    public sid: string;
    public app: string;
    public _os: string;
    public _appVersion: string;
    public _searchMethod: string;

    public constructor(init?: Partial<BaseRequest<TResponse>>) { (Object as any).assign(this, init); }
}

export class BaseResponse implements IRespose
{
    public _xmlns: string;
    public _type: string;
    public _source: string;
    public _tstamp: string;
    public _user: string;
    public _env: string;
    public _uri: string;
    public _query: string;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class Address
{
    public line1: string;
    public city: string;
    public zipCode: string;
    public countryCode: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

export class Brand
{
    public brand: string;
    public lastStockTakingDate: string;
    public isAutomaticInvoiceNumberEnabled: number;
    public saleRepRequired: boolean;
    public crmSaleRepRequired: boolean;
    public showPromoterType: boolean;
    public stockOwner: number;

    public constructor(init?: Partial<Brand>) { (Object as any).assign(this, init); }
}

export class User implements ILookupString
{
    public object: string;
    public id: string;
    public brand: string;
    public displayName: string;

    public constructor(init?: Partial<User>) { (Object as any).assign(this, init); }
}

export class Site implements ILookupInt
{
    public object: string;
    public id: number;
    public name: string;
    public address: Address;
    public brands: Brand[];
    public users: User[];
    public isNfcActive: number;
    public isIOsEmbReaderEnable: number;
    public crmPrivacyPolicyMandatory: boolean;
    public crmAllowStoreDataAbroadVisible: boolean;
    public displayFirstLastNameNotLatin: boolean;
    public languageTransliteration: string;
    public crmPrivacyPolicyTimeValleeMandatory: boolean;
    public crmAllowStoreDataAbroadTimeValleeVisible: boolean;
    public allowToCreateEndCustomerOutsideChina: boolean;
    public isTimeVallee: boolean;
    public doNotDisplayPOSDataInDisclaimers: boolean;
    public crmFirstNameMandatory: boolean;
    public manageOwnStock: boolean;
    public crmCityMandatory: boolean;

    public constructor(init?: Partial<Site>) { (Object as any).assign(this, init); }
}

export class SitesResponse extends BaseResponse
{
    public sites: Site[];

    public constructor(init?: Partial<SitesResponse>) { super(init); (Object as any).assign(this, init); }
}

export class SitesRequest extends BaseRequest<SitesResponse>
{

    public constructor(init?: Partial<SitesRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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
}