The Language object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

language_code string required
language_name string required
enabled boolean

Default: true

flag string
based_on string
date_format string
time_format string
number_format string
first_day_of_the_week string
The Language object 
{
  "id": "language_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "language_code": "language_code_example",
  "language_name": "language_name_example",
  "enabled": true,
  "flag": "flag_example",
  "based_on": "based_on_example",
  "date_format": "2024-01-15",
  "time_format": "time_format_example",
  "number_format": "number_format_example",
  "first_day_of_the_week": "first_day_of_the_week_example"
}
GET /api/core/language/{id}

Retrieve a language

Retrieves the details of an existing language. Supply the unique language ID that was returned from a previous request.

Path parameters

id string required

The identifier of the language to retrieve.

Returns

Returns the language object if a valid identifier was provided.

GET /api/core/language/{id} 
curl https://api.overplane.dev/api/core/language/language_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "language_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "language_code": "language_code_example",
  "language_name": "language_name_example",
  "enabled": true,
  "flag": "flag_example",
  "based_on": "based_on_example",
  "date_format": "2024-01-15",
  "time_format": "time_format_example",
  "number_format": "number_format_example",
  "first_day_of_the_week": "first_day_of_the_week_example"
}
GET /api/core/language

List all languages

Returns a list of languages. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of language objects.

GET /api/core/language 
curl https://api.overplane.dev/api/core/language \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "language_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "language_code": "language_code_example",
      "language_name": "language_name_example",
      "enabled": true,
      "flag": "flag_example",
      "based_on": "based_on_example",
      "date_format": "2024-01-15",
      "time_format": "time_format_example",
      "number_format": "number_format_example",
      "first_day_of_the_week": "first_day_of_the_week_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/core/language

Create a language

Creates a new language object.

Body parameters

language_code string required
language_name string required
enabled boolean

Default: true

flag string
based_on string
date_format string
time_format string
number_format string
first_day_of_the_week string

Returns

Returns the newly created language object if the call succeeded.

POST /api/core/language 
curl https://api.overplane.dev/api/core/language \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"language_code":"language_code_example","language_name":"language_name_example"}'
Response 
{
  "id": "language_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "language_code": "language_code_example",
  "language_name": "language_name_example",
  "enabled": true,
  "flag": "flag_example",
  "based_on": "based_on_example",
  "date_format": "2024-01-15",
  "time_format": "time_format_example",
  "number_format": "number_format_example",
  "first_day_of_the_week": "first_day_of_the_week_example"
}
PATCH /api/core/language/{id}

Update a language

Updates the specified language by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the language to update.

Body parameters

language_code string
language_name string
enabled boolean

Default: true

flag string
based_on string
date_format string
time_format string
number_format string
first_day_of_the_week string

Returns

Returns the updated language object.

PATCH /api/core/language/{id} 
curl https://api.overplane.dev/api/core/language/language_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"language_code":"language_code_example","language_name":"language_name_example"}'
Response 
{
  "id": "language_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "language_code": "language_code_example",
  "language_name": "language_name_example",
  "enabled": true,
  "flag": "flag_example",
  "based_on": "based_on_example",
  "date_format": "2024-01-15",
  "time_format": "time_format_example",
  "number_format": "number_format_example",
  "first_day_of_the_week": "first_day_of_the_week_example"
}
DELETE /api/core/language/{id}

Delete a language

Permanently deletes a language. This cannot be undone.

Path parameters

id string required

The identifier of the language to delete.

Returns

Returns a confirmation that the language has been deleted.

DELETE /api/core/language/{id} 
curl https://api.overplane.dev/api/core/language/language_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "language_abc123",
  "deleted": true
}