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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
customerIntegerID of customer to reset.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The customer does not exist, or you do not have permission to view it.
500An 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

VersionChanges
3.13Function added.