JSON API » starred » starred/list

Gets an array of all starred features for the authentication user. The array may optionally be limited to features of a specified dtype.

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 of features to return. Empty string for all.	No	Empty string.

Responses

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

Data returned

An array of fields, corresponding to the rows of the starred table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/starred/list/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "person":1, "dtype":"huntgroup", "dnumber":123 }, { "person":1, "dtype":"phone", "dnumber":"1234567" } ] }

Change history

Version	Changes
4.0	Function added.