Booster.Microservices

<back to all web services

ValidatePostalAddress

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/ValidatePostalAddress

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 status
{
    public errorCode: string;
    public validationStatusCode: string;
    public statusId: number;
    public errorDescription: string;
    public statusDescription: string;

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

export class suggestion
{
    public zipCode: string;
    public regionId: string;
    public regionDescription: string;
    public city: string;
    public street: string;
    public houseNumber: string;
    public countryId: string;
    public countryDescription: string;

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

export class ValidatePostalAddressResponse extends BaseResponse
{
    public ResponseStatus: ResponseStatus;
    public status: status;
    public suggestion: suggestion;

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

export class ValidatePostalAddress extends BaseRequest<ValidatePostalAddressResponse>
{
    public zipCode: string;
    public region: string;
    public city: string;
    public street: string;
    public houseNumber: string;
    public countryId: string;

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

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