workplaces.workplace.address

Scope: workplaces

Кто может вызывать: Право чтения на элемент

Цепочка город / офис / комната + полная строка full.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
id int да ID места

Возвращаемые данные

result.result: { "city", "office", "room", "full" }

Обработка ошибок

Ответ в едином конверте модуля: result, total, next, error (внутри обёртки Bitrix REST — поле result). Справочник всех кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка
VALIDATION_ERROR Параметр id не передан или ≤ 0
WORKPLACE_NOT_FOUND Рабочее место не найдено
ACCESS_DENIED Нет прав на операцию или объект

Примеры кода

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.workplace.address.json?id=1234" \
          -H "Accept: application/json"
        

Пример ответа

{
          "result": {
            "result": {
              "city": "Москва",
              "office": "Офис K1",
              "room": "1 этаж",
              "full": "Москва / Офис K1 / 1 этаж / Место 1"
            },
            "next": null,
            "error": null
          },
          "total": 0
        }
        
Предыдущая