Booster.Microservices

<back to all web services

ValidatePostalAddress

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

public class ValidatePostalAddress : BaseRequest<ValidatePostalAddressResponse>
{
    public var zipCode:String
    public var region:String
    public var city:String
    public var street:String
    public var houseNumber:String
    public var countryId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case zipCode
        case region
        case city
        case street
        case houseNumber
        case countryId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        zipCode = try container.decodeIfPresent(String.self, forKey: .zipCode)
        region = try container.decodeIfPresent(String.self, forKey: .region)
        city = try container.decodeIfPresent(String.self, forKey: .city)
        street = try container.decodeIfPresent(String.self, forKey: .street)
        houseNumber = try container.decodeIfPresent(String.self, forKey: .houseNumber)
        countryId = try container.decodeIfPresent(String.self, forKey: .countryId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if zipCode != nil { try container.encode(zipCode, forKey: .zipCode) }
        if region != nil { try container.encode(region, forKey: .region) }
        if city != nil { try container.encode(city, forKey: .city) }
        if street != nil { try container.encode(street, forKey: .street) }
        if houseNumber != nil { try container.encode(houseNumber, forKey: .houseNumber) }
        if countryId != nil { try container.encode(countryId, forKey: .countryId) }
    }
}

public class BaseRequest<TResponse : Codable> : IRequest, Codable
{
    public var sid:String
    public var app:String
    public var _os:String
    public var _appVersion:String
    public var _searchMethod:String

    required public init(){}
}

public class ValidatePostalAddressResponse : BaseResponse
{
    public var responseStatus:ResponseStatus
    public var status:status
    public var suggestion:suggestion

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case responseStatus
        case status
        case suggestion
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
        status = try container.decodeIfPresent(status.self, forKey: .status)
        suggestion = try container.decodeIfPresent(suggestion.self, forKey: .suggestion)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
        if status != nil { try container.encode(status, forKey: .status) }
        if suggestion != nil { try container.encode(suggestion, forKey: .suggestion) }
    }
}

public class BaseResponse : IRespose, Codable
{
    public var _xmlns:String
    public var _type:String
    public var _source:String
    public var _tstamp:String
    public var _user:String
    public var _env:String
    public var _uri:String
    public var _query:String

    required public init(){}
}

public class status : Codable
{
    public var errorCode:String
    public var validationStatusCode:String
    public var statusId:Int
    public var errorDescription:String
    public var statusDescription:String

    required public init(){}
}

public class suggestion : Codable
{
    public var zipCode:String
    public var regionId:String
    public var regionDescription:String
    public var city:String
    public var street:String
    public var houseNumber:String
    public var countryId:String
    public var countryDescription:String

    required public init(){}
}


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