CDD Engine Web Service v2.14.0.0

<back to all web services

AddressRequest

iNASA
Requires Authentication
The following routes are available for this service:
GET, POST/Address
import Foundation
import ServiceStack

public class AddressRequest : Codable
{
    /**
    * The Text is address code.
    */
    // @Required()
    public var text:String?

    /**
    * The Container is address Id.
    */
    // @Required()
    public var container:String?

    /**
    * The Type is type of addresss.
    */
    // @Required()
    public var type:String?

    /**
    * The Csr of the application (if available).
    */
    public var csr:String?
    /**
    * The SourceCode of the Adderess.
    */
    public var sourceCode:String?

    required public init(){}
}

public class AdderessResponse : Codable
{
    /**
    * Contains response status, details and errors.
    */
    public var successful:Bool?
    /**
    * The Csr of the application (if available).
    */
    public var csr:String?
    /**
    * Contains the Adderess lookup Retrieve result when successful.
    */
    public var retrieveResult:[Capture_Interactive_Retrieve_v1_00_Results] = []
    /**
    * Contains the Adderess lookup Find result when successful.
    */
    public var findResults:[Capture_Interactive_Find_v1_00_Results] = []

    required public init(){}
}

// @DataContract(Name="Capture_Interactive_Retrieve_v1_00_Results", Namespace="http://services.postcodeanywhere.co.uk/")
public class Capture_Interactive_Retrieve_v1_00_Results : Codable
{
    // @DataMember(EmitDefaultValue=false)
    public var id:String?

    // @DataMember(Order=1, EmitDefaultValue=false)
    public var domesticId:String?

    // @DataMember(Order=2, EmitDefaultValue=false)
    public var language:String?

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var languageAlternatives:String?

    // @DataMember(Order=4, EmitDefaultValue=false)
    public var department:String?

    // @DataMember(Order=5, EmitDefaultValue=false)
    public var company:String?

    // @DataMember(Order=6, EmitDefaultValue=false)
    public var subBuilding:String?

    // @DataMember(Order=7, EmitDefaultValue=false)
    public var buildingNumber:String?

    // @DataMember(Order=8, EmitDefaultValue=false)
    public var buildingName:String?

    // @DataMember(Order=9, EmitDefaultValue=false)
    public var secondaryStreet:String?

    // @DataMember(Order=10, EmitDefaultValue=false)
    public var street:String?

    // @DataMember(Order=11, EmitDefaultValue=false)
    public var block:String?

    // @DataMember(Order=12, EmitDefaultValue=false)
    public var neighbourhood:String?

    // @DataMember(Order=13, EmitDefaultValue=false)
    public var district:String?

    // @DataMember(Order=14, EmitDefaultValue=false)
    public var city:String?

    // @DataMember(Order=15, EmitDefaultValue=false)
    public var line1:String?

    // @DataMember(Order=16, EmitDefaultValue=false)
    public var line2:String?

    // @DataMember(Order=17, EmitDefaultValue=false)
    public var line3:String?

    // @DataMember(Order=18, EmitDefaultValue=false)
    public var line4:String?

    // @DataMember(Order=19, EmitDefaultValue=false)
    public var line5:String?

    // @DataMember(Order=20, EmitDefaultValue=false)
    public var adminAreaName:String?

    // @DataMember(Order=21, EmitDefaultValue=false)
    public var adminAreaCode:String?

    // @DataMember(Order=22, EmitDefaultValue=false)
    public var province:String?

    // @DataMember(Order=23, EmitDefaultValue=false)
    public var provinceName:String?

    // @DataMember(Order=24, EmitDefaultValue=false)
    public var provinceCode:String?

    // @DataMember(Order=25, EmitDefaultValue=false)
    public var postalCode:String?

    // @DataMember(Order=26, EmitDefaultValue=false)
    public var countryName:String?

    // @DataMember(Order=27, EmitDefaultValue=false)
    public var countryIso2:String?

    // @DataMember(Order=28, EmitDefaultValue=false)
    public var countryIso3:String?

    // @DataMember(Order=29, IsRequired=true)
    public var countryIsoNumber:Int?

    // @DataMember(Order=30, EmitDefaultValue=false)
    public var sortingNumber1:String?

    // @DataMember(Order=31, EmitDefaultValue=false)
    public var sortingNumber2:String?

    // @DataMember(Order=32, EmitDefaultValue=false)
    public var barcode:String?

    // @DataMember(Order=33, EmitDefaultValue=false)
    public var poBoxNumber:String?

    // @DataMember(Order=34, EmitDefaultValue=false)
    public var label:String?

    // @DataMember(Order=35, EmitDefaultValue=false)
    public var type:String?

    // @DataMember(Order=36, EmitDefaultValue=false)
    public var dataLevel:String?

    // @DataMember(Order=37, EmitDefaultValue=false)
    public var field1:String?

    // @DataMember(Order=38, EmitDefaultValue=false)
    public var field2:String?

    // @DataMember(Order=39, EmitDefaultValue=false)
    public var field3:String?

    // @DataMember(Order=40, EmitDefaultValue=false)
    public var field4:String?

    // @DataMember(Order=41, EmitDefaultValue=false)
    public var field5:String?

    // @DataMember(Order=42, EmitDefaultValue=false)
    public var field6:String?

    // @DataMember(Order=43, EmitDefaultValue=false)
    public var field7:String?

    // @DataMember(Order=44, EmitDefaultValue=false)
    public var field8:String?

    // @DataMember(Order=45, EmitDefaultValue=false)
    public var field9:String?

    // @DataMember(Order=46, EmitDefaultValue=false)
    public var field10:String?

    // @DataMember(Order=47, EmitDefaultValue=false)
    public var field11:String?

    // @DataMember(Order=48, EmitDefaultValue=false)
    public var field12:String?

    // @DataMember(Order=49, EmitDefaultValue=false)
    public var field13:String?

    // @DataMember(Order=50, EmitDefaultValue=false)
    public var field14:String?

    // @DataMember(Order=51, EmitDefaultValue=false)
    public var field15:String?

    // @DataMember(Order=52, EmitDefaultValue=false)
    public var field16:String?

    // @DataMember(Order=53, EmitDefaultValue=false)
    public var field17:String?

    // @DataMember(Order=54, EmitDefaultValue=false)
    public var field18:String?

    // @DataMember(Order=55, EmitDefaultValue=false)
    public var field19:String?

    // @DataMember(Order=56, EmitDefaultValue=false)
    public var field20:String?

    required public init(){}
}

// @DataContract(Name="Capture_Interactive_Find_v1_00_Results", Namespace="http://services.postcodeanywhere.co.uk/")
public class Capture_Interactive_Find_v1_00_Results : Codable
{
    // @DataMember(EmitDefaultValue=false)
    public var id:String?

    // @DataMember(EmitDefaultValue=false)
    public var type:String?

    // @DataMember(Order=2, EmitDefaultValue=false)
    public var text:String?

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var highlight:String?

    // @DataMember(Order=4, EmitDefaultValue=false)
    public var Description:String?

    required public init(){}
}

Swift AddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Address HTTP/1.1 
Host: wp-cddws-test.worldpay.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Text: String,
	Container: String,
	Type: String,
	CSR: String,
	SourceCode: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Successful: False,
	Csr: String
}