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
namespace CDD_Engine_WS.dto.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract(Name="Capture_Interactive_Retrieve_v1_00_Results", Namespace="http://services.postcodeanywhere.co.uk/")>]
    [<AllowNullLiteral>]
    type Capture_Interactive_Retrieve_v1_00_Results() = 
        [<DataMember(EmitDefaultValue=false)>]
        member val Id:String = null with get,set

        [<DataMember(Order=1, EmitDefaultValue=false)>]
        member val DomesticId:String = null with get,set

        [<DataMember(Order=2, EmitDefaultValue=false)>]
        member val Language:String = null with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val LanguageAlternatives:String = null with get,set

        [<DataMember(Order=4, EmitDefaultValue=false)>]
        member val Department:String = null with get,set

        [<DataMember(Order=5, EmitDefaultValue=false)>]
        member val Company:String = null with get,set

        [<DataMember(Order=6, EmitDefaultValue=false)>]
        member val SubBuilding:String = null with get,set

        [<DataMember(Order=7, EmitDefaultValue=false)>]
        member val BuildingNumber:String = null with get,set

        [<DataMember(Order=8, EmitDefaultValue=false)>]
        member val BuildingName:String = null with get,set

        [<DataMember(Order=9, EmitDefaultValue=false)>]
        member val SecondaryStreet:String = null with get,set

        [<DataMember(Order=10, EmitDefaultValue=false)>]
        member val Street:String = null with get,set

        [<DataMember(Order=11, EmitDefaultValue=false)>]
        member val Block:String = null with get,set

        [<DataMember(Order=12, EmitDefaultValue=false)>]
        member val Neighbourhood:String = null with get,set

        [<DataMember(Order=13, EmitDefaultValue=false)>]
        member val District:String = null with get,set

        [<DataMember(Order=14, EmitDefaultValue=false)>]
        member val City:String = null with get,set

        [<DataMember(Order=15, EmitDefaultValue=false)>]
        member val Line1:String = null with get,set

        [<DataMember(Order=16, EmitDefaultValue=false)>]
        member val Line2:String = null with get,set

        [<DataMember(Order=17, EmitDefaultValue=false)>]
        member val Line3:String = null with get,set

        [<DataMember(Order=18, EmitDefaultValue=false)>]
        member val Line4:String = null with get,set

        [<DataMember(Order=19, EmitDefaultValue=false)>]
        member val Line5:String = null with get,set

        [<DataMember(Order=20, EmitDefaultValue=false)>]
        member val AdminAreaName:String = null with get,set

        [<DataMember(Order=21, EmitDefaultValue=false)>]
        member val AdminAreaCode:String = null with get,set

        [<DataMember(Order=22, EmitDefaultValue=false)>]
        member val Province:String = null with get,set

        [<DataMember(Order=23, EmitDefaultValue=false)>]
        member val ProvinceName:String = null with get,set

        [<DataMember(Order=24, EmitDefaultValue=false)>]
        member val ProvinceCode:String = null with get,set

        [<DataMember(Order=25, EmitDefaultValue=false)>]
        member val PostalCode:String = null with get,set

        [<DataMember(Order=26, EmitDefaultValue=false)>]
        member val CountryName:String = null with get,set

        [<DataMember(Order=27, EmitDefaultValue=false)>]
        member val CountryIso2:String = null with get,set

        [<DataMember(Order=28, EmitDefaultValue=false)>]
        member val CountryIso3:String = null with get,set

        [<DataMember(Order=29, IsRequired=true)>]
        member val CountryIsoNumber:Int32 = new Int32() with get,set

        [<DataMember(Order=30, EmitDefaultValue=false)>]
        member val SortingNumber1:String = null with get,set

        [<DataMember(Order=31, EmitDefaultValue=false)>]
        member val SortingNumber2:String = null with get,set

        [<DataMember(Order=32, EmitDefaultValue=false)>]
        member val Barcode:String = null with get,set

        [<DataMember(Order=33, EmitDefaultValue=false)>]
        member val POBoxNumber:String = null with get,set

        [<DataMember(Order=34, EmitDefaultValue=false)>]
        member val Label:String = null with get,set

        [<DataMember(Order=35, EmitDefaultValue=false)>]
        member val Type:String = null with get,set

        [<DataMember(Order=36, EmitDefaultValue=false)>]
        member val DataLevel:String = null with get,set

        [<DataMember(Order=37, EmitDefaultValue=false)>]
        member val Field1:String = null with get,set

        [<DataMember(Order=38, EmitDefaultValue=false)>]
        member val Field2:String = null with get,set

        [<DataMember(Order=39, EmitDefaultValue=false)>]
        member val Field3:String = null with get,set

        [<DataMember(Order=40, EmitDefaultValue=false)>]
        member val Field4:String = null with get,set

        [<DataMember(Order=41, EmitDefaultValue=false)>]
        member val Field5:String = null with get,set

        [<DataMember(Order=42, EmitDefaultValue=false)>]
        member val Field6:String = null with get,set

        [<DataMember(Order=43, EmitDefaultValue=false)>]
        member val Field7:String = null with get,set

        [<DataMember(Order=44, EmitDefaultValue=false)>]
        member val Field8:String = null with get,set

        [<DataMember(Order=45, EmitDefaultValue=false)>]
        member val Field9:String = null with get,set

        [<DataMember(Order=46, EmitDefaultValue=false)>]
        member val Field10:String = null with get,set

        [<DataMember(Order=47, EmitDefaultValue=false)>]
        member val Field11:String = null with get,set

        [<DataMember(Order=48, EmitDefaultValue=false)>]
        member val Field12:String = null with get,set

        [<DataMember(Order=49, EmitDefaultValue=false)>]
        member val Field13:String = null with get,set

        [<DataMember(Order=50, EmitDefaultValue=false)>]
        member val Field14:String = null with get,set

        [<DataMember(Order=51, EmitDefaultValue=false)>]
        member val Field15:String = null with get,set

        [<DataMember(Order=52, EmitDefaultValue=false)>]
        member val Field16:String = null with get,set

        [<DataMember(Order=53, EmitDefaultValue=false)>]
        member val Field17:String = null with get,set

        [<DataMember(Order=54, EmitDefaultValue=false)>]
        member val Field18:String = null with get,set

        [<DataMember(Order=55, EmitDefaultValue=false)>]
        member val Field19:String = null with get,set

        [<DataMember(Order=56, EmitDefaultValue=false)>]
        member val Field20:String = null with get,set

    [<DataContract(Name="Capture_Interactive_Find_v1_00_Results", Namespace="http://services.postcodeanywhere.co.uk/")>]
    [<AllowNullLiteral>]
    type Capture_Interactive_Find_v1_00_Results() = 
        [<DataMember(EmitDefaultValue=false)>]
        member val Id:String = null with get,set

        [<DataMember(EmitDefaultValue=false)>]
        member val Type:String = null with get,set

        [<DataMember(Order=2, EmitDefaultValue=false)>]
        member val Text:String = null with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val Highlight:String = null with get,set

        [<DataMember(Order=4, EmitDefaultValue=false)>]
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type AdderessResponse() = 
        ///<summary>
        ///Contains response status, details and errors.
        ///</summary>
        member val Successful:Boolean = new Boolean() with get,set

        ///<summary>
        ///The Csr of the application (if available).
        ///</summary>
        member val Csr:String = null with get,set

        ///<summary>
        ///Contains the Adderess lookup Retrieve result when successful.
        ///</summary>
        member val RetrieveResult:IEnumerable<Capture_Interactive_Retrieve_v1_00_Results> = null with get,set

        ///<summary>
        ///Contains the Adderess lookup Find result when successful.
        ///</summary>
        member val FindResults:IEnumerable<Capture_Interactive_Find_v1_00_Results> = null with get,set

    [<AllowNullLiteral>]
    type AddressRequest() = 
        ///<summary>
        ///The Text is address code.
        ///</summary>
        [<Required>]
        member val Text:String = null with get,set

        ///<summary>
        ///The Container is address Id.
        ///</summary>
        [<Required>]
        member val Container:String = null with get,set

        ///<summary>
        ///The Type is type of addresss.
        ///</summary>
        [<Required>]
        member val Type:String = null with get,set

        ///<summary>
        ///The Csr of the application (if available).
        ///</summary>
        member val CSR:String = null with get,set

        ///<summary>
        ///The SourceCode of the Adderess.
        ///</summary>
        member val SourceCode:String = null with get,set

F# 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>