JSON API » provisioning » provisioning/list
Gets the fields of all provisioning templates in the given customer, or available for use by that customer.
Input parameters
Requires authentication and the residential, user, or wholesale role privileges if available=1, else the provisioning role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
available | Integer | 1 to get provisioning templates available for use (including any shared by the system owner), 0 to get provisioning templates in customer. | No | 0 |
customer | Integer | ID of customer to get provisioning for. | No | Customer of authentication user. |
Responses
Code | Description |
---|---|
200 | Success. |
400 | Invalid customer specified. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
Data returned
An array of fields, corresponding to the rows of the provisioning table in the database.
Example: With required parameters
http://enswitch.example.com/api/json/provisioning/list/?auth_username=user;auth_password=password{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"example1", ... }, { "id":2, "name":"example2", ... } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |