GET api/site/{SiteID}/EndPoint
This method is used to get End Points from a site.
Note: Get site endpoints can only return provisioned endpoints
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteID | The Site ID that will return all End Points owned by that company | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
List of endpoints
EndPointView| Name | Description | Type | Additional information |
|---|---|---|---|
| EndPointID | The ID of the End point | integer |
None. |
| SiteID | The ID of the site to which the End Point belongs | integer |
None. |
| Channels | The number of Channels on the End Point | integer |
None. |
| IsProvisioned | Indiates whether the End Point is provisioned | boolean |
None. |
| Name | The End Point Name | string |
Required String length: inclusive between 0 and 200 |
| CustomerName | The name of the customer | string |
Required String length: inclusive between 0 and 255 |
| IPAddress | The Primary IP Address associated with the End Point | string |
Required String length: inclusive between 0 and 16 |
| Premises | The premise location associated with the End Point | string |
Required String length: inclusive between 0 and 255 |
| Thoroughfare | The street name | string |
Required String length: inclusive between 0 and 255 |
| Locality | The locality associated with the End Point. Likely to be similar to county | string |
Required String length: inclusive between 0 and 50 |
| County | The County associated with the End Point | string |
Required String length: inclusive between 0 and 50 |
| PostCode | The postcode associated with the End Point | string |
Required String length: inclusive between 0 and 20 |
| Country | string |
Required String length: inclusive between 0 and 50 |