JSON API » ingroups » ingroups/nvgroups/update
Updates an existing number vendor group in an inbound group.
Input parameters
Requires authentication and the system role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
id | Integer | ID of number vendor group to update. | Yes | |
class | Integer | ID of number class to put numbers in. | No | Current value. |
nvgroup | String | Name of number vendor group. | No | Current value. |
priority | Integer | Priority from 1 to 10. | No | Current value. |
vendor | String | Name of vendor. | 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 number vendor group does not exist. |
Data returned
No data is returned.
Example: Changing the number vendor group name
http://enswitch.example.com/api/json/ingroups/nvgroups/update/?auth_username=user;auth_password=password;id=123;nvgroup=example1{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |