JSON API » plans » plans/ingroups/get

Gets the fields of a rate plan inbound group.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
ingroupIntegerID of inbound group.Yes
planIntegerID of rate plan.Yes

Responses

CodeDescription
200Success.
400The rate plan does not exist, or you do not have permission to view it.
401The authentication details provided are invalid.
402Your role does not allow this.
404The rate plan inbound group does not exist, or you do not have permission to view it.

Data returned

Fields of rate plan inbound group.

Example: With required parameters

http://enswitch.example.com/api/json/plans/ingroups/get/?auth_username=user;auth_password=password;ingroup=1;plan=2

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "ingroup":1, "plan":2, ... } }

Change history

VersionChanges
3.13Function added.