CDD Engine Web Service v2.14.0.0

AddressRequest

iNASA

The following routes are available for this service:
GET, POST	/Address

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CDD_Engine_WS.dto.Requests
Imports CDD_Engine_WS.dto.Responses
Imports ThirdPartyServices_ClassLibraries.AddressLookup_RetrieveService
Imports ThirdPartyServices_ClassLibraries.AddressLookup_FindService

Namespace Global

    Namespace CDD_Engine_WS.dto.Requests

        Public Partial Class AddressRequest
            '''<Summary>
            '''The Text is address code.
            '''</Summary>
            <Required>
            Public Overridable Property Text As String

            '''<Summary>
            '''The Container is address Id.
            '''</Summary>
            <Required>
            Public Overridable Property Container As String

            '''<Summary>
            '''The Type is type of addresss.
            '''</Summary>
            <Required>
            Public Overridable Property Type As String

            '''<Summary>
            '''The Csr of the application (if available).
            '''</Summary>
            Public Overridable Property CSR As String
            '''<Summary>
            '''The SourceCode of the Adderess.
            '''</Summary>
            Public Overridable Property SourceCode As String
        End Class
    End Namespace

    Namespace CDD_Engine_WS.dto.Responses

        Public Partial Class AdderessResponse
            '''<Summary>
            '''Contains response status, details and errors.
            '''</Summary>
            Public Overridable Property Successful As Boolean
            '''<Summary>
            '''The Csr of the application (if available).
            '''</Summary>
            Public Overridable Property Csr As String
            '''<Summary>
            '''Contains the Adderess lookup Retrieve result when successful.
            '''</Summary>
            Public Overridable Property RetrieveResult As IEnumerable(Of Capture_Interactive_Retrieve_v1_00_Results)
            '''<Summary>
            '''Contains the Adderess lookup Find result when successful.
            '''</Summary>
            Public Overridable Property FindResults As IEnumerable(Of Capture_Interactive_Find_v1_00_Results)
        End Class
    End Namespace

    Namespace ThirdPartyServices_ClassLibraries.AddressLookup_FindService

        <DataContract(Name:="Capture_Interactive_Find_v1_00_Results", Namespace:="http://services.postcodeanywhere.co.uk/")>
        Public Partial Class Capture_Interactive_Find_v1_00_Results
            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property Id As String

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property Type As String

            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property Text As String

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property Highlight As String

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property Description As String
        End Class
    End Namespace

    Namespace ThirdPartyServices_ClassLibraries.AddressLookup_RetrieveService

        <DataContract(Name:="Capture_Interactive_Retrieve_v1_00_Results", Namespace:="http://services.postcodeanywhere.co.uk/")>
        Public Partial Class Capture_Interactive_Retrieve_v1_00_Results
            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property Id As String

            <DataMember(Order:=1, EmitDefaultValue:=false)>
            Public Overridable Property DomesticId As String

            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property Language As String

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property LanguageAlternatives As String

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property Department As String

            <DataMember(Order:=5, EmitDefaultValue:=false)>
            Public Overridable Property Company As String

            <DataMember(Order:=6, EmitDefaultValue:=false)>
            Public Overridable Property SubBuilding As String

            <DataMember(Order:=7, EmitDefaultValue:=false)>
            Public Overridable Property BuildingNumber As String

            <DataMember(Order:=8, EmitDefaultValue:=false)>
            Public Overridable Property BuildingName As String

            <DataMember(Order:=9, EmitDefaultValue:=false)>
            Public Overridable Property SecondaryStreet As String

            <DataMember(Order:=10, EmitDefaultValue:=false)>
            Public Overridable Property Street As String

            <DataMember(Order:=11, EmitDefaultValue:=false)>
            Public Overridable Property Block As String

            <DataMember(Order:=12, EmitDefaultValue:=false)>
            Public Overridable Property Neighbourhood As String

            <DataMember(Order:=13, EmitDefaultValue:=false)>
            Public Overridable Property District As String

            <DataMember(Order:=14, EmitDefaultValue:=false)>
            Public Overridable Property City As String

            <DataMember(Order:=15, EmitDefaultValue:=false)>
            Public Overridable Property Line1 As String

            <DataMember(Order:=16, EmitDefaultValue:=false)>
            Public Overridable Property Line2 As String

            <DataMember(Order:=17, EmitDefaultValue:=false)>
            Public Overridable Property Line3 As String

            <DataMember(Order:=18, EmitDefaultValue:=false)>
            Public Overridable Property Line4 As String

            <DataMember(Order:=19, EmitDefaultValue:=false)>
            Public Overridable Property Line5 As String

            <DataMember(Order:=20, EmitDefaultValue:=false)>
            Public Overridable Property AdminAreaName As String

            <DataMember(Order:=21, EmitDefaultValue:=false)>
            Public Overridable Property AdminAreaCode As String

            <DataMember(Order:=22, EmitDefaultValue:=false)>
            Public Overridable Property Province As String

            <DataMember(Order:=23, EmitDefaultValue:=false)>
            Public Overridable Property ProvinceName As String

            <DataMember(Order:=24, EmitDefaultValue:=false)>
            Public Overridable Property ProvinceCode As String

            <DataMember(Order:=25, EmitDefaultValue:=false)>
            Public Overridable Property PostalCode As String

            <DataMember(Order:=26, EmitDefaultValue:=false)>
            Public Overridable Property CountryName As String

            <DataMember(Order:=27, EmitDefaultValue:=false)>
            Public Overridable Property CountryIso2 As String

            <DataMember(Order:=28, EmitDefaultValue:=false)>
            Public Overridable Property CountryIso3 As String

            <DataMember(Order:=29, IsRequired:=true)>
            Public Overridable Property CountryIsoNumber As Integer

            <DataMember(Order:=30, EmitDefaultValue:=false)>
            Public Overridable Property SortingNumber1 As String

            <DataMember(Order:=31, EmitDefaultValue:=false)>
            Public Overridable Property SortingNumber2 As String

            <DataMember(Order:=32, EmitDefaultValue:=false)>
            Public Overridable Property Barcode As String

            <DataMember(Order:=33, EmitDefaultValue:=false)>
            Public Overridable Property POBoxNumber As String

            <DataMember(Order:=34, EmitDefaultValue:=false)>
            Public Overridable Property Label As String

            <DataMember(Order:=35, EmitDefaultValue:=false)>
            Public Overridable Property Type As String

            <DataMember(Order:=36, EmitDefaultValue:=false)>
            Public Overridable Property DataLevel As String

            <DataMember(Order:=37, EmitDefaultValue:=false)>
            Public Overridable Property Field1 As String

            <DataMember(Order:=38, EmitDefaultValue:=false)>
            Public Overridable Property Field2 As String

            <DataMember(Order:=39, EmitDefaultValue:=false)>
            Public Overridable Property Field3 As String

            <DataMember(Order:=40, EmitDefaultValue:=false)>
            Public Overridable Property Field4 As String

            <DataMember(Order:=41, EmitDefaultValue:=false)>
            Public Overridable Property Field5 As String

            <DataMember(Order:=42, EmitDefaultValue:=false)>
            Public Overridable Property Field6 As String

            <DataMember(Order:=43, EmitDefaultValue:=false)>
            Public Overridable Property Field7 As String

            <DataMember(Order:=44, EmitDefaultValue:=false)>
            Public Overridable Property Field8 As String

            <DataMember(Order:=45, EmitDefaultValue:=false)>
            Public Overridable Property Field9 As String

            <DataMember(Order:=46, EmitDefaultValue:=false)>
            Public Overridable Property Field10 As String

            <DataMember(Order:=47, EmitDefaultValue:=false)>
            Public Overridable Property Field11 As String

            <DataMember(Order:=48, EmitDefaultValue:=false)>
            Public Overridable Property Field12 As String

            <DataMember(Order:=49, EmitDefaultValue:=false)>
            Public Overridable Property Field13 As String

            <DataMember(Order:=50, EmitDefaultValue:=false)>
            Public Overridable Property Field14 As String

            <DataMember(Order:=51, EmitDefaultValue:=false)>
            Public Overridable Property Field15 As String

            <DataMember(Order:=52, EmitDefaultValue:=false)>
            Public Overridable Property Field16 As String

            <DataMember(Order:=53, EmitDefaultValue:=false)>
            Public Overridable Property Field17 As String

            <DataMember(Order:=54, EmitDefaultValue:=false)>
            Public Overridable Property Field18 As String

            <DataMember(Order:=55, EmitDefaultValue:=false)>
            Public Overridable Property Field19 As String

            <DataMember(Order:=56, EmitDefaultValue:=false)>
            Public Overridable Property Field20 As String
        End Class
    End Namespace
End Namespace

VB.NET AddressRequest DTOs

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