Booster.Microservices

<back to all web services

ValidatePostalAddress

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/ValidatePostalAddress
namespace Booster.Microservices.ServiceModel.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BaseResponse() = 
        member val _xmlns:String = null with get,set
        member val _type:String = null with get,set
        member val _source:String = null with get,set
        member val _tstamp:String = null with get,set
        member val _user:String = null with get,set
        member val _env:String = null with get,set
        member val _uri:String = null with get,set
        member val _query:String = null with get,set

    [<AllowNullLiteral>]
    type status() = 
        member val errorCode:String = null with get,set
        member val validationStatusCode:String = null with get,set
        member val statusId:Int32 = new Int32() with get,set
        member val errorDescription:String = null with get,set
        member val statusDescription:String = null with get,set

    [<AllowNullLiteral>]
    type suggestion() = 
        member val zipCode:String = null with get,set
        member val regionId:String = null with get,set
        member val regionDescription:String = null with get,set
        member val city:String = null with get,set
        member val street:String = null with get,set
        member val houseNumber:String = null with get,set
        member val countryId:String = null with get,set
        member val countryDescription:String = null with get,set

    [<AllowNullLiteral>]
    type ValidatePostalAddressResponse() = 
        inherit BaseResponse()
        member val ResponseStatus:ResponseStatus = null with get,set
        member val status:status = null with get,set
        member val suggestion:suggestion = null with get,set

    [<AllowNullLiteral>]
    type ValidatePostalAddress() = 
        inherit BaseRequest<ValidatePostalAddressResponse>()
        member val zipCode:String = null with get,set
        member val region:String = null with get,set
        member val city:String = null with get,set
        member val street:String = null with get,set
        member val houseNumber:String = null with get,set
        member val countryId:String = null with get,set

    [<AllowNullLiteral>]
    type BaseRequest<TResponse>() = 
        member val sid:String = null with get,set
        member val app:String = null with get,set
        member val _os:String = null with get,set
        member val _appVersion:String = null with get,set
        member val _searchMethod:String = null with get,set

F# 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>