Booster.Microservices

<back to all web services

ValidatePostalAddress

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/ValidatePostalAddress
"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 status {
    /** @param {{errorCode?:string,validationStatusCode?:string,statusId?:number,errorDescription?:string,statusDescription?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    validationStatusCode;
    /** @type {number} */
    statusId;
    /** @type {string} */
    errorDescription;
    /** @type {string} */
    statusDescription;
}
export class suggestion {
    /** @param {{zipCode?:string,regionId?:string,regionDescription?:string,city?:string,street?:string,houseNumber?:string,countryId?:string,countryDescription?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    zipCode;
    /** @type {string} */
    regionId;
    /** @type {string} */
    regionDescription;
    /** @type {string} */
    city;
    /** @type {string} */
    street;
    /** @type {string} */
    houseNumber;
    /** @type {string} */
    countryId;
    /** @type {string} */
    countryDescription;
}
export class ValidatePostalAddressResponse extends BaseResponse {
    /** @param {{ResponseStatus?:ResponseStatus,status?:status,suggestion?:suggestion,_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 {ResponseStatus} */
    ResponseStatus;
    /** @type {status} */
    status;
    /** @type {suggestion} */
    suggestion;
}
export class ValidatePostalAddress extends BaseRequest {
    /** @param {{zipCode?:string,region?:string,city?:string,street?:string,houseNumber?:string,countryId?:string,sid?:string,app?:string,_os?:string,_appVersion?:string,_searchMethod?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    zipCode;
    /** @type {string} */
    region;
    /** @type {string} */
    city;
    /** @type {string} */
    street;
    /** @type {string} */
    houseNumber;
    /** @type {string} */
    countryId;
}

JavaScript ValidatePostalAddress DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /warranty/v1/ValidatePostalAddress HTTP/1.1 
Host: qp-microservices-booster.richemont.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"zipCode":"String","region":"String","city":"String","street":"String","houseNumber":"String","countryId":"String","sid":"String","app":"String","_os":"String","_appVersion":"String","_searchMethod":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"status":{"errorCode":"String","validationStatusCode":"String","statusId":0,"errorDescription":"String","statusDescription":"String"},"suggestion":{"zipCode":"String","regionId":"String","regionDescription":"String","city":"String","street":"String","houseNumber":"String","countryId":"String","countryDescription":"String"},"_xmlns":"String","_type":"String","_source":"String","_tstamp":"String","_user":"String","_env":"String","_uri":"String","_query":"String"}