JSON API » patternmenus » patternmenus/files/upload

Uploads a new pattern menu sound file.

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
patternmenu	Integer	ID of pattern menu.	Yes
file	String	Which file to upload. "digits", "invalid", or "goodbye".	Yes
data	Base64	Base64 encoded contents of WAV file.	Yes, unless sound is set.	Empty string.
sound	Integer	ID of sound to use.	Yes, unless data is set.	0

Either the data or the sound must be set, but not both.

Responses

Code	Description
204	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.
403	Your rate plan does not allow this.
404	The pattern menu does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: With data (data truncated for brevity)

http://enswitch.example.com/api/json/patternmenus/files/upload/?auth_username=user;auth_password=password;patternmenu=123;file=digits;data=...

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Example: With sound

http://enswitch.example.com/api/json/patternmenus/files/upload/?auth_username=user;auth_password=password;patternmenu=123;file=digits;sound=456

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.