POST api/site/{SiteID}/EndPoint/{EndPointID}/Addresses

This method adds a new address to a site endpoint

Error Messages

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SiteID ID number of current site integer

Required
EndPointID Endpoint ID number where the new address will be created integer

Required

Body Parameters

EndpointAddressBase

EndpointAddressBase
NameDescriptionTypeAdditional information
EndPointID integer

None.
Name Name - must be unique string

Required

String length: inclusive between 0 and 200
Premises Hosue Address string

Required

String length: inclusive between 0 and 255
Thoroughfare Street Address string

Required

String length: inclusive between 0 and 255
Locality Town Address string

String length: inclusive between 0 and 50
County County string

String length: inclusive between 0 and 50
PostCode Post code string

Required

String length: inclusive between 0 and 20
Country Country string

String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample: 
{
  "EndPointID": 1,
  "Name": "sample string 2",
  "Premises": "sample string 3",
  "Thoroughfare": "sample string 4",
  "Locality": "sample string 5",
  "County": "sample string 6",
  "PostCode": "sample string 7",
  "Country": "sample string 8"
}

application/xml, text/xml

Sample: 
<EndpointAddressBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <Country>sample string 8</Country>
  <County>sample string 6</County>
  <EndPointID>1</EndPointID>
  <Locality>sample string 5</Locality>
  <Name>sample string 2</Name>
  <PostCode>sample string 7</PostCode>
  <Premises>sample string 3</Premises>
  <Thoroughfare>sample string 4</Thoroughfare>
</EndpointAddressBase>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EndpointAddressPostResponse

EndpointAddressPostResponse
NameDescriptionTypeAdditional information
AddressID integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "AddressID": 1
}

application/xml, text/xml

Sample: 
<EndpointAddressPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <AddressID>1</AddressID>
</EndpointAddressPostResponse>