List Languages

GET /languages
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/languages

Returns a list of Languages

query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,filed2
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
namestring
The name of the language. Example - Arabic.


Example: name="Arabic"
idstring
Unique id of the language. Example - ar.


Example: id=en
codestring
Two-letter, lowercase language code.


Example: code=en
code3string
Three-letter, lowercase language code.


Example: code3=eng
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ language ]
An array of all created items.
Language
Name
Description
codestring
Two-letter, lowercase language code.


Example: ar
code3string
Three-letter, lowercase language code.


Example: ara
idstring
A unique identifier generated by the Ocamba platform.


Example: ar
namestring
Language name.


Example: Arabic
totalinteger
A total number of items.


Example: 40
tip
1 Searchable field is name.
2 Sortable fields are: name, code, code3 and id.
3 Filterable fields are: id, name code and code3.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 40,
    "items": [
        {
            "id": "ar",
            "code": "ar",
            "code3": "ara",
            "name": "Arabic"
        },
        {
            "id": "bg",
            "code": "bg",
            "code3": "bul",
            "name": "Bulgarian"
        },
        {
            "id": "ca",
            "code": "ca",
            "code3": "cat",
            "name": "Catalan"
        }
    ]
}

{
  "total": 40,
  "items": [
    {
      "id": "ar",
      "code": "ar",
      "code3": "ara",
      "name": "Arabic"
    }
  ]
}