cover

cover list

GET

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

/cover/

cover 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

cover 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

cover list › Responses

200

code

code

debug

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

messages

messages

listResult

title

title

cover retrieve

GET

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

/cover/{slug}/

The slug of ODK main banner: home-cover-default
The slug of ODK category page's banner: category-cover-{category_slug} (e.g. category-cover-drama)

cover retrieve › path Parameters

slug

string · required

cover retrieve › query Parameters

debug

string

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

cover retrieve › 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

cover retrieve › Responses

200

code

code

debug

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

messages

messages

title

title

OdxV2Cover

GET/cover/{slug}/

curl https://odkmedia.io/odx/api/v2/cover/:slug \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>'

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": {
    "contents": {
      "items": [
        {
          "call_to_action": "call_to_action",
          "content_id": 0,
          "content_sales_type": "GUEST",
          "content_slug": "content_slug",
          "content_type": "program",
          "description": "description",
          "episode_id": 0,
          "image": "image",
          "image_landscape": "image_landscape",
          "image_portrait": "image_portrait",
          "rolling_time": 0,
          "thumbnail": "thumbnail",
          "title": "title",
          "tracking": "tracking",
          "url": "url",
          "video": "video"
        }
      ]
    },
    "id": 0,
    "slug": "slug"
  }
}

json

application/json

contact-us curation

cover list

GET

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

/cover/

cover 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

cover 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

cover list › Responses

200

code

code

debug

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

messages

messages

listResult

title

title

cover retrieve

GET

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

/cover/{slug}/

The slug of ODK main banner: home-cover-default
The slug of ODK category page's banner: category-cover-{category_slug} (e.g. category-cover-drama)

cover retrieve › path Parameters

slug

string · required

cover retrieve › query Parameters

debug

string

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

cover retrieve › 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

cover retrieve › Responses

200

code

code

debug

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

messages

messages

title

title

OdxV2Cover