This is documentation for version 20140520 which is deprecated. The current version is 20220401. We will continue to make deprecated versions available to customers who still use them, but new customers should use the latest version.

Handling errors

There are a number of potential error messages that can be returned from OneMusicAPI. In almost every case this is accompanied by a non-HTTP 200 response.

Timeout

Currently, if no results are found after 55 seconds, OneMusicAPI will abruptly terminate the request and return no more results. In this case, a HTTP 200 result is still returned. Worst case, the response will be:

[ ]

... although if other results were found before the 55 second timeout then they will also be displayed.

Common errors

HTTP status code	Response body	Rectification
`400`	`title is mandatory`	If you are running a name based query, you must include the name of the release.
`400`	`artist is mandatory`	If you are running a name based query, you must include the name of the artist of the release.
`400`	`inc is mandatory and must be 'images'`	The `inc` parameter must be set and must be '`images`'.
`400`	`inc must be 'images'`	The `inc` parameter must be '`images`'. No other string is accepted (yet!).
`403`	`Authentication failed`	Your `user_key` parameter was either not included in the query or was invalid.
`403`	`Authentication parameters missing`	Remember to include your `user_key` parameter.