Get Estate language versions

Resource type: estateLanguage

This API call allows you to retrieve all existing language versions of a real estate property from onOffice enterprise.

Description

In onOffice enterprise, real estate properties can be maintained in multiple languages. This call returns a complete list of all language versions associated with a property, including their individual record IDs, 3-letter ISO language codes, and an indicator for the primary (main) language record.

The call accepts either the ID of the main estate record or the ID of any sub-language version. Regardless of which ID is provided, the API automatically resolves to the main estate and returns all active language versions.

If the multilingual module is not active in onOffice enterprise, the API returns the system language as the property’s language version.

Request parameters

estateid INTEGER. MANDATORY. Unique ID (record number) of the main estate or any of its language versions.

Response values

meta.cntabsolute INTEGER. Total number of language versions existing for this estate.
records ARRAY. List of language version records for the specified property.
records[].id INTEGER. Unique ID (record number) of the specific language version record.
records[].type STRING. Resource type (always “estateLanguage”).
records[].elements.language STRING. 3-letter ISO language code (e.g., DEU, ENG, ESP, FRA). If no specific language version is set for the property (e.g., for single-language properties), the system language is returned automatically.
records[].elements.isMain BOOLEAN. true if this record is the primary/main language version, false otherwise.
records[].elements.mainLangId INTEGER. Unique ID of the main estate language record.

Example Request

{
  "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
  "resourceid": "",
  "identifier": "",
  "resourcetype": "estateLanguage",
  "parameters": {
    "estateid": 1261
  }
}

Example Response

{
  "status": {
    "code": 200,
    "errorcode": 0,
    "message": "OK"
  },
  "response": {
    "results": [
      {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "resourceid": "",
        "resourcetype": "estateLanguage",
        "cacheable": true,
        "identifier": "",
        "data": {
          "meta": {
            "cntabsolute": 14
          },
          "records": [
            {
              "id": 1261,
              "type": "estateLanguage",
              "elements": {
                "language": "DEU",
                "isMain": true,
                "mainLangId": 1261
              }
            },
            {
              "id": 1263,
              "type": "estateLanguage",
              "elements": {
                "language": "ENG",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1265,
              "type": "estateLanguage",
              "elements": {
                "language": "ESP",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1267,
              "type": "estateLanguage",
              "elements": {
                "language": "FRA",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1269,
              "type": "estateLanguage",
              "elements": {
                "language": "ITA",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1271,
              "type": "estateLanguage",
              "elements": {
                "language": "NLD",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1273,
              "type": "estateLanguage",
              "elements": {
                "language": "CHN",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1275,
              "type": "estateLanguage",
              "elements": {
                "language": "SAU",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1277,
              "type": "estateLanguage",
              "elements": {
                "language": "USA",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1279,
              "type": "estateLanguage",
              "elements": {
                "language": "RUS",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1281,
              "type": "estateLanguage",
              "elements": {
                "language": "PRT",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1283,
              "type": "estateLanguage",
              "elements": {
                "language": "JPN",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1285,
              "type": "estateLanguage",
              "elements": {
                "language": "CHE",
                "isMain": false,
                "mainLangId": 1261
              }
            },
            {
              "id": 1287,
              "type": "estateLanguage",
              "elements": {
                "language": "KOR",
                "isMain": false,
                "mainLangId": 1261
              }
            }
          ]
        },
        "status": {
          "errorcode": 0,
          "message": "OK"
        }
      }
    ]
  }
}

Notes

Automatic ID Resolution: You can pass the ID of any sub-language version to estateid. The API automatically resolves it to the main record ID and returns all associated language versions.
Single-Language Estates: If an estate has no additional language versions enabled, the call still returns status 200 OK with a single record (isMain: true and cntabsolute: 1).
Permissions: Read rights are checked against the main estate record. Having read access to the main estate provides access to query all its language versions.