JSON API » roles » roles/default/get

Gets the default role.

Input parameters

Does not require authentication.

Name	Type	Description	Required	Default value
purpose	String	Purpose of role. "pseudo", "residential", or "user".	No	"user"

Responses

Code	Description
200	Success.

Data returned

ID of role. If no suitable role could be found, 0 is returned.

Example: With required parameters

http://enswitch.example.com/api/json/roles/default/get/

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

Change history

Version	Changes
3.13	Function added.