Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Типы данных и форматы параметров в REST API», проанализируем лучшие практики и покажем, как правильно использовать битрикс в реальных задачах.

Типы данных и форматы параметров в REST API

Тут может не хватать некоторых данных — дополним в ближайшее время

TO-DO _не выгружается на prod_

• статья про часовые пояса и вычисление сдвига от сервера. проверить особенности в задачах и crm и ссылка на нее в блока с примечением
• статья о работе с файлами со всеми примерами, которые друг от друга отличаются из-за разного api и ссылка на нее в таблице
• статья про crm.status.list с подробностями о том, какие там значения лежат и как их правильно извлекать. ссылку на статью надо разместить в таблице типов
• статья про список валюты
• статья про список контактов
• статья про список компаний
• статья про список лидов
• статья про список компредов
• статья про работу с местоположениями
• статья про список дел таймлайна
• необходимо расписать структуру объекта типа time
• не хватает описания типов function, callable

Базовые типы данных {#standart-types}

{
    data: {
        foo: "bar",
        bar: "foo",
        items: [
            1,
            100,
            200,
        ]
    }
}

При работе с полями типов _date_ и _datetime_ обратите внимание, что у каждого пользователя в Битрикс24 может быть указан в настройках собственный часовой пояс. В пользовательском интерфейсе Битрикс24 показывает даты и время, адаптируя их под конкретного пользователя, однако на уровне API все даты и время хранятся с учетом параметров сервера. Читайте подробности в соответствующем материале.

Ссылки на объекты и справочники {#standart-objects}

Поля объектов Битрикс24 могут содержать значения, ссылающиеся на другие объекты или на значения из справочников. Технически такие значения, чаще всего, хранятся и указываются в виде целочисленных идентификаторов конкретных объектов или элементов справочников. Но для удобства и подчеркивания таких связей, в документации мы будем использовать специальные типы вроде _crm_company_ или _crm_status_. Ниже приводятся примеры таких типов со ссылками на методы получения возможных значений.

Справочники данных различных инструментов Битрикс24:

• CRM
• Интернет магазин
• Торговый каталог

Объект time {#time}

Объект time присутствует в ответах на все запросы к REST и содержит в себе информацию о времени выполнения запроса.