JSON API » pagegroups » pagegroups/destinations/get

Gets the fields of a page group destination.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of page group destination to get.	Yes, unless dtype, dnumber, and pagegroup are specified.
dtype	String	Destination type.	No	Empty string.
dnumber	String	Destination number.	No	Empty string.
pagegroup	Integer	ID of page group.	No	0

Either the id or all of dtype, dnumber, and pagegroup must be specified.

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The page group destination does not exist, or you do not have permission to view it.

Data returned

Fields of page group destination.

Example: With id

http://enswitch.example.com/api/json/pagegroups/destinations/get/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "pagegroup":123, ... } }

Change history

Version	Changes
3.13	Function added.