JSON API » callshops » callshops/reset
Resets a callshop customer for the next user, and creates an invoice for the last user.
Input parameters
Requires authentication and the callshop role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
customer | Integer | ID of customer to reset. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The customer does not exist, or you do not have permission to view it. |
500 | An internal error occurred. Check the key and message fields for more details. |
Data returned
The ID of the invoice created.
Example: With required parameters
http://enswitch.example.com/api/json/callshops/reset/?auth_username=user;auth_password=password;customer=123{ "responses":[ { "code":"204", "key":"", "message":"OK" } ], "data":{ "invoice":1234 } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |