JSON API » music » music/list

Gets the fields of all music classes in the given customer, or available for use by that customer.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
availableInteger1 to get music available for use (including any shared by the system owner), 0 to get music in customer.No0
customerIntegerID of customer to get music for.NoCustomer of authentication user.

Responses

CodeDescription
200Success.
400Invalid customer specified.
401The authentication details provided are invalid.
402Your role does not allow this.

Data returned

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

Example: With required parameters

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

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

Change history

VersionChanges
3.13Function added.