Skip to content
TomeCMSTomeCMSTomeCMS

Get header and footer navigation

GET
/api/v1/content/navigation
curl --request GET \
  --url 'https://example.com/api/v1/content/navigation?locale=th'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
locale
required
string
Allowed values: th en

Content locale.

Responses

Section titled “ Responses ”

200

Section titled “200”

Public navigation for one locale.

Media typeapplication/json
object
data
required
object
footer
required
Array<object>
<= 50 items
object
href
required
string
>= 1 characters <= 2048 characters
kind
required
string
Allowed values: home page custom
label
required
string
>= 1 characters <= 80 characters
newTab
required
boolean
header
required
Array<object>
<= 50 items
object
href
required
string
>= 1 characters <= 2048 characters
kind
required
string
Allowed values: home page custom
label
required
string
>= 1 characters <= 80 characters
newTab
required
boolean
meta
required
object
locale
required
string
Allowed values: th en
Example
{
  "data": {
    "footer": [
      {
        "kind": "home"
      }
    ],
    "header": [
      {
        "kind": "home"
      }
    ]
  },
  "meta": {
    "locale": "th"
  }
}

304

Section titled “304”

The cached representation is still current.

400

Section titled “400”

The request parameters are invalid.

Media typeapplication/problem+json
object
detail
required
string
>= 1 characters
instance
required
string
>= 1 characters <= 2048 characters
maintenance
object
backAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
heading
required
string
>= 1 characters
locale
required
string
Allowed values: th en
message
required
string
>= 1 characters
requestId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
integer
>= 400 <= 599
title
required
string
>= 1 characters
type
required
string
>= 1 characters <= 2048 characters
Example
{
  "maintenance": {
    "locale": "th"
  }
}

500

Section titled “500”

The request could not be completed.

Media typeapplication/problem+json
object
detail
required
string
>= 1 characters
instance
required
string
>= 1 characters <= 2048 characters
maintenance
object
backAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
heading
required
string
>= 1 characters
locale
required
string
Allowed values: th en
message
required
string
>= 1 characters
requestId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
integer
>= 400 <= 599
title
required
string
>= 1 characters
type
required
string
>= 1 characters <= 2048 characters
Example
{
  "maintenance": {
    "locale": "th"
  }
}

503

Section titled “503”

The content service is not ready, or the site is closed for maintenance; then maintenance carries what the owner wrote for visitors.

Media typeapplication/problem+json
object
detail
required
string
>= 1 characters
instance
required
string
>= 1 characters <= 2048 characters
maintenance
object
backAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
heading
required
string
>= 1 characters
locale
required
string
Allowed values: th en
message
required
string
>= 1 characters
requestId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
integer
>= 400 <= 599
title
required
string
>= 1 characters
type
required
string
>= 1 characters <= 2048 characters
Example
{
  "maintenance": {
    "locale": "th"
  }
}