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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of number vendor group to update.Yes
classIntegerID of number class to put numbers in.NoCurrent value.
nvgroupStringName of number vendor group.NoCurrent value.
priorityIntegerPriority from 1 to 10.NoCurrent value.
vendorStringName of vendor.NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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

VersionChanges
3.13Function added.