Use the /sapi/language endpoint (read-only) to inspect the configured set of languages for the publication. The most common use case is retrieving the id values needed when managing language-dependent entities such as subtitles (see /sapi/subtitle) and audio tracks (see /sapi/audiotrack).
1.0 | Language Object
1.1 | Example Language List Object
{
"type": "LanguageList",
"publicationid": "754",
"count": 6,
"items": [
{
"type": "Language",
"id": 2912,
"name": "English",
"publicationid": "754",
"createddate": "2021-03-03T14:10:32Z",
"updateddate": "2021-03-03T14:10:32Z",
"isocode": "en",
"countrycode": "US",
"isdefault": true,
"status": "published"
},
{
"type": "Language",
"id": 2911,
"name": "Français",
"publicationid": "754",
"createddate": "2021-03-03T14:10:31Z",
"updateddate": "2021-03-03T14:10:31Z",
"isocode": "fr",
"countrycode": "",
"isdefault": false,
"status": "published"
},
{
"type": "Language",
"id": 2913,
"name": "Español",
"publicationid": "754",
"createddate": "2021-03-03T14:10:32Z",
"updateddate": "2021-03-03T14:10:32Z",
"isocode": "es",
"countrycode": "ES",
"isdefault": false,
"status": "published"
}
]
}1.2 | Example Language Object
{
"type": "Language",
"id": 2912,
"name": "English",
"publicationid": "754",
"createddate": "2021-03-03T14:10:32Z",
"updateddate": "2021-03-03T14:10:32Z",
"isocode": "en",
"countrycode": "US",
"isdefault": true,
"status": "published"
}1.3 | LanguageList Attributes
| Parameter | Description |
|---|---|
type | (string) Type of object: "LanguageList". Read-only. |
publicationid | (string) Unique identifier of the publication. Read-only. |
count | (integer) Number of language objects returned. Read-only. |
items | (array) List of Language objects. Read-only. |
1.4 | Language Attributes
| Parameter | Description |
|---|---|
id | (integer) Unique identifier of the configured language in the publication. Read-only. |
type | (string) Type of object: "Language". Read-only. |
name | (string) Language name. Read-only. |
publicationid | (string) Unique identifier of the publication. Read-only. |
createddate | (string) ISO 8601 date/time the language was created. Read-only. |
updateddate | (string) ISO 8601 date/time the language was last updated. Read-only. |
isocode | (string) Two-letter ISO 639 language code. Read-only. |
countrycode | (string) Two-letter ISO 3166-1 alpha-2 country code. Read-only. |
isdefault | (boolean) true when the language is the publication’s default language. Read-only. |
status | (string) "draft" or "published". If a language is published, it will be publicly available. |
subtype | (string) Language subtype. "sign" identifies sign language entries. Omitted for standard spoken languages. Read-only. |
2.0 | Retrieve List
GET /sapi/language
Retrieves a list of languages.
3.0 | Retrieve
GET /sapi/language/{id}
Retrieves a single language object.