Favorites

Get favorites list

GET

https://odkmedia.io

/odx/api/v4/favorites/

Retrieve favorites list for a specific device.

Get favorites list › query Parameters

ordering

string

Which field to use when ordering the results.

page

integer

A page number within the paginated result set.

Default: 1

page_size

integer

Number of results to return per page.

Example: 10

search

string

A search term.

Get favorites list › Headers

did

string · required

Device ID

Example: 00000000-0000-4000-8000-000000000000

Get favorites list › Responses

PaginatedAmasianFavoriteList

count

integer

next

string | null · uri

previous

string | null · uri

AmasianFavorite[]

Add to favorites

POST

https://odkmedia.io

/odx/api/v4/favorites/

Code
    Add a new item to favorites.

    **Request Headers:**
    - `did`: Device identifier (required)

    **Request Body (JSON):**
    ```json
    {
        "source_id": 123,
        "type": "content"
    }
    ```

    **Field descriptions:**
    - `source_id`: ID of the content/season/channel to add (integer, required)
    - `type`: Item type - one of "content", "season", "channel" (string, required)

    **Note:** Device ID is provided via 'did' header, not in request body.

Add to favorites › Headers

did

string · required

Device ID

Example: 00000000-0000-4000-8000-000000000000

Add to favorites › Request Body

Serializer for AmasianFavorites model. Handles serialization and validation of favorite items. Supports content, season, and channel types. Device ID is provided via 'did' request header, not in request body.

AmasianFavoriteRequest

source_id

integer · min: 1 · required

ID of the content, season, or channel (positive integer)

type

AmasianFavoriteTypeEnum · enum · required

content - Content
season - Season
channel - Channel

Enum values:

content

season

channel

Add to favorites › Responses

AmasianFavorite

source_id

integer · min: 1 · required

ID of the content, season, or channel (positive integer)

type

AmasianFavoriteTypeEnum · enum · required

content - Content
season - Season
channel - Channel

Enum values:

content

season

channel

created

string · date-time · readOnly

device_id

string · readOnly

Remove from favorites

DELETE

https://odkmedia.io

/odx/api/v4/favorites/

Code
    Remove a specific item from favorites.

    **Request Headers:**
    - `did`: Device identifier (required)

    **Request Body (JSON):**
    ```json
    {
        "source_id": 123,
        "type": "content"
    }
    ```

    **Field descriptions:**
    - `source_id`: ID of the content/season/channel to remove (positive_integer, required)
    - `type`: Item type - one of "content", "season", "channel" (string, required)

    **Note:** Device ID is provided via 'did' header, not in request body.

Remove from favorites › Headers

did

string · required

Device ID

Example: 00000000-0000-4000-8000-000000000000

Remove from favorites › Responses

Successfully deleted

No data returned

device-data multichannel

Get favorites list

GET

https://odkmedia.io

/odx/api/v4/favorites/

Retrieve favorites list for a specific device.

Get favorites list › query Parameters

ordering

string

Which field to use when ordering the results.

page

integer

A page number within the paginated result set.

Default: 1

page_size

integer

Number of results to return per page.

Example: 10

search

string

A search term.

Get favorites list › Headers

did

string · required

Device ID

Example: 00000000-0000-4000-8000-000000000000

Get favorites list › Responses

PaginatedAmasianFavoriteList

count

integer

next

string | null · uri

previous

string | null · uri

AmasianFavorite[]

Add to favorites

POST

https://odkmedia.io

/odx/api/v4/favorites/

Code
    Add a new item to favorites.

    **Request Headers:**
    - `did`: Device identifier (required)

    **Request Body (JSON):**
    ```json
    {
        "source_id": 123,
        "type": "content"
    }
    ```

    **Field descriptions:**
    - `source_id`: ID of the content/season/channel to add (integer, required)
    - `type`: Item type - one of "content", "season", "channel" (string, required)

    **Note:** Device ID is provided via 'did' header, not in request body.

Add to favorites › Headers

did

string · required

Device ID

Example: 00000000-0000-4000-8000-000000000000

Add to favorites › Request Body

AmasianFavoriteRequest

source_id

integer · min: 1 · required

ID of the content, season, or channel (positive integer)

type

AmasianFavoriteTypeEnum · enum · required

content - Content
season - Season
channel - Channel

Enum values:

content

season

channel

Add to favorites › Responses

AmasianFavorite

source_id

integer · min: 1 · required

ID of the content, season, or channel (positive integer)

type

AmasianFavoriteTypeEnum · enum · required

content - Content
season - Season
channel - Channel

Enum values:

content

season

channel

created

string · date-time · readOnly

device_id

string · readOnly

Remove from favorites

DELETE

https://odkmedia.io

/odx/api/v4/favorites/

Code
    Remove a specific item from favorites.

    **Request Headers:**
    - `did`: Device identifier (required)

    **Request Body (JSON):**
    ```json
    {
        "source_id": 123,
        "type": "content"
    }
    ```

    **Field descriptions:**
    - `source_id`: ID of the content/season/channel to remove (positive_integer, required)
    - `type`: Item type - one of "content", "season", "channel" (string, required)

    **Note:** Device ID is provided via 'did' header, not in request body.

Remove from favorites › Headers

did

string · required

Device ID

Example: 00000000-0000-4000-8000-000000000000

Remove from favorites › Responses

Successfully deleted

No data returned