JSON API » notes » notes/list

Gets the fields of all notes for a given object.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
stype	String	Object type. Empty string for all.	Recommended	Empty string.
snumber	String	Object number. Empty string for all.	Recommended	Empty string.
count	Integer	1 to return a count, 0 to return full data.	No	0
customer	Integer	ID of customer to get notes for.	No	Customer of authentication user.

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
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 notes table in the database.

Example: With required and recommended parameters

http://enswitch.example.com/api/json/notes/list/?auth_username=user;auth_password=password;stype=phone;snumber=1234567

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "subject":"example1", ... }, { "id":2, "subject":"example2", ... } ] }

Change history

Version	Changes
4.3	count parameter added.
3.13	Function added.