JSON API » patternmenus » patternmenus/files/delete

Deletes a 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 delete. "digits", "invalid", or "goodbye".	Yes

Responses

Code	Description
204	Success.
400	Invalid file specified.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The pattern menu or file does not exist, or you do not have permission to delete it.

Data returned

No data is returned.

Example: With required parameters

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

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

Change history

Version	Changes
3.13	Function added.