Skip to content

Language

a language and the user's proficiency in it
Type: object
Properties

name *

basic information about the language name
Required: yes
Any of

Variant 1

the name of the language, either in the language itself or in English; This form should be used when the language goes by one name.
Type: string

Variant 2

the structured name of the language; This form should be used to provide multiple names and a unique ID.
Type: object
Properties

id

the IETF BCP 47 language tag
Type: string

name *

endonym, i.e. the name of the language in the language itself
Type: string
Required: yes

englishName

English exonym, i.e. the name of the language in English
Type: string

speak

ability to speak using the language
Default: "no"

listen

ability to understand speech spoken in the language
Default: "no"

write

ability to write using the language
Default: "no"

read

ability to read text written in the language
Default: "no"
Examples
{
"name": "English"
}
{
"name": "हिन्दी",
"speak": "native",
"write": "professional_working",
"read": "professional_working"
}
{
"name": {
"id": "gu",
"name": "ગુજરાતી",
"englishName": "Gujarati"
},
"listen": "elementary"
}