GET api/cli/bycli/{cli}
Return CLI details for specified CLI string. What this means is you can get the details of a specific CLI by entering the CLI number itself.
Error Messages
- 404/NotFound- CLI x not found - Specified CLI is not found in the database
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
cli | Filter by CLI string | string |
Required |
Body Parameters
None.
Response Information
Resource Description
List of cli details matching the cli requested
Collection of CLIViewName | Description | Type | Additional information |
---|---|---|---|
Id | ID of the CLI | integer |
None. |
SiteId | The site ID of the CLI | integer |
None. |
UserName | The name of the owner of the CLI | string |
None. |
TariffInfo | Information on the tariffs on that CLI | CliTariff |
None. |
LineTypeID | The ID of the Line Type | integer |
None. |
LineType | The type of line on the CLI | string |
String length: inclusive between 0 and 20 |
CallType | The type of call on the CLI e.g voice, data, etc | string |
None. |
LastUpdated | The last date/time the CLI has been updated | date |
None. |
CLI | The CLI number | string |
String length: inclusive between 0 and 17 |
StartDate | Start date of the CLI | date |
None. |
EndDate | The date the CLI will cease | date |
None. |
ContractStartDate | date |
None. |
|
ContractEndDate | date |
None. |
|
CustomColumns | Custom columns that can be used to add extra data to the CLI | CLICustomColumns |
None. |