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 java.math.*
import java.util.*
import net.servicestack.client.*


open class AddressRequest
{
    /**
    * The Text is address code.
    */
    @Required()
    var Text:String? = null

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

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

    /**
    * The Csr of the application (if available).
    */
    var CSR:String? = null
    /**
    * The SourceCode of the Adderess.
    */
    var SourceCode:String? = null
}

open class AdderessResponse
{
    /**
    * Contains response status, details and errors.
    */
    var Successful:Boolean? = null
    /**
    * The Csr of the application (if available).
    */
    var Csr:String? = null
    /**
    * Contains the Adderess lookup Retrieve result when successful.
    */
    var RetrieveResult:ArrayList<Capture_Interactive_Retrieve_v1_00_Results> = ArrayList<Capture_Interactive_Retrieve_v1_00_Results>()
    /**
    * Contains the Adderess lookup Find result when successful.
    */
    var FindResults:ArrayList<Capture_Interactive_Find_v1_00_Results> = ArrayList<Capture_Interactive_Find_v1_00_Results>()
}

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

    @DataMember(Order=1, EmitDefaultValue=false)
    var DomesticId:String? = null

    @DataMember(Order=2, EmitDefaultValue=false)
    var Language:String? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    var LanguageAlternatives:String? = null

    @DataMember(Order=4, EmitDefaultValue=false)
    var Department:String? = null

    @DataMember(Order=5, EmitDefaultValue=false)
    var Company:String? = null

    @DataMember(Order=6, EmitDefaultValue=false)
    var SubBuilding:String? = null

    @DataMember(Order=7, EmitDefaultValue=false)
    var BuildingNumber:String? = null

    @DataMember(Order=8, EmitDefaultValue=false)
    var BuildingName:String? = null

    @DataMember(Order=9, EmitDefaultValue=false)
    var SecondaryStreet:String? = null

    @DataMember(Order=10, EmitDefaultValue=false)
    var Street:String? = null

    @DataMember(Order=11, EmitDefaultValue=false)
    var Block:String? = null

    @DataMember(Order=12, EmitDefaultValue=false)
    var Neighbourhood:String? = null

    @DataMember(Order=13, EmitDefaultValue=false)
    var District:String? = null

    @DataMember(Order=14, EmitDefaultValue=false)
    var City:String? = null

    @DataMember(Order=15, EmitDefaultValue=false)
    var Line1:String? = null

    @DataMember(Order=16, EmitDefaultValue=false)
    var Line2:String? = null

    @DataMember(Order=17, EmitDefaultValue=false)
    var Line3:String? = null

    @DataMember(Order=18, EmitDefaultValue=false)
    var Line4:String? = null

    @DataMember(Order=19, EmitDefaultValue=false)
    var Line5:String? = null

    @DataMember(Order=20, EmitDefaultValue=false)
    var AdminAreaName:String? = null

    @DataMember(Order=21, EmitDefaultValue=false)
    var AdminAreaCode:String? = null

    @DataMember(Order=22, EmitDefaultValue=false)
    var Province:String? = null

    @DataMember(Order=23, EmitDefaultValue=false)
    var ProvinceName:String? = null

    @DataMember(Order=24, EmitDefaultValue=false)
    var ProvinceCode:String? = null

    @DataMember(Order=25, EmitDefaultValue=false)
    var PostalCode:String? = null

    @DataMember(Order=26, EmitDefaultValue=false)
    var CountryName:String? = null

    @DataMember(Order=27, EmitDefaultValue=false)
    var CountryIso2:String? = null

    @DataMember(Order=28, EmitDefaultValue=false)
    var CountryIso3:String? = null

    @DataMember(Order=29, IsRequired=true)
    var CountryIsoNumber:Int? = null

    @DataMember(Order=30, EmitDefaultValue=false)
    var SortingNumber1:String? = null

    @DataMember(Order=31, EmitDefaultValue=false)
    var SortingNumber2:String? = null

    @DataMember(Order=32, EmitDefaultValue=false)
    var Barcode:String? = null

    @DataMember(Order=33, EmitDefaultValue=false)
    var POBoxNumber:String? = null

    @DataMember(Order=34, EmitDefaultValue=false)
    var Label:String? = null

    @DataMember(Order=35, EmitDefaultValue=false)
    var Type:String? = null

    @DataMember(Order=36, EmitDefaultValue=false)
    var DataLevel:String? = null

    @DataMember(Order=37, EmitDefaultValue=false)
    var Field1:String? = null

    @DataMember(Order=38, EmitDefaultValue=false)
    var Field2:String? = null

    @DataMember(Order=39, EmitDefaultValue=false)
    var Field3:String? = null

    @DataMember(Order=40, EmitDefaultValue=false)
    var Field4:String? = null

    @DataMember(Order=41, EmitDefaultValue=false)
    var Field5:String? = null

    @DataMember(Order=42, EmitDefaultValue=false)
    var Field6:String? = null

    @DataMember(Order=43, EmitDefaultValue=false)
    var Field7:String? = null

    @DataMember(Order=44, EmitDefaultValue=false)
    var Field8:String? = null

    @DataMember(Order=45, EmitDefaultValue=false)
    var Field9:String? = null

    @DataMember(Order=46, EmitDefaultValue=false)
    var Field10:String? = null

    @DataMember(Order=47, EmitDefaultValue=false)
    var Field11:String? = null

    @DataMember(Order=48, EmitDefaultValue=false)
    var Field12:String? = null

    @DataMember(Order=49, EmitDefaultValue=false)
    var Field13:String? = null

    @DataMember(Order=50, EmitDefaultValue=false)
    var Field14:String? = null

    @DataMember(Order=51, EmitDefaultValue=false)
    var Field15:String? = null

    @DataMember(Order=52, EmitDefaultValue=false)
    var Field16:String? = null

    @DataMember(Order=53, EmitDefaultValue=false)
    var Field17:String? = null

    @DataMember(Order=54, EmitDefaultValue=false)
    var Field18:String? = null

    @DataMember(Order=55, EmitDefaultValue=false)
    var Field19:String? = null

    @DataMember(Order=56, EmitDefaultValue=false)
    var Field20:String? = null
}

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

    @DataMember(EmitDefaultValue=false)
    var Type:String? = null

    @DataMember(Order=2, EmitDefaultValue=false)
    var Text:String? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    var Highlight:String? = null

    @DataMember(Order=4, EmitDefaultValue=false)
    var Description:String? = null
}

Kotlin 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
}