CDD Engine Web Service v2.14.0.0

AddressRequest

iNASA

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

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

namespace CDD_Engine_WS.dto.Requests
{
    public partial class AddressRequest
    {
        ///<summary>
        ///The Text is address code.
        ///</summary>
        [Required]
        public virtual string Text { get; set; }

        ///<summary>
        ///The Container is address Id.
        ///</summary>
        [Required]
        public virtual string Container { get; set; }

        ///<summary>
        ///The Type is type of addresss.
        ///</summary>
        [Required]
        public virtual string Type { get; set; }

        ///<summary>
        ///The Csr of the application (if available).
        ///</summary>
        public virtual string CSR { get; set; }
        ///<summary>
        ///The SourceCode of the Adderess.
        ///</summary>
        public virtual string SourceCode { get; set; }
    }

}

namespace CDD_Engine_WS.dto.Responses
{
    public partial class AdderessResponse
    {
        ///<summary>
        ///Contains response status, details and errors.
        ///</summary>
        public virtual bool Successful { get; set; }
        ///<summary>
        ///The Csr of the application (if available).
        ///</summary>
        public virtual string Csr { get; set; }
        ///<summary>
        ///Contains the Adderess lookup Retrieve result when successful.
        ///</summary>
        public virtual IEnumerable<Capture_Interactive_Retrieve_v1_00_Results> RetrieveResult { get; set; }
        ///<summary>
        ///Contains the Adderess lookup Find result when successful.
        ///</summary>
        public virtual IEnumerable<Capture_Interactive_Find_v1_00_Results> FindResults { get; set; }
    }

}

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 virtual string Id { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string Type { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual string Text { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual string Highlight { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual string Description { get; set; }
    }

}

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 virtual string Id { get; set; }

        [DataMember(Order=1, EmitDefaultValue=false)]
        public virtual string DomesticId { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual string Language { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual string LanguageAlternatives { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual string Department { get; set; }

        [DataMember(Order=5, EmitDefaultValue=false)]
        public virtual string Company { get; set; }

        [DataMember(Order=6, EmitDefaultValue=false)]
        public virtual string SubBuilding { get; set; }

        [DataMember(Order=7, EmitDefaultValue=false)]
        public virtual string BuildingNumber { get; set; }

        [DataMember(Order=8, EmitDefaultValue=false)]
        public virtual string BuildingName { get; set; }

        [DataMember(Order=9, EmitDefaultValue=false)]
        public virtual string SecondaryStreet { get; set; }

        [DataMember(Order=10, EmitDefaultValue=false)]
        public virtual string Street { get; set; }

        [DataMember(Order=11, EmitDefaultValue=false)]
        public virtual string Block { get; set; }

        [DataMember(Order=12, EmitDefaultValue=false)]
        public virtual string Neighbourhood { get; set; }

        [DataMember(Order=13, EmitDefaultValue=false)]
        public virtual string District { get; set; }

        [DataMember(Order=14, EmitDefaultValue=false)]
        public virtual string City { get; set; }

        [DataMember(Order=15, EmitDefaultValue=false)]
        public virtual string Line1 { get; set; }

        [DataMember(Order=16, EmitDefaultValue=false)]
        public virtual string Line2 { get; set; }

        [DataMember(Order=17, EmitDefaultValue=false)]
        public virtual string Line3 { get; set; }

        [DataMember(Order=18, EmitDefaultValue=false)]
        public virtual string Line4 { get; set; }

        [DataMember(Order=19, EmitDefaultValue=false)]
        public virtual string Line5 { get; set; }

        [DataMember(Order=20, EmitDefaultValue=false)]
        public virtual string AdminAreaName { get; set; }

        [DataMember(Order=21, EmitDefaultValue=false)]
        public virtual string AdminAreaCode { get; set; }

        [DataMember(Order=22, EmitDefaultValue=false)]
        public virtual string Province { get; set; }

        [DataMember(Order=23, EmitDefaultValue=false)]
        public virtual string ProvinceName { get; set; }

        [DataMember(Order=24, EmitDefaultValue=false)]
        public virtual string ProvinceCode { get; set; }

        [DataMember(Order=25, EmitDefaultValue=false)]
        public virtual string PostalCode { get; set; }

        [DataMember(Order=26, EmitDefaultValue=false)]
        public virtual string CountryName { get; set; }

        [DataMember(Order=27, EmitDefaultValue=false)]
        public virtual string CountryIso2 { get; set; }

        [DataMember(Order=28, EmitDefaultValue=false)]
        public virtual string CountryIso3 { get; set; }

        [DataMember(Order=29, IsRequired=true)]
        public virtual int CountryIsoNumber { get; set; }

        [DataMember(Order=30, EmitDefaultValue=false)]
        public virtual string SortingNumber1 { get; set; }

        [DataMember(Order=31, EmitDefaultValue=false)]
        public virtual string SortingNumber2 { get; set; }

        [DataMember(Order=32, EmitDefaultValue=false)]
        public virtual string Barcode { get; set; }

        [DataMember(Order=33, EmitDefaultValue=false)]
        public virtual string POBoxNumber { get; set; }

        [DataMember(Order=34, EmitDefaultValue=false)]
        public virtual string Label { get; set; }

        [DataMember(Order=35, EmitDefaultValue=false)]
        public virtual string Type { get; set; }

        [DataMember(Order=36, EmitDefaultValue=false)]
        public virtual string DataLevel { get; set; }

        [DataMember(Order=37, EmitDefaultValue=false)]
        public virtual string Field1 { get; set; }

        [DataMember(Order=38, EmitDefaultValue=false)]
        public virtual string Field2 { get; set; }

        [DataMember(Order=39, EmitDefaultValue=false)]
        public virtual string Field3 { get; set; }

        [DataMember(Order=40, EmitDefaultValue=false)]
        public virtual string Field4 { get; set; }

        [DataMember(Order=41, EmitDefaultValue=false)]
        public virtual string Field5 { get; set; }

        [DataMember(Order=42, EmitDefaultValue=false)]
        public virtual string Field6 { get; set; }

        [DataMember(Order=43, EmitDefaultValue=false)]
        public virtual string Field7 { get; set; }

        [DataMember(Order=44, EmitDefaultValue=false)]
        public virtual string Field8 { get; set; }

        [DataMember(Order=45, EmitDefaultValue=false)]
        public virtual string Field9 { get; set; }

        [DataMember(Order=46, EmitDefaultValue=false)]
        public virtual string Field10 { get; set; }

        [DataMember(Order=47, EmitDefaultValue=false)]
        public virtual string Field11 { get; set; }

        [DataMember(Order=48, EmitDefaultValue=false)]
        public virtual string Field12 { get; set; }

        [DataMember(Order=49, EmitDefaultValue=false)]
        public virtual string Field13 { get; set; }

        [DataMember(Order=50, EmitDefaultValue=false)]
        public virtual string Field14 { get; set; }

        [DataMember(Order=51, EmitDefaultValue=false)]
        public virtual string Field15 { get; set; }

        [DataMember(Order=52, EmitDefaultValue=false)]
        public virtual string Field16 { get; set; }

        [DataMember(Order=53, EmitDefaultValue=false)]
        public virtual string Field17 { get; set; }

        [DataMember(Order=54, EmitDefaultValue=false)]
        public virtual string Field18 { get; set; }

        [DataMember(Order=55, EmitDefaultValue=false)]
        public virtual string Field19 { get; set; }

        [DataMember(Order=56, EmitDefaultValue=false)]
        public virtual string Field20 { get; set; }
    }

}

C# 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: wpcdd-featuretest-ws.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
}