| GET, POST | /Address |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract(Name="Capture_Interactive_Retrieve_v1_00_Results", Namespace="http://services.postcodeanywhere.co.uk/")
class Capture_Interactive_Retrieve_v1_00_Results implements IConvertible
{
// @DataMember(EmitDefaultValue=false)
String? Id;
// @DataMember(Order=1, EmitDefaultValue=false)
String? DomesticId;
// @DataMember(Order=2, EmitDefaultValue=false)
String? Language;
// @DataMember(Order=3, EmitDefaultValue=false)
String? LanguageAlternatives;
// @DataMember(Order=4, EmitDefaultValue=false)
String? Department;
// @DataMember(Order=5, EmitDefaultValue=false)
String? Company;
// @DataMember(Order=6, EmitDefaultValue=false)
String? SubBuilding;
// @DataMember(Order=7, EmitDefaultValue=false)
String? BuildingNumber;
// @DataMember(Order=8, EmitDefaultValue=false)
String? BuildingName;
// @DataMember(Order=9, EmitDefaultValue=false)
String? SecondaryStreet;
// @DataMember(Order=10, EmitDefaultValue=false)
String? Street;
// @DataMember(Order=11, EmitDefaultValue=false)
String? Block;
// @DataMember(Order=12, EmitDefaultValue=false)
String? Neighbourhood;
// @DataMember(Order=13, EmitDefaultValue=false)
String? District;
// @DataMember(Order=14, EmitDefaultValue=false)
String? City;
// @DataMember(Order=15, EmitDefaultValue=false)
String? Line1;
// @DataMember(Order=16, EmitDefaultValue=false)
String? Line2;
// @DataMember(Order=17, EmitDefaultValue=false)
String? Line3;
// @DataMember(Order=18, EmitDefaultValue=false)
String? Line4;
// @DataMember(Order=19, EmitDefaultValue=false)
String? Line5;
// @DataMember(Order=20, EmitDefaultValue=false)
String? AdminAreaName;
// @DataMember(Order=21, EmitDefaultValue=false)
String? AdminAreaCode;
// @DataMember(Order=22, EmitDefaultValue=false)
String? Province;
// @DataMember(Order=23, EmitDefaultValue=false)
String? ProvinceName;
// @DataMember(Order=24, EmitDefaultValue=false)
String? ProvinceCode;
// @DataMember(Order=25, EmitDefaultValue=false)
String? PostalCode;
// @DataMember(Order=26, EmitDefaultValue=false)
String? CountryName;
// @DataMember(Order=27, EmitDefaultValue=false)
String? CountryIso2;
// @DataMember(Order=28, EmitDefaultValue=false)
String? CountryIso3;
// @DataMember(Order=29, IsRequired=true)
int? CountryIsoNumber;
// @DataMember(Order=30, EmitDefaultValue=false)
String? SortingNumber1;
// @DataMember(Order=31, EmitDefaultValue=false)
String? SortingNumber2;
// @DataMember(Order=32, EmitDefaultValue=false)
String? Barcode;
// @DataMember(Order=33, EmitDefaultValue=false)
String? POBoxNumber;
// @DataMember(Order=34, EmitDefaultValue=false)
String? Label;
// @DataMember(Order=35, EmitDefaultValue=false)
String? Type;
// @DataMember(Order=36, EmitDefaultValue=false)
String? DataLevel;
// @DataMember(Order=37, EmitDefaultValue=false)
String? Field1;
// @DataMember(Order=38, EmitDefaultValue=false)
String? Field2;
// @DataMember(Order=39, EmitDefaultValue=false)
String? Field3;
// @DataMember(Order=40, EmitDefaultValue=false)
String? Field4;
// @DataMember(Order=41, EmitDefaultValue=false)
String? Field5;
// @DataMember(Order=42, EmitDefaultValue=false)
String? Field6;
// @DataMember(Order=43, EmitDefaultValue=false)
String? Field7;
// @DataMember(Order=44, EmitDefaultValue=false)
String? Field8;
// @DataMember(Order=45, EmitDefaultValue=false)
String? Field9;
// @DataMember(Order=46, EmitDefaultValue=false)
String? Field10;
// @DataMember(Order=47, EmitDefaultValue=false)
String? Field11;
// @DataMember(Order=48, EmitDefaultValue=false)
String? Field12;
// @DataMember(Order=49, EmitDefaultValue=false)
String? Field13;
// @DataMember(Order=50, EmitDefaultValue=false)
String? Field14;
// @DataMember(Order=51, EmitDefaultValue=false)
String? Field15;
// @DataMember(Order=52, EmitDefaultValue=false)
String? Field16;
// @DataMember(Order=53, EmitDefaultValue=false)
String? Field17;
// @DataMember(Order=54, EmitDefaultValue=false)
String? Field18;
// @DataMember(Order=55, EmitDefaultValue=false)
String? Field19;
// @DataMember(Order=56, EmitDefaultValue=false)
String? Field20;
Capture_Interactive_Retrieve_v1_00_Results({this.Id,this.DomesticId,this.Language,this.LanguageAlternatives,this.Department,this.Company,this.SubBuilding,this.BuildingNumber,this.BuildingName,this.SecondaryStreet,this.Street,this.Block,this.Neighbourhood,this.District,this.City,this.Line1,this.Line2,this.Line3,this.Line4,this.Line5,this.AdminAreaName,this.AdminAreaCode,this.Province,this.ProvinceName,this.ProvinceCode,this.PostalCode,this.CountryName,this.CountryIso2,this.CountryIso3,this.CountryIsoNumber,this.SortingNumber1,this.SortingNumber2,this.Barcode,this.POBoxNumber,this.Label,this.Type,this.DataLevel,this.Field1,this.Field2,this.Field3,this.Field4,this.Field5,this.Field6,this.Field7,this.Field8,this.Field9,this.Field10,this.Field11,this.Field12,this.Field13,this.Field14,this.Field15,this.Field16,this.Field17,this.Field18,this.Field19,this.Field20});
Capture_Interactive_Retrieve_v1_00_Results.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
DomesticId = json['DomesticId'];
Language = json['Language'];
LanguageAlternatives = json['LanguageAlternatives'];
Department = json['Department'];
Company = json['Company'];
SubBuilding = json['SubBuilding'];
BuildingNumber = json['BuildingNumber'];
BuildingName = json['BuildingName'];
SecondaryStreet = json['SecondaryStreet'];
Street = json['Street'];
Block = json['Block'];
Neighbourhood = json['Neighbourhood'];
District = json['District'];
City = json['City'];
Line1 = json['Line1'];
Line2 = json['Line2'];
Line3 = json['Line3'];
Line4 = json['Line4'];
Line5 = json['Line5'];
AdminAreaName = json['AdminAreaName'];
AdminAreaCode = json['AdminAreaCode'];
Province = json['Province'];
ProvinceName = json['ProvinceName'];
ProvinceCode = json['ProvinceCode'];
PostalCode = json['PostalCode'];
CountryName = json['CountryName'];
CountryIso2 = json['CountryIso2'];
CountryIso3 = json['CountryIso3'];
CountryIsoNumber = json['CountryIsoNumber'];
SortingNumber1 = json['SortingNumber1'];
SortingNumber2 = json['SortingNumber2'];
Barcode = json['Barcode'];
POBoxNumber = json['POBoxNumber'];
Label = json['Label'];
Type = json['Type'];
DataLevel = json['DataLevel'];
Field1 = json['Field1'];
Field2 = json['Field2'];
Field3 = json['Field3'];
Field4 = json['Field4'];
Field5 = json['Field5'];
Field6 = json['Field6'];
Field7 = json['Field7'];
Field8 = json['Field8'];
Field9 = json['Field9'];
Field10 = json['Field10'];
Field11 = json['Field11'];
Field12 = json['Field12'];
Field13 = json['Field13'];
Field14 = json['Field14'];
Field15 = json['Field15'];
Field16 = json['Field16'];
Field17 = json['Field17'];
Field18 = json['Field18'];
Field19 = json['Field19'];
Field20 = json['Field20'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'DomesticId': DomesticId,
'Language': Language,
'LanguageAlternatives': LanguageAlternatives,
'Department': Department,
'Company': Company,
'SubBuilding': SubBuilding,
'BuildingNumber': BuildingNumber,
'BuildingName': BuildingName,
'SecondaryStreet': SecondaryStreet,
'Street': Street,
'Block': Block,
'Neighbourhood': Neighbourhood,
'District': District,
'City': City,
'Line1': Line1,
'Line2': Line2,
'Line3': Line3,
'Line4': Line4,
'Line5': Line5,
'AdminAreaName': AdminAreaName,
'AdminAreaCode': AdminAreaCode,
'Province': Province,
'ProvinceName': ProvinceName,
'ProvinceCode': ProvinceCode,
'PostalCode': PostalCode,
'CountryName': CountryName,
'CountryIso2': CountryIso2,
'CountryIso3': CountryIso3,
'CountryIsoNumber': CountryIsoNumber,
'SortingNumber1': SortingNumber1,
'SortingNumber2': SortingNumber2,
'Barcode': Barcode,
'POBoxNumber': POBoxNumber,
'Label': Label,
'Type': Type,
'DataLevel': DataLevel,
'Field1': Field1,
'Field2': Field2,
'Field3': Field3,
'Field4': Field4,
'Field5': Field5,
'Field6': Field6,
'Field7': Field7,
'Field8': Field8,
'Field9': Field9,
'Field10': Field10,
'Field11': Field11,
'Field12': Field12,
'Field13': Field13,
'Field14': Field14,
'Field15': Field15,
'Field16': Field16,
'Field17': Field17,
'Field18': Field18,
'Field19': Field19,
'Field20': Field20
};
getTypeName() => "Capture_Interactive_Retrieve_v1_00_Results";
TypeContext? context = _ctx;
}
// @DataContract(Name="Capture_Interactive_Find_v1_00_Results", Namespace="http://services.postcodeanywhere.co.uk/")
class Capture_Interactive_Find_v1_00_Results implements IConvertible
{
// @DataMember(EmitDefaultValue=false)
String? Id;
// @DataMember(EmitDefaultValue=false)
String? Type;
// @DataMember(Order=2, EmitDefaultValue=false)
String? Text;
// @DataMember(Order=3, EmitDefaultValue=false)
String? Highlight;
// @DataMember(Order=4, EmitDefaultValue=false)
String? Description;
Capture_Interactive_Find_v1_00_Results({this.Id,this.Type,this.Text,this.Highlight,this.Description});
Capture_Interactive_Find_v1_00_Results.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Type = json['Type'];
Text = json['Text'];
Highlight = json['Highlight'];
Description = json['Description'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Type': Type,
'Text': Text,
'Highlight': Highlight,
'Description': Description
};
getTypeName() => "Capture_Interactive_Find_v1_00_Results";
TypeContext? context = _ctx;
}
class AdderessResponse implements IConvertible
{
/**
* Contains response status, details and errors.
*/
bool? Successful;
/**
* The Csr of the application (if available).
*/
String? Csr;
/**
* Contains the Adderess lookup Retrieve result when successful.
*/
List<Capture_Interactive_Retrieve_v1_00_Results>? RetrieveResult;
/**
* Contains the Adderess lookup Find result when successful.
*/
List<Capture_Interactive_Find_v1_00_Results>? FindResults;
AdderessResponse({this.Successful,this.Csr,this.RetrieveResult,this.FindResults});
AdderessResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Successful = json['Successful'];
Csr = json['Csr'];
RetrieveResult = JsonConverters.fromJson(json['RetrieveResult'],'List<Capture_Interactive_Retrieve_v1_00_Results>',context!);
FindResults = JsonConverters.fromJson(json['FindResults'],'List<Capture_Interactive_Find_v1_00_Results>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Successful': Successful,
'Csr': Csr,
'RetrieveResult': JsonConverters.toJson(RetrieveResult,'List<Capture_Interactive_Retrieve_v1_00_Results>',context!),
'FindResults': JsonConverters.toJson(FindResults,'List<Capture_Interactive_Find_v1_00_Results>',context!)
};
getTypeName() => "AdderessResponse";
TypeContext? context = _ctx;
}
class AddressRequest implements IConvertible
{
/**
* The Text is address code.
*/
// @Required()
String? Text;
/**
* The Container is address Id.
*/
// @Required()
String? Container;
/**
* The Type is type of addresss.
*/
// @Required()
String? Type;
/**
* The Csr of the application (if available).
*/
String? CSR;
/**
* The SourceCode of the Adderess.
*/
String? SourceCode;
AddressRequest({this.Text,this.Container,this.Type,this.CSR,this.SourceCode});
AddressRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Text = json['Text'];
Container = json['Container'];
Type = json['Type'];
CSR = json['CSR'];
SourceCode = json['SourceCode'];
return this;
}
Map<String, dynamic> toJson() => {
'Text': Text,
'Container': Container,
'Type': Type,
'CSR': CSR,
'SourceCode': SourceCode
};
getTypeName() => "AddressRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'wpcdd_featuretest_ws.worldpay.com', types: <String, TypeInfo> {
'Capture_Interactive_Retrieve_v1_00_Results': TypeInfo(TypeOf.Class, create:() => Capture_Interactive_Retrieve_v1_00_Results()),
'Capture_Interactive_Find_v1_00_Results': TypeInfo(TypeOf.Class, create:() => Capture_Interactive_Find_v1_00_Results()),
'AdderessResponse': TypeInfo(TypeOf.Class, create:() => AdderessResponse()),
'List<Capture_Interactive_Retrieve_v1_00_Results>': TypeInfo(TypeOf.Class, create:() => <Capture_Interactive_Retrieve_v1_00_Results>[]),
'List<Capture_Interactive_Find_v1_00_Results>': TypeInfo(TypeOf.Class, create:() => <Capture_Interactive_Find_v1_00_Results>[]),
'AddressRequest': TypeInfo(TypeOf.Class, create:() => AddressRequest()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>