user/favorites

user favorites list

GET

https://odkmedia.io/odx/api/v2

/user/favorites/

user favorites list › query Parameters

debug

string

If value is "on", debug is included in response.

page

integer

The default value is 1

page_size

integer

The default value is 10

user favorites list › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user favorites list › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

listResult

title

title

user favorites create

POST

https://odkmedia.io/odx/api/v2

/user/favorites/

user favorites create › query Parameters

debug

string

If value is "on", debug is included in response.

user favorites create › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user favorites create › Request Body

OdxV2FavoritesInputSchema

program_slug

string · minLength: 1 · required

user favorites create › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

FavoritesProgram

POST/user/favorites/

curl https://odkmedia.io/odx/api/v2/user/favorites \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "program_slug": "program_slug"
}'

Example Request Body

{
  "program_slug": "program_slug"
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "direct_play_episode": {
      "id": 0,
      "sales_type": "GUEST",
      "slug": "slug"
    },
    "free_episode": {
      "id": 0,
      "sales_type": "GUEST",
      "slug": "slug"
    },
    "id": 0,
    "images": {
      "poster": "https://www.example.com/path/to/resource",
      "poster_landscape": "https://www.example.com/path/to/resource",
      "poster_portrait": "https://www.example.com/path/to/resource"
    },
    "is_favorite": true,
    "program": {
      "direct_play_episode_id": 0,
      "id": 0,
      "images": {
        "poster": "https://www.example.com/path/to/resource",
        "poster_landscape": "https://www.example.com/path/to/resource",
        "poster_portrait": "https://www.example.com/path/to/resource"
      },
      "slug": "slug"
    },
    "slug": "slug"
  }
}

json

application/json

user favorites remove all

DELETE

https://odkmedia.io/odx/api/v2

/user/favorites/remove_all/

user favorites remove all › query Parameters

debug

string

If value is "on", debug is included in response.

user favorites remove all › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user favorites remove all › Responses

No Content

No data returned

user favorites delete

DELETE

https://odkmedia.io/odx/api/v2

/user/favorites/{slug}/

user favorites delete › path Parameters

slug

string · required

user favorites delete › query Parameters

debug

string

If value is "on", debug is included in response.

user favorites delete › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user favorites delete › Responses

No Content

No data returned

continuous-watching user/qr-login

user favorites list

GET

https://odkmedia.io/odx/api/v2

/user/favorites/

user favorites list › query Parameters

debug

string

If value is "on", debug is included in response.

page

integer

The default value is 1

page_size

integer

The default value is 10

user favorites list › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user favorites list › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

listResult

title

title

user favorites create

POST

https://odkmedia.io/odx/api/v2

/user/favorites/

user favorites create › query Parameters

debug

string

If value is "on", debug is included in response.

user favorites create › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user favorites create › Request Body

OdxV2FavoritesInputSchema

program_slug

string · minLength: 1 · required

user favorites create › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

FavoritesProgram

user favorites remove all

DELETE

https://odkmedia.io/odx/api/v2

/user/favorites/remove_all/

user favorites remove all › query Parameters

debug

string

If value is "on", debug is included in response.

user favorites remove all › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user favorites remove all › Responses

No Content

No data returned

user favorites delete

DELETE

https://odkmedia.io/odx/api/v2

/user/favorites/{slug}/

user favorites delete › path Parameters

slug

string · required

user favorites delete › query Parameters

debug

string

If value is "on", debug is included in response.

user favorites delete › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user favorites delete › Responses

No Content

No data returned