JSON API » cards » cards/update
Updates an existing card.
Input parameters
Requires authentication and the cards role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
card | String | Card to update. | Yes | |
balance | Decimal | Card balance. | No | Current value. |
caller | String | Callerid to allow. | No | Current value. |
cardgroup | Integer | ID of the card group to move the card to. | No | Current value. |
currency | String | Currency. | No | Current value. |
locked | Integer | 1 to lock the card, 0 to unlock. | No | Current value. |
pin | String | Card PIN. | No | Current value. |
serial | String | Card serial number. | No | Current value. |
validation | Integer | 1 to validate input then return, 0 for full action. | No | 0 |
Responses
Code | Description |
---|---|
201 | Input passed validation. Only returned if validation=1. |
204 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The card does not exist, or you do not have permission to update it. |
Data returned
No data is returned.
Example: Locking a card
http://enswitch.example.com/api/json/cards/update/?auth_username=user;auth_password=password;id=123;card=1234567890;locked=1{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |