navigation

GET

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

/navigation/

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

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

200

code

code

debug

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

messages

messages

listResult

title

title

GET

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

/navigation/{slug}/

The slug of ODK header navigation: header-navigation-default

slug

string · required

debug

string

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

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

200

code

code

debug

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

messages

messages

title

title

OdxV2Navigation

GET/navigation/{slug}/

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

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": [
      {
        "background_image": "background_image",
        "link": "link",
        "og_image": "og_image",
        "ratio": "portrait",
        "seo_description": "seo_description",
        "seo_keywords": "seo_keywords",
        "seo_title": "seo_title",
        "slug": "slug",
        "title": "title",
        "type": "category",
        "items": [
          {
            "background_image": "background_image",
            "link": "link",
            "og_image": "og_image",
            "ratio": "portrait",
            "seo_description": "seo_description",
            "seo_keywords": "seo_keywords",
            "seo_title": "seo_title",
            "slug": "slug",
            "title": "title",
            "type": "category",
            "items": [
              {
                "background_image": "background_image",
                "link": "link",
                "og_image": "og_image",
                "ratio": "portrait",
                "seo_description": "seo_description",
                "seo_keywords": "seo_keywords",
                "seo_title": "seo_title",
                "slug": "slug",
                "title": "title",
                "type": "category",
                "items": [
                  {
                    "background_image": "background_image",
                    "link": "link",
                    "og_image": "og_image",
                    "ratio": "portrait",
                    "seo_description": "seo_description",
                    "seo_keywords": "seo_keywords",
                    "seo_title": "seo_title",
                    "slug": "slug",
                    "title": "title",
                    "type": "category"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "id": 0,
    "service_name": "odk",
    "slug": "slug"
  }
}

json

application/json

episode notice

navigation list

GET

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

/navigation/

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

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

200

code

code

debug

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

messages

messages

listResult

title

title

navigation retrieve

GET

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

/navigation/{slug}/

The slug of ODK header navigation: header-navigation-default

slug

string · required

debug

string

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

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

200

code

code

debug

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

messages

messages

title

title

OdxV2Navigation

navigation

navigation list

navigation list › query Parameters

navigation list › Headers

navigation list › Responses

navigation retrieve

navigation retrieve › path Parameters

navigation retrieve › query Parameters

navigation retrieve › Headers

navigation retrieve › Responses

navigation

navigation list

navigation list › query Parameters

navigation list › Headers

navigation list › Responses

navigation retrieve

navigation retrieve › path Parameters

navigation retrieve › query Parameters

navigation retrieve › Headers

navigation retrieve › Responses