Languages

Languages are the localizations of which data can exist in the PIM installation. If users shall be able to enter data in a specific culture, that language must be added to the system. All languages in the system are based on ISO Culture codes. Each ISO culture code can only be added once, meaning no two languages can use the same culture code

Get all languages added to the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/Languages

HTTPcURLJavaScriptPython

GET /v1/Languages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Id": 1,
    "CultureCode": "en-GB",
    "Name": "English",
    "SortOrder": 0
  },
  {
    "Id": 2,
    "CultureCode": "da-DK",
    "Name": "Danish",
    "SortOrder": 0
  },
  {
    "Id": 3,
    "CultureCode": "de-DE",
    "Name": "German",
    "SortOrder": 0
  }
]

Add language to system

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Model to add a language

CultureCodestring | nullableOptional

ISO 639-1 culture code

Namestring | nullableOptional

Presented name of language

SortOrderinteger · int32Optional

Sort order of language

Responses

200

OK

application/json

400

Bad Request

application/json

post

/v1/Languages

HTTPcURLJavaScriptPython

POST /v1/Languages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "CultureCode": "text",
  "Name": "text",
  "SortOrder": 1
}

{
  "CultureCode": "en-GB",
  "Name": "English",
  "SortOrder": 0
}

Update a language in the system

put

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Represents a language

Idinteger · int32Optional

Unique id of language

CultureCodestring | nullableOptional

Culture code of language

Namestring | nullableOptional

Presented name of language

SortOrderinteger · int32Optional

Sort order of language

Responses

200

OK

400

Bad Request

application/json

put

/v1/Languages

HTTPcURLJavaScriptPython

PUT /v1/Languages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "Id": 1,
  "CultureCode": "en-GB",
  "Name": "English (british)",
  "SortOrder": 0
}

No content

Delete a language in the system

delete

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

idinteger · int32Optional

Id of language

Responses

200

OK

400

Bad Request

application/json

delete

/v1/Languages

HTTPcURLJavaScriptPython

DELETE /v1/Languages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get a specific language in the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of language

Responses

200

OK

application/json

404

Not Found

application/json

get

/v1/Languages/{id}

HTTPcURLJavaScriptPython

GET /v1/Languages/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Id": 1,
  "CultureCode": "en-GB",
  "Name": "English",
  "SortOrder": 0
}