HTTP method: GET
URL: /services/rest/admin/balance
Parameters
parameter name | description | example value |
|---|---|---|
| reseller | Reseller's username | reseller |
| password | Reseller's password | password |
| customer | Name of customer to add credits to. Customer must belong to the reseller. | cheescakeshop |
Example
/services/rest/admin/balance?reseller=reseller&password=password&customer=cheescakeshop
Return values
return value name | description | example |
|---|---|---|
| credits | Number of credits on account | 1500 |
| status | Error code, 0 for no error | 1 |
Response
Service receive parameters as request parameters, and return responses in JSON.
Used status numbers are: 0, 1, 2, 3, 300, 9999 (Status code table is available on User and Reseller REST API Response Status Codes)
Mock
Mock REST service is implemented for now. It returns status based on reseller parameter.
| reseller request parameter value | status |
|---|---|
| good | 0 - OK, returns customer balance 1000 credits |
| bad | 1 - Reseller authentication failed |
| norights | 2 - Reseller does not have rights to the customer |
| <any other value> | 500 - Internal error |