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
AddressRequest Parameters:
NameParameterData TypeRequiredDescription
TextbodystringYesThe Text is address code.
ContainerbodystringYesThe Container is address Id.
TypebodystringYesThe Type is type of addresss.
CSRbodystringNoThe Csr of the application (if available).
SourceCodebodystringYesThe SourceCode of the Adderess.
AdderessResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessfulformboolNoContains response status, details and errors.
CsrformstringNoThe Csr of the application (if available).
RetrieveResultformIEnumerable<Capture_Interactive_Retrieve_v1_00_Results>NoContains the Adderess lookup Retrieve result when successful.
FindResultsformIEnumerable<Capture_Interactive_Find_v1_00_Results>NoContains the Adderess lookup Find result when successful.
Capture_Interactive_Retrieve_v1_00_Results Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DomesticIdformstringNo
LanguageformstringNo
LanguageAlternativesformstringNo
DepartmentformstringNo
CompanyformstringNo
SubBuildingformstringNo
BuildingNumberformstringNo
BuildingNameformstringNo
SecondaryStreetformstringNo
StreetformstringNo
BlockformstringNo
NeighbourhoodformstringNo
DistrictformstringNo
CityformstringNo
Line1formstringNo
Line2formstringNo
Line3formstringNo
Line4formstringNo
Line5formstringNo
AdminAreaNameformstringNo
AdminAreaCodeformstringNo
ProvinceformstringNo
ProvinceNameformstringNo
ProvinceCodeformstringNo
PostalCodeformstringNo
CountryNameformstringNo
CountryIso2formstringNo
CountryIso3formstringNo
CountryIsoNumberformintNo
SortingNumber1formstringNo
SortingNumber2formstringNo
BarcodeformstringNo
POBoxNumberformstringNo
LabelformstringNo
TypeformstringNo
DataLevelformstringNo
Field1formstringNo
Field2formstringNo
Field3formstringNo
Field4formstringNo
Field5formstringNo
Field6formstringNo
Field7formstringNo
Field8formstringNo
Field9formstringNo
Field10formstringNo
Field11formstringNo
Field12formstringNo
Field13formstringNo
Field14formstringNo
Field15formstringNo
Field16formstringNo
Field17formstringNo
Field18formstringNo
Field19formstringNo
Field20formstringNo
Capture_Interactive_Find_v1_00_Results Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TypeformstringNo
TextformstringNo
HighlightformstringNo
DescriptionformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"Text":"String","Container":"String","Type":"String","CSR":"String","SourceCode":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Successful":false,"Csr":"String"}