JSON API » help » help/get

Gets the contents of the help key for a specified user, or for a specified language.

Input parameters

Optionally allows authentication. If authentication is provided, the help for the user's language is returned. If authentication is not provided, or is invalid, the help for the specified language, or English by default, is returned.

Name	Type	Description	Required	Default value
key	String	Help key to get.	Yes
auth_username	String	Authentication username.	No	None
auth_password	String	Authentication password.	No	None
language	String	Language to use if authentication is not provided	No	"en"
encoding	String	"base64" to return contents base64 encoded, "raw" to return raw data.	No	"raw"

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
404	The help key was not found.

Data returned

Contents of help key.

Example: With authentication

http://enswitch.example.com/api/json/help/get/?auth_username=user;auth_password=password;key=phones/edit

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "data":"<p>This is help text for the edit telephone line page.</p>" } }

Example: Without authentication

http://enswitch.example.com/api/json/help/get/?key=phones/edit;language=en

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "data":"<p>This is help text for the edit telephone line page.</p>" } }

Change history

Version	Changes
4.0	Function added.