FeedErrorPayload

The standard error envelope. Returned for every failure, including the cases that are delivered with an HTTP 200 status line.

successbooleanrequired

Always false on this payload.

Example: false

error objectrequired

The error detail carried inside every unsuccessful response. All three properties are always present. status is the HTTP status the error maps to, as listed in the error-code table in this document's introduction; the four mnemonics with no status of their own (skipDenied 7, noMoreMusic 9, playNotActive 12, formatUnavailable 24) report status: 200, matching the HTTP 200 they are delivered with.

codeintegerrequired

The numeric Feed.fm error id, e.g. 5 badCredentials, 16 missingParameter, 22 throttled. The enumerated values are the complete set documented in the error-code table in this document's introduction, and are the only codes this surface is contracted to return.

Possible values: [5, 6, 7, 9, 12, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24]

Example: 16

messagestringrequired

A human-readable explanation. Not intended for parsing.

Example: Missing client id

statusintegerrequired

The HTTP status associated with the error, and normally the status the response was sent with. It is 200 for the four mnemonics described above. It also disagrees with the HTTP status line whenever force200 was passed, which forces a 200 on the wire and leaves the real status reported here.

Example: 400

FeedErrorPayload

{
  "success": false,
  "error": {
    "code": 16,
    "message": "Missing client id",
    "status": 400
  }
}