POST api/Addresses/Search

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.clsAddressSearchArguments

Name	Type	Additional information
CustomerID	string	Matching regular expression pattern: \d{3}[-]\d{6} String length: inclusive between 10 and 10
PostCode	string	String length: inclusive between 0 and 20
Reference	string	String length: inclusive between 1 and 12

Name

Description

Type

Additional information

CustomerID

string

Matching regular expression pattern: \d{3}[-]\d{6}

String length: inclusive between 10 and 10

PostCode

string

String length: inclusive between 0 and 20

Reference

string

String length: inclusive between 1 and 12

Request Formats

application/json, text/json

Sample:

{
  "CustomerID": "sample string 1",
  "PostCode": "sample string 2",
  "Reference": "sample string 3"
}

application/xml, text/xml

Sample:

<clsAddressSearchArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <CustomerID>sample string 1</CustomerID>
  <PostCode>sample string 2</PostCode>
  <Reference>sample string 3</Reference>
</clsAddressSearchArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsCustomerAddress

Name	Description	Type	Additional information
Reference		string	Required String length: inclusive between 1 and 12
CustomerID		string	Required Matching regular expression pattern: \d{3}[-]\d{6} String length: inclusive between 10 and 10
Company	Optional. Name of the company / organisation.	string	String length: inclusive between 0 and 50
Line1	Optional. The first line of the address i.e. Flat 173	string	String length: inclusive between 0 and 256
Line2	Optional. The second line of the address i.e. Mulberry House	string	String length: inclusive between 0 and 50
Line3	The third line of the address	string	String length: inclusive between 0 and 50
PostalTown	The postal town or city. i.e. London	string	String length: inclusive between 0 and 50
Region	The county or state i.e. Dorset or California	string	String length: inclusive between 0 and 50
PostCode	The postal or zip code.	string	String length: inclusive between 0 and 20
CountryCode	The 2 digit country code, see api/Countries/Search	string	Required String length: inclusive between 2 and 2
Active	If the address is active (in use). Defaults to True if not passed.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Reference": "sample string 1",
    "CustomerID": "sample string 2",
    "Company": "sample string 3",
    "Line1": "sample string 4",
    "Line2": "sample string 5",
    "Line3": "sample string 6",
    "PostalTown": "sample string 7",
    "Region": "sample string 8",
    "PostCode": "sample string 9",
    "CountryCode": "sample string 10",
    "Active": true
  },
  {
    "Reference": "sample string 1",
    "CustomerID": "sample string 2",
    "Company": "sample string 3",
    "Line1": "sample string 4",
    "Line2": "sample string 5",
    "Line3": "sample string 6",
    "PostalTown": "sample string 7",
    "Region": "sample string 8",
    "PostCode": "sample string 9",
    "CountryCode": "sample string 10",
    "Active": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsCustomerAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsCustomerAddress>
    <Active>true</Active>
    <Company>sample string 3</Company>
    <CountryCode>sample string 10</CountryCode>
    <Line1>sample string 4</Line1>
    <Line2>sample string 5</Line2>
    <Line3>sample string 6</Line3>
    <PostCode>sample string 9</PostCode>
    <PostalTown>sample string 7</PostalTown>
    <Region>sample string 8</Region>
    <CustomerID>sample string 2</CustomerID>
    <Reference>sample string 1</Reference>
  </clsCustomerAddress>
  <clsCustomerAddress>
    <Active>true</Active>
    <Company>sample string 3</Company>
    <CountryCode>sample string 10</CountryCode>
    <Line1>sample string 4</Line1>
    <Line2>sample string 5</Line2>
    <Line3>sample string 6</Line3>
    <PostCode>sample string 9</PostCode>
    <PostalTown>sample string 7</PostalTown>
    <Region>sample string 8</Region>
    <CustomerID>sample string 2</CustomerID>
    <Reference>sample string 1</Reference>
  </clsCustomerAddress>
</ArrayOfclsCustomerAddress>