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

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

<ValidatePostalAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Sale">
  <_appVersion xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_appVersion>
  <_os xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_os>
  <_searchMethod xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_searchMethod>
  <app xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</app>
  <sid xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</sid>
  <city>String</city>
  <countryId>String</countryId>
  <houseNumber>String</houseNumber>
  <region>String</region>
  <street>String</street>
  <zipCode>String</zipCode>
</ValidatePostalAddress>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ValidatePostalAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Sale">
  <_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>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <status>
    <errorCode>String</errorCode>
    <errorDescription>String</errorDescription>
    <statusDescription>String</statusDescription>
    <statusId>0</statusId>
    <validationStatusCode>String</validationStatusCode>
  </status>
  <suggestion>
    <city>String</city>
    <countryDescription>String</countryDescription>
    <countryId>String</countryId>
    <houseNumber>String</houseNumber>
    <regionDescription>String</regionDescription>
    <regionId>String</regionId>
    <street>String</street>
    <zipCode>String</zipCode>
  </suggestion>
</ValidatePostalAddressResponse>