JSON API » cos » cos/outroutes/get
Gets the fields of a class of service exception.
Input parameters
Requires authentication and the administrator role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
id | Integer | ID of class of service. | Yes | |
type | String | "internal" or "external". | Yes | |
prefix | String | Prefix of exception. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The class of service does not exist, or you do not have permission to view it. |
Data returned
Fields of class of service.
Example: With required parameters
http://enswitch.example.com/api/json/cos/outroutes/get/?auth_username=user;auth_password=password;id=123;type=external;prefix=011{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "cos":123, "prefix":"011", ... } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |