Request to skip a play that is currently being played.
POST/play/:play_id/skip
Ask the server if the client may end playback of and skip the currently playing song.
A 200 here does not mean the skip was granted. Both of the ways a
skip is refused are rendered as HTTP 200 with success: false:
skipDenied(code 7) — the client has no skips available. Under radio rights this is the cap of 6 skips per station per 60 minutes, or a country whose rules disallow skipping at all.playNotActive(code 12) — the play was never started, was already completed or skipped, or is not the client's current play.
A client MUST inspect the success property of the body and keep
playing the current song when it is false; treating the status code
alone as success will silently drop the listener into a dead player.
seconds optionally reports how far the listener got before skipping.
Request
Responses
- 200
- 400
- 401
- 404
- default
Either the skip succeeded (success: true), or it was refused with
skipDenied (code 7) or playNotActive (code 12), both of which
are returned here with success: false rather than as an error
status.
missingParameter (code 16) — no client_id was supplied, or the
play id in the path is missing or non-numeric (Invalid or missing play id.).
Credentials were missing or invalid. The response carries
WWW-Authenticate: Basic realm="Feed.fm".
Response Headers
The authentication challenge. Always Basic realm="Feed.fm".
Basic realm="Feed.fm"missingObject (code 17) — no such play, or the play is not in this
client's play history.
An error occurred.