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.*;

public class dtos
{

    public static class AddressRequest
    {
        /**
        * The Text is address code.
        */
        @Required()
        public String Text = null;

        /**
        * The Container is address Id.
        */
        @Required()
        public String Container = null;

        /**
        * The Type is type of addresss.
        */
        @Required()
        public String Type = null;

        /**
        * The Csr of the application (if available).
        */
        public String CSR = null;
        /**
        * The SourceCode of the Adderess.
        */
        public String SourceCode = null;
        
        public String getText() { return Text; }
        public AddressRequest setText(String value) { this.Text = value; return this; }
        public String getContainer() { return Container; }
        public AddressRequest setContainer(String value) { this.Container = value; return this; }
        public String getType() { return Type; }
        public AddressRequest setType(String value) { this.Type = value; return this; }
        public String getCsr() { return CSR; }
        public AddressRequest setCsr(String value) { this.CSR = value; return this; }
        public String getSourceCode() { return SourceCode; }
        public AddressRequest setSourceCode(String value) { this.SourceCode = value; return this; }
    }

    public static class AdderessResponse
    {
        /**
        * Contains response status, details and errors.
        */
        public Boolean Successful = null;
        /**
        * The Csr of the application (if available).
        */
        public String Csr = null;
        /**
        * Contains the Adderess lookup Retrieve result when successful.
        */
        public ArrayList<Capture_Interactive_Retrieve_v1_00_Results> RetrieveResult = null;
        /**
        * Contains the Adderess lookup Find result when successful.
        */
        public ArrayList<Capture_Interactive_Find_v1_00_Results> FindResults = null;
        
        public Boolean isSuccessful() { return Successful; }
        public AdderessResponse setSuccessful(Boolean value) { this.Successful = value; return this; }
        public String getCsr() { return Csr; }
        public AdderessResponse setCsr(String value) { this.Csr = value; return this; }
        public ArrayList<Capture_Interactive_Retrieve_v1_00_Results> getRetrieveResult() { return RetrieveResult; }
        public AdderessResponse setRetrieveResult(ArrayList<Capture_Interactive_Retrieve_v1_00_Results> value) { this.RetrieveResult = value; return this; }
        public ArrayList<Capture_Interactive_Find_v1_00_Results> getFindResults() { return FindResults; }
        public AdderessResponse setFindResults(ArrayList<Capture_Interactive_Find_v1_00_Results> value) { this.FindResults = value; return this; }
    }

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

        @DataMember(Order=1, EmitDefaultValue=false)
        public String DomesticId = null;

        @DataMember(Order=2, EmitDefaultValue=false)
        public String Language = null;

        @DataMember(Order=3, EmitDefaultValue=false)
        public String LanguageAlternatives = null;

        @DataMember(Order=4, EmitDefaultValue=false)
        public String Department = null;

        @DataMember(Order=5, EmitDefaultValue=false)
        public String Company = null;

        @DataMember(Order=6, EmitDefaultValue=false)
        public String SubBuilding = null;

        @DataMember(Order=7, EmitDefaultValue=false)
        public String BuildingNumber = null;

        @DataMember(Order=8, EmitDefaultValue=false)
        public String BuildingName = null;

        @DataMember(Order=9, EmitDefaultValue=false)
        public String SecondaryStreet = null;

        @DataMember(Order=10, EmitDefaultValue=false)
        public String Street = null;

        @DataMember(Order=11, EmitDefaultValue=false)
        public String Block = null;

        @DataMember(Order=12, EmitDefaultValue=false)
        public String Neighbourhood = null;

        @DataMember(Order=13, EmitDefaultValue=false)
        public String District = null;

        @DataMember(Order=14, EmitDefaultValue=false)
        public String City = null;

        @DataMember(Order=15, EmitDefaultValue=false)
        public String Line1 = null;

        @DataMember(Order=16, EmitDefaultValue=false)
        public String Line2 = null;

        @DataMember(Order=17, EmitDefaultValue=false)
        public String Line3 = null;

        @DataMember(Order=18, EmitDefaultValue=false)
        public String Line4 = null;

        @DataMember(Order=19, EmitDefaultValue=false)
        public String Line5 = null;

        @DataMember(Order=20, EmitDefaultValue=false)
        public String AdminAreaName = null;

        @DataMember(Order=21, EmitDefaultValue=false)
        public String AdminAreaCode = null;

        @DataMember(Order=22, EmitDefaultValue=false)
        public String Province = null;

        @DataMember(Order=23, EmitDefaultValue=false)
        public String ProvinceName = null;

        @DataMember(Order=24, EmitDefaultValue=false)
        public String ProvinceCode = null;

        @DataMember(Order=25, EmitDefaultValue=false)
        public String PostalCode = null;

        @DataMember(Order=26, EmitDefaultValue=false)
        public String CountryName = null;

        @DataMember(Order=27, EmitDefaultValue=false)
        public String CountryIso2 = null;

        @DataMember(Order=28, EmitDefaultValue=false)
        public String CountryIso3 = null;

        @DataMember(Order=29, IsRequired=true)
        public Integer CountryIsoNumber = null;

        @DataMember(Order=30, EmitDefaultValue=false)
        public String SortingNumber1 = null;

        @DataMember(Order=31, EmitDefaultValue=false)
        public String SortingNumber2 = null;

        @DataMember(Order=32, EmitDefaultValue=false)
        public String Barcode = null;

        @DataMember(Order=33, EmitDefaultValue=false)
        public String POBoxNumber = null;

        @DataMember(Order=34, EmitDefaultValue=false)
        public String Label = null;

        @DataMember(Order=35, EmitDefaultValue=false)
        public String Type = null;

        @DataMember(Order=36, EmitDefaultValue=false)
        public String DataLevel = null;

        @DataMember(Order=37, EmitDefaultValue=false)
        public String Field1 = null;

        @DataMember(Order=38, EmitDefaultValue=false)
        public String Field2 = null;

        @DataMember(Order=39, EmitDefaultValue=false)
        public String Field3 = null;

        @DataMember(Order=40, EmitDefaultValue=false)
        public String Field4 = null;

        @DataMember(Order=41, EmitDefaultValue=false)
        public String Field5 = null;

        @DataMember(Order=42, EmitDefaultValue=false)
        public String Field6 = null;

        @DataMember(Order=43, EmitDefaultValue=false)
        public String Field7 = null;

        @DataMember(Order=44, EmitDefaultValue=false)
        public String Field8 = null;

        @DataMember(Order=45, EmitDefaultValue=false)
        public String Field9 = null;

        @DataMember(Order=46, EmitDefaultValue=false)
        public String Field10 = null;

        @DataMember(Order=47, EmitDefaultValue=false)
        public String Field11 = null;

        @DataMember(Order=48, EmitDefaultValue=false)
        public String Field12 = null;

        @DataMember(Order=49, EmitDefaultValue=false)
        public String Field13 = null;

        @DataMember(Order=50, EmitDefaultValue=false)
        public String Field14 = null;

        @DataMember(Order=51, EmitDefaultValue=false)
        public String Field15 = null;

        @DataMember(Order=52, EmitDefaultValue=false)
        public String Field16 = null;

        @DataMember(Order=53, EmitDefaultValue=false)
        public String Field17 = null;

        @DataMember(Order=54, EmitDefaultValue=false)
        public String Field18 = null;

        @DataMember(Order=55, EmitDefaultValue=false)
        public String Field19 = null;

        @DataMember(Order=56, EmitDefaultValue=false)
        public String Field20 = null;
        
        public String getId() { return Id; }
        public Capture_Interactive_Retrieve_v1_00_Results setId(String value) { this.Id = value; return this; }
        public String getDomesticId() { return DomesticId; }
        public Capture_Interactive_Retrieve_v1_00_Results setDomesticId(String value) { this.DomesticId = value; return this; }
        public String getLanguage() { return Language; }
        public Capture_Interactive_Retrieve_v1_00_Results setLanguage(String value) { this.Language = value; return this; }
        public String getLanguageAlternatives() { return LanguageAlternatives; }
        public Capture_Interactive_Retrieve_v1_00_Results setLanguageAlternatives(String value) { this.LanguageAlternatives = value; return this; }
        public String getDepartment() { return Department; }
        public Capture_Interactive_Retrieve_v1_00_Results setDepartment(String value) { this.Department = value; return this; }
        public String getCompany() { return Company; }
        public Capture_Interactive_Retrieve_v1_00_Results setCompany(String value) { this.Company = value; return this; }
        public String getSubBuilding() { return SubBuilding; }
        public Capture_Interactive_Retrieve_v1_00_Results setSubBuilding(String value) { this.SubBuilding = value; return this; }
        public String getBuildingNumber() { return BuildingNumber; }
        public Capture_Interactive_Retrieve_v1_00_Results setBuildingNumber(String value) { this.BuildingNumber = value; return this; }
        public String getBuildingName() { return BuildingName; }
        public Capture_Interactive_Retrieve_v1_00_Results setBuildingName(String value) { this.BuildingName = value; return this; }
        public String getSecondaryStreet() { return SecondaryStreet; }
        public Capture_Interactive_Retrieve_v1_00_Results setSecondaryStreet(String value) { this.SecondaryStreet = value; return this; }
        public String getStreet() { return Street; }
        public Capture_Interactive_Retrieve_v1_00_Results setStreet(String value) { this.Street = value; return this; }
        public String getBlock() { return Block; }
        public Capture_Interactive_Retrieve_v1_00_Results setBlock(String value) { this.Block = value; return this; }
        public String getNeighbourhood() { return Neighbourhood; }
        public Capture_Interactive_Retrieve_v1_00_Results setNeighbourhood(String value) { this.Neighbourhood = value; return this; }
        public String getDistrict() { return District; }
        public Capture_Interactive_Retrieve_v1_00_Results setDistrict(String value) { this.District = value; return this; }
        public String getCity() { return City; }
        public Capture_Interactive_Retrieve_v1_00_Results setCity(String value) { this.City = value; return this; }
        public String getLine1() { return Line1; }
        public Capture_Interactive_Retrieve_v1_00_Results setLine1(String value) { this.Line1 = value; return this; }
        public String getLine2() { return Line2; }
        public Capture_Interactive_Retrieve_v1_00_Results setLine2(String value) { this.Line2 = value; return this; }
        public String getLine3() { return Line3; }
        public Capture_Interactive_Retrieve_v1_00_Results setLine3(String value) { this.Line3 = value; return this; }
        public String getLine4() { return Line4; }
        public Capture_Interactive_Retrieve_v1_00_Results setLine4(String value) { this.Line4 = value; return this; }
        public String getLine5() { return Line5; }
        public Capture_Interactive_Retrieve_v1_00_Results setLine5(String value) { this.Line5 = value; return this; }
        public String getAdminAreaName() { return AdminAreaName; }
        public Capture_Interactive_Retrieve_v1_00_Results setAdminAreaName(String value) { this.AdminAreaName = value; return this; }
        public String getAdminAreaCode() { return AdminAreaCode; }
        public Capture_Interactive_Retrieve_v1_00_Results setAdminAreaCode(String value) { this.AdminAreaCode = value; return this; }
        public String getProvince() { return Province; }
        public Capture_Interactive_Retrieve_v1_00_Results setProvince(String value) { this.Province = value; return this; }
        public String getProvinceName() { return ProvinceName; }
        public Capture_Interactive_Retrieve_v1_00_Results setProvinceName(String value) { this.ProvinceName = value; return this; }
        public String getProvinceCode() { return ProvinceCode; }
        public Capture_Interactive_Retrieve_v1_00_Results setProvinceCode(String value) { this.ProvinceCode = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public Capture_Interactive_Retrieve_v1_00_Results setPostalCode(String value) { this.PostalCode = value; return this; }
        public String getCountryName() { return CountryName; }
        public Capture_Interactive_Retrieve_v1_00_Results setCountryName(String value) { this.CountryName = value; return this; }
        public String getCountryIso2() { return CountryIso2; }
        public Capture_Interactive_Retrieve_v1_00_Results setCountryIso2(String value) { this.CountryIso2 = value; return this; }
        public String getCountryIso3() { return CountryIso3; }
        public Capture_Interactive_Retrieve_v1_00_Results setCountryIso3(String value) { this.CountryIso3 = value; return this; }
        public Integer getCountryIsoNumber() { return CountryIsoNumber; }
        public Capture_Interactive_Retrieve_v1_00_Results setCountryIsoNumber(Integer value) { this.CountryIsoNumber = value; return this; }
        public String getSortingNumber1() { return SortingNumber1; }
        public Capture_Interactive_Retrieve_v1_00_Results setSortingNumber1(String value) { this.SortingNumber1 = value; return this; }
        public String getSortingNumber2() { return SortingNumber2; }
        public Capture_Interactive_Retrieve_v1_00_Results setSortingNumber2(String value) { this.SortingNumber2 = value; return this; }
        public String getBarcode() { return Barcode; }
        public Capture_Interactive_Retrieve_v1_00_Results setBarcode(String value) { this.Barcode = value; return this; }
        public String getPoBoxNumber() { return POBoxNumber; }
        public Capture_Interactive_Retrieve_v1_00_Results setPoBoxNumber(String value) { this.POBoxNumber = value; return this; }
        public String getLabel() { return Label; }
        public Capture_Interactive_Retrieve_v1_00_Results setLabel(String value) { this.Label = value; return this; }
        public String getType() { return Type; }
        public Capture_Interactive_Retrieve_v1_00_Results setType(String value) { this.Type = value; return this; }
        public String getDataLevel() { return DataLevel; }
        public Capture_Interactive_Retrieve_v1_00_Results setDataLevel(String value) { this.DataLevel = value; return this; }
        public String getField1() { return Field1; }
        public Capture_Interactive_Retrieve_v1_00_Results setField1(String value) { this.Field1 = value; return this; }
        public String getField2() { return Field2; }
        public Capture_Interactive_Retrieve_v1_00_Results setField2(String value) { this.Field2 = value; return this; }
        public String getField3() { return Field3; }
        public Capture_Interactive_Retrieve_v1_00_Results setField3(String value) { this.Field3 = value; return this; }
        public String getField4() { return Field4; }
        public Capture_Interactive_Retrieve_v1_00_Results setField4(String value) { this.Field4 = value; return this; }
        public String getField5() { return Field5; }
        public Capture_Interactive_Retrieve_v1_00_Results setField5(String value) { this.Field5 = value; return this; }
        public String getField6() { return Field6; }
        public Capture_Interactive_Retrieve_v1_00_Results setField6(String value) { this.Field6 = value; return this; }
        public String getField7() { return Field7; }
        public Capture_Interactive_Retrieve_v1_00_Results setField7(String value) { this.Field7 = value; return this; }
        public String getField8() { return Field8; }
        public Capture_Interactive_Retrieve_v1_00_Results setField8(String value) { this.Field8 = value; return this; }
        public String getField9() { return Field9; }
        public Capture_Interactive_Retrieve_v1_00_Results setField9(String value) { this.Field9 = value; return this; }
        public String getField10() { return Field10; }
        public Capture_Interactive_Retrieve_v1_00_Results setField10(String value) { this.Field10 = value; return this; }
        public String getField11() { return Field11; }
        public Capture_Interactive_Retrieve_v1_00_Results setField11(String value) { this.Field11 = value; return this; }
        public String getField12() { return Field12; }
        public Capture_Interactive_Retrieve_v1_00_Results setField12(String value) { this.Field12 = value; return this; }
        public String getField13() { return Field13; }
        public Capture_Interactive_Retrieve_v1_00_Results setField13(String value) { this.Field13 = value; return this; }
        public String getField14() { return Field14; }
        public Capture_Interactive_Retrieve_v1_00_Results setField14(String value) { this.Field14 = value; return this; }
        public String getField15() { return Field15; }
        public Capture_Interactive_Retrieve_v1_00_Results setField15(String value) { this.Field15 = value; return this; }
        public String getField16() { return Field16; }
        public Capture_Interactive_Retrieve_v1_00_Results setField16(String value) { this.Field16 = value; return this; }
        public String getField17() { return Field17; }
        public Capture_Interactive_Retrieve_v1_00_Results setField17(String value) { this.Field17 = value; return this; }
        public String getField18() { return Field18; }
        public Capture_Interactive_Retrieve_v1_00_Results setField18(String value) { this.Field18 = value; return this; }
        public String getField19() { return Field19; }
        public Capture_Interactive_Retrieve_v1_00_Results setField19(String value) { this.Field19 = value; return this; }
        public String getField20() { return Field20; }
        public Capture_Interactive_Retrieve_v1_00_Results setField20(String value) { this.Field20 = value; return this; }
    }

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

        @DataMember(EmitDefaultValue=false)
        public String Type = null;

        @DataMember(Order=2, EmitDefaultValue=false)
        public String Text = null;

        @DataMember(Order=3, EmitDefaultValue=false)
        public String Highlight = null;

        @DataMember(Order=4, EmitDefaultValue=false)
        public String Description = null;
        
        public String getId() { return Id; }
        public Capture_Interactive_Find_v1_00_Results setId(String value) { this.Id = value; return this; }
        public String getType() { return Type; }
        public Capture_Interactive_Find_v1_00_Results setType(String value) { this.Type = value; return this; }
        public String getText() { return Text; }
        public Capture_Interactive_Find_v1_00_Results setText(String value) { this.Text = value; return this; }
        public String getHighlight() { return Highlight; }
        public Capture_Interactive_Find_v1_00_Results setHighlight(String value) { this.Highlight = value; return this; }
        public String getDescription() { return Description; }
        public Capture_Interactive_Find_v1_00_Results setDescription(String value) { this.Description = value; return this; }
    }

}

Java AddressRequest 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 /Address HTTP/1.1 
Host: wpcdd-featuretest-ws.worldpay.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Requests">
  <CSR>String</CSR>
  <Container>String</Container>
  <SourceCode>String</SourceCode>
  <Text>String</Text>
  <Type>String</Type>
</AddressRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AdderessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Responses">
  <Csr>String</Csr>
  <FindResults xmlns:d2p1="http://services.postcodeanywhere.co.uk/" i:nil="true" />
  <RetrieveResult xmlns:d2p1="http://services.postcodeanywhere.co.uk/" i:nil="true" />
  <Successful>false</Successful>
</AdderessResponse>