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