GET api/site/{SiteID}/EndPoint/{EndPointID}/Addresses
The purpose of this method is to get a list of addresses bound to an endpoint
Error Messages
- 500/InternalServerError: Error retrieving endpoint numbers from endpoint with id = x
- 404/Not Found: Error retrieving endpoint numbers from endpoint with id = x
- 403/Forbidden: EndPointId x is not mapped to SiteID y
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SiteID | The unique identifier for the contract being queried. | integer |
Required |
EndPointID | The ID of the endpoint the numbers will be collected from | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of EndpointAddressViewName | Description | Type | Additional information |
---|---|---|---|
AddressID | integer |
None. |
|
EndPointID | integer |
None. |
|
Name | string |
Required String length: inclusive between 0 and 200 |
|
Premises | string |
Required String length: inclusive between 0 and 255 |
|
Thoroughfare | string |
Required String length: inclusive between 0 and 255 |
|
Locality | string |
String length: inclusive between 0 and 50 |
|
County | string |
String length: inclusive between 0 and 50 |
|
PostCode | string |
Required String length: inclusive between 0 and 20 |
|
Country | string |
String length: inclusive between 0 and 50 |