Favourite Track or Clip

GET

/my/music/favourites/{type}/{id}

Check to see if a single track or clip entity is in a users favourites - determines UX of add button.

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Body

🔴500Unexpected error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://rms.api.bbc.co.uk//my/music/favourites//' \
--header 'Authorization;' \
--header 'X-Authentication-Provider;' \
--header 'X-API-Key;'

Response Example

200 - Example 1

{
    "limit": 0,
    "method": "string",
    "offset": 0,
    "replied_at": "string",
    "results": [
        {
            "action": "string",
            "activity": "string",
            "added_at": "string",
            "data": [
                {
                    "artist": {
                        "id": "string",
                        "images": [
                            {
                                "format": "string",
                                "id": "string",
                                "type": "string"
                            }
                        ],
                        "name": "string",
                        "role": "string"
                    },
                    "clip": {
                        "contributors": [
                            "string"
                        ],
                        "endDate": "string",
                        "entityType": "string",
                        "imageUrl": "string",
                        "masterbrandMid": "string",
                        "mediaType": "string",
                        "parentProgramme": {
                            "entityType": "string",
                            "pid": "string",
                            "title": "string"
                        },
                        "pid": "string",
                        "startDate": "string",
                        "synopsis": "string",
                        "title": "string",
                        "version": {
                            "classical": true,
                            "duration": "string",
                            "radio": true,
                            "vpid": "string"
                        }
                    },
                    "genre": {
                        "id": "string",
                        "key": "string",
                        "title": "string",
                        "type": "string"
                    },
                    "playlist": {
                        "description": "string",
                        "images": [
                            {
                                "format": "string",
                                "id": "string",
                                "type": "string"
                            }
                        ],
                        "playback_type": "string",
                        "service_id": "string",
                        "title": "string",
                        "tracks": {
                            "contributions": [
                                {
                                    "id": "string",
                                    "images": [
                                        {
                                            "format": "string",
                                            "id": "string",
                                            "type": "string"
                                        }
                                    ],
                                    "name": "string",
                                    "role": "string"
                                }
                            ],
                            "id": "string",
                            "images": [
                                {
                                    "format": "string",
                                    "id": "string",
                                    "type": "string"
                                }
                            ],
                            "media": [
                                {
                                    "duration": 0,
                                    "format": "string",
                                    "id": "string",
                                    "scope": "string",
                                    "source": "string",
                                    "type": "string"
                                }
                            ],
                            "title": "string",
                            "type": "string",
                            "version": {
                                "classical": true,
                                "duration": "string",
                                "radio": true,
                                "vpid": "string"
                            }
                        },
                        "type": "string",
                        "updated_at": "string",
                        "version": {
                            "duration": "string",
                            "expires_at": "string",
                            "id": "string",
                            "starts_at": "string",
                            "warnings": [
                                "string"
                            ]
                        }
                    },
                    "service": {
                        "id": "string",
                        "key": "string",
                        "title": "string",
                        "type": "string"
                    },
                    "track": {
                        "contributions": [
                            {
                                "id": "string",
                                "images": [
                                    {
                                        "format": "string",
                                        "id": "string",
                                        "type": "string"
                                    }
                                ],
                                "name": "string",
                                "role": "string"
                            }
                        ],
                        "id": "string",
                        "images": [
                            {
                                "format": "string",
                                "id": "string",
                                "type": "string"
                            }
                        ],
                        "media": [
                            {
                                "duration": 0,
                                "format": "string",
                                "id": "string",
                                "scope": "string",
                                "source": "string",
                                "type": "string"
                            }
                        ],
                        "title": "string",
                        "type": "string",
                        "version": {
                            "classical": true,
                            "duration": "string",
                            "radio": true,
                            "vpid": "string"
                        }
                    }
                }
            ],
            "domain": "string",
            "id": "string",
            "meta_data": {
                "key": "string"
            },
            "type": "string",
            "urn": "string"
        }
    ],
    "schema": "string",
    "total": 0
}

Modified at 2023-08-15 06:27:11

Favourite Track or Clip