GET api/site/{SiteID}/EndPoint/{EndPointID}/Numbers/{EndpointNumberID}
The purpose of this method to get the details of specified number of an endpoint
Error Messages
- 500/InternalServerError: Error retrieving endpoint numbers from endpoint with id x
- 404/NotFound: No number records found for 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 |
| EndpointNumberID | The ID of the Endpoint number | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
EndpointNumberView
EndpointNumberView| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | The ID of the endpoint number | integer |
None. |
| EndPointID | The ID of the endpoint the endpoint number is one | integer |
None. |
| EndpointNumberProperties | The Endpoint number properties. This will include properties suich the Control type and property ID | Collection of EndPointNumberPropertyView |
None. |
| Number | The Endpoint number | string |
String length: inclusive between 0 and 17 |
| CarrierID | The carrier ID of the Endpoint number | integer |
None. |