JSON API » vouchers » vouchers/available/check

Checks whether there are any vouchers available for the given customer to use.

Input parameters

Requires authentication and the payment 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 check 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

1 if the parent has any vouchers available, 0 if not.

Example: With required parameters

http://enswitch.example.com/api/json/vouchers/available/check/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "found":1 }, }

Change history

Version	Changes
3.13	Function added.