JSON API » starred » starred/get

Gets the starred status of a feature for the authentication user.

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
dtype	String	Destination type.	Yes
dnumber	String	Destination number.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

Whether the feature is starred in the set field. A value of 1 indicates starred, 0 indicates unstarred.

Example: With required parameters

http://enswitch.example.com/api/json/starred/get/?auth_username=user;auth_password=password;dtype=phone;dnumber=1234567

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "set":1 } }

Change history

Version	Changes
4.0	Function added.