Booster.Microservices

<back to all web services

RetrieveWarrantyCardRequest

Requires Authentication
The following routes are available for this service:
GET/warranty/v1/card/{cardId}
"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 LookupInt {
    /** @param {{object?:string,id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    object;
    /** @type {number} */
    id;
}
export class Article {
    /** @param {{ref?:string,serial?:string,name?:string,site?:LookupInt,brand?:string,isConsignment?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ref;
    /** @type {string} */
    serial;
    /** @type {string} */
    name;
    /** @type {LookupInt} */
    site;
    /** @type {string} */
    brand;
    /** @type {boolean} */
    isConsignment;
}
export class Address {
    /** @param {{line1?:string,line2?:string,city?:string,zipCode?:string,countryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    line1;
    /** @type {string} */
    line2;
    /** @type {string} */
    city;
    /** @type {string} */
    zipCode;
    /** @type {string} */
    countryCode;
}
export class Site {
    /** @param {{object?:string,id?:string,name?:string,address?:Address,crmPrivacyPolicyMandatory?:boolean,crmAllowStoreDataAbroadVisible?:boolean,isTimeVallee?:boolean,crmPrivacyPolicyTimeValleeMandatory?:boolean,crmAllowStoreDataAbroadTimeValleeVisible?:boolean,allowToCreateEndCustomerOutsideChina?:boolean,displayFirstLastNameNotLatin?:boolean,languageTransliteration?:string,doNotDisplayPOSDataInDisclaimers?:boolean,crmFirstNameMandatory?:boolean,crmCityMandatory?:boolean,manageOwnStock?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    object;
    /** @type {string} */
    id;
    /** @type {string} */
    name;
    /** @type {Address} */
    address;
    /** @type {boolean} */
    crmPrivacyPolicyMandatory;
    /** @type {boolean} */
    crmAllowStoreDataAbroadVisible;
    /** @type {boolean} */
    isTimeVallee;
    /** @type {boolean} */
    crmPrivacyPolicyTimeValleeMandatory;
    /** @type {boolean} */
    crmAllowStoreDataAbroadTimeValleeVisible;
    /** @type {boolean} */
    allowToCreateEndCustomerOutsideChina;
    /** @type {boolean} */
    displayFirstLastNameNotLatin;
    /** @type {string} */
    languageTransliteration;
    /** @type {boolean} */
    doNotDisplayPOSDataInDisclaimers;
    /** @type {boolean} */
    crmFirstNameMandatory;
    /** @type {boolean} */
    crmCityMandatory;
    /** @type {boolean} */
    manageOwnStock;
}
export class Warranty {
    /** @param {{article?:Article[],warrantyId?:string,createdBy?:string,createdAt?:string,issuedBy?:string,selloutId?:string,activationDate?:string,pin?:string,promoterTypeId?:string,promoterTypeDs?:string,site?:Site,crmEnabled?:boolean,canBeExtended?:boolean,canBeRetriggered?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Article[]} */
    article;
    /** @type {string} */
    warrantyId;
    /** @type {string} */
    createdBy;
    /** @type {string} */
    createdAt;
    /** @type {string} */
    issuedBy;
    /** @type {string} */
    selloutId;
    /** @type {string} */
    activationDate;
    /** @type {string} */
    pin;
    /** @type {string} */
    promoterTypeId;
    /** @type {string} */
    promoterTypeDs;
    /** @type {Site} */
    site;
    /** @type {boolean} */
    crmEnabled;
    /** @type {boolean} */
    canBeExtended;
    /** @type {boolean} */
    canBeRetriggered;
}
export class RetrieveWarrantyCardResponse extends BaseResponse {
    /** @param {{warranty?:Warranty,_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 {Warranty} */
    warranty;
}
export class RetrieveWarrantyCardRequest extends BaseRequest {
    /** @param {{cardId?:string,sid?:string,app?:string,_os?:string,_appVersion?:string,_searchMethod?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    cardId;
}

JavaScript RetrieveWarrantyCardRequest 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/card/{cardId} HTTP/1.1 
Host: qp-microservices-booster.richemont.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	warranty: 
	{
		article: 
		[
			{
				ref: String,
				serial: String,
				name: String,
				shortDesc: String,
				brand: String,
				warrantyStatusId: 0,
				warrantyStatusDesc: String,
				warrantyStatusCode: String,
				isConsignment: False
			}
		],
		warrantyId: String,
		createdBy: String,
		createdAt: String,
		issuedBy: String,
		selloutId: String,
		activationDate: String,
		pin: String,
		promoterTypeId: String,
		promoterTypeDs: String,
		site: 
		{
			object: String,
			id: String,
			name: String,
			address: 
			{
				line1: String,
				line2: String,
				city: String,
				zipCode: String,
				countryCode: String
			},
			crmPrivacyPolicyMandatory: False,
			crmAllowStoreDataAbroadVisible: False,
			isTimeVallee: False,
			crmPrivacyPolicyTimeValleeMandatory: False,
			crmAllowStoreDataAbroadTimeValleeVisible: False,
			allowToCreateEndCustomerOutsideChina: False,
			displayFirstLastNameNotLatin: False,
			languageTransliteration: String,
			doNotDisplayPOSDataInDisclaimers: False,
			crmFirstNameMandatory: False,
			crmCityMandatory: False,
			manageOwnStock: False
		},
		crmEnabled: False,
		canBeExtended: False,
		canBeRetriggered: False
	},
	_xmlns: String,
	_type: String,
	_source: String,
	_tstamp: String,
	_user: String,
	_env: String,
	_uri: String,
	_query: String
}