Получить параметры карточки crm.contact.details.configuration.get

Scope: crm

Кто может выполнять метод:

• Любой пользователь имеет право получать свои и общие настройки
• Только администратор имеет право получать чужие настройки

Метод получает настройки карточки контактов: читает личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.

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

Обязательные параметры отмечены *

Примеры кодаПримеры кода

Как использовать примеры в документации

1. Получить личную конфигурацию карточки

   cURL (Webhook)

   cURL (OAuth)

   JS

   PHP

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"scope":"P","userId":6}' \
           https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.details.configuration.get
           

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"scope":"P","userId":6,"auth":"**put_access_token_here**"}' \
           https://**put_your_bitrix24_address**/rest/crm.contact.details.configuration.get
           

   BX24.callMethod(
               'crm.contact.details.configuration.get',
               {
                   scope: "P",
                   userId: 6,
               },
               (result) => {
                   result.error()
                       ? console.error(result.error())
                       : console.info(result.data())
                   ;
               },
           );
           

   require_once('crest.php');
           
           $result = CRest::call(
               'crm.contact.details.configuration.get',
               [
                   'scope' => 'P',
                   'userId' => 6
               ]
           );
           
           echo '<PRE>';
           print_r($result);
           echo '</PRE>';
           

2. Получить общую конфигурацию карточки

   cURL (Webhook)

   cURL (OAuth)

   JS

   PHP

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"scope":"C"}' \
           https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.details.configuration.get
           

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"scope":"C","auth":"**put_access_token_here**"}' \
           https://**put_your_bitrix24_address**/rest/crm.contact.details.configuration.get
           

   BX24.callMethod(
               'crm.contact.details.configuration.get',
               {
                   scope: "C",
               },
               (result) => {
                   result.error()
                       ? console.error(result.error())
                       : console.info(result.data())
                   ;
               },
           );
           

   require_once('crest.php');
           
           $result = CRest::call(
               'crm.contact.details.configuration.get',
               [
                   'scope' => 'C'
               ]
           );
           
           echo '<PRE>';
           print_r($result);
           echo '</PRE>';
           

Обработка ответаОбработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "name": "main",
                    "title": "О контакте",
                    "type": "section",
                    "elements": [
                        {
                            "name": "LAST_NAME",
                            "optionFlags": "0"
                        },
                        {
                            "name": "PHOTO",
                            "optionFlags": "0"
                        },
                        {
                            "name": "NAME",
                            "optionFlags": "1"
                        },
                        {
                            "name": "SECOND_NAME",
                            "optionFlags": "1"
                        },
                        {
                            "name": "BIRTHDATE",
                            "optionFlags": "1"
                        },
                        {
                            "name": "PHONE",
                            "optionFlags": "1",
                            "options": {
                                "defaultCountry": "AU"
                            }
                        },
                        {
                            "name": "EMAIL",
                            "optionFlags": "1"
                        }
                    ]
                },
                {
                    "name": "additional",
                    "title": "Дополнительно",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TYPE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "SOURCE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "OPENED",
                            "optionFlags": "0"
                        },
                        {
                            "name": "EXPORT",
                            "optionFlags": "0"
                        },
                        {
                            "name": "ASSIGNED_BY_ID",
                            "optionFlags": "0"
                        }
                    ]
                }
            ],
            "time": {
                "start": 1724677217.639681,
                "finish": 1724677217.986853,
                "duration": 0.3471717834472656,
                "processing": 0.01840806007385254,
                "date_start": "2024-08-26T15:00:17+02:00",
                "date_finish": "2024-08-26T15:00:17+02:00",
                "operating": 0
            }
        }
        

Возвращаемые значенияВозвращаемые значения

sectionsection

Описывает отдельно взятый раздел с полями внутри карточки элемента

section_elementsection_element

Конфигурация отдельно взятого поля внутри раздела

optionsoptions

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Продолжите изучениеПродолжите изучение

• Управление карточками контактов: обзор методов
• Установить параметры индивидуальной карточки crm.contact.details.configuration.set
• Установить общую карточку для всех пользователей crm.contact.details.configuration.forceCommonScopeForAll
• Сбросить параметры карточки crm.contact.details.configuration.reset