Получить реквизит по id crm.requisite.get

Scope: crm

Кто может выполнять метод: любой пользователь

Метод получает реквизит по его идентификатору id.

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

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

Название
тип

Описание

id*
integer

Идентификатор реквизита.

Идентификатор можно получить методом crm.requisite.list

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":27}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":27,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.get
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.get",
        		{
        			id: 27
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.get',
                    [
                        'id' => 27
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting requisite: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.get",
            {
                id: 27
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.get',
            [
                'id' => 27
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Ответ в случае успеха

HTTP-статус: 200

{
            "result": {
                "ID": "27",
                "ENTITY_TYPE_ID": "4",
                "ENTITY_ID": "1",
                "PRESET_ID": "1",
                "DATE_CREATE": "2024-05-29T18:05:49+02:00",
                "DATE_MODIFY": "",
                "CREATED_BY_ID": "1",
                "MODIFY_BY_ID": null,
                "NAME": "Организация",
                "CODE": null,
                "XML_ID": "5e4641fd-1dd9-11e6-b2f2-005056c00008",
                "ORIGINATOR_ID": null,
                "ACTIVE": "Y",
                "ADDRESS_ONLY": "N",
                "SORT": "500",
                "RQ_NAME": null,
                "RQ_FIRST_NAME": null,
                "RQ_LAST_NAME": null,
                "RQ_SECOND_NAME": null,
                "RQ_COMPANY_ID": null,
                "RQ_COMPANY_NAME": "ООО \"1С-БИТРИКС\"",
                "RQ_COMPANY_FULL_NAME": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"1С-БИТРИКС\"",
                "RQ_COMPANY_REG_DATE": "06.04.2007",
                "RQ_DIRECTOR": "РЫЖИКОВ СЕРГЕЙ ВЛАДИМИРОВИЧ",
                "RQ_ACCOUNTANT": null,
                "RQ_CEO_NAME": null,
                "RQ_CEO_WORK_POS": null,
                "RQ_CONTACT": null,
                "RQ_EMAIL": null,
                "RQ_PHONE": null,
                "RQ_FAX": null,
                "RQ_IDENT_TYPE": null,
                "RQ_IDENT_DOC": null,
                "RQ_IDENT_DOC_SER": null,
                "RQ_IDENT_DOC_NUM": null,
                "RQ_IDENT_DOC_PERS_NUM": null,
                "RQ_IDENT_DOC_DATE": null,
                "RQ_IDENT_DOC_ISSUED_BY": null,
                "RQ_IDENT_DOC_DEP_CODE": null,
                "RQ_INN": "7717586110",
                "RQ_KPP": "770501001",
                "RQ_USRLE": null,
                "RQ_IFNS": null,
                "RQ_OGRN": "5077746476209",
                "RQ_OGRNIP": null,
                "RQ_OKPO": null,
                "RQ_OKTMO": null,
                "RQ_OKVED": null,
                "RQ_EDRPOU": null,
                "RQ_DRFO": null,
                "RQ_KBE": null,
                "RQ_IIN": null,
                "RQ_BIN": null,
                "RQ_ST_CERT_SER": null,
                "RQ_ST_CERT_NUM": null,
                "RQ_ST_CERT_DATE": null,
                "RQ_VAT_PAYER": "N",
                "RQ_VAT_ID": null,
                "RQ_VAT_CERT_SER": null,
                "RQ_VAT_CERT_NUM": null,
                "RQ_VAT_CERT_DATE": null,
                "RQ_RESIDENCE_COUNTRY": null,
                "RQ_BASE_DOC": null,
                "RQ_REGON": null,
                "RQ_KRS": null,
                "RQ_PESEL": null,
                "RQ_LEGAL_FORM": null,
                "RQ_SIRET": null,
                "RQ_SIREN": null,
                "RQ_CAPITAL": null,
                "RQ_RCS": null,
                "RQ_CNPJ": null,
                "RQ_STATE_REG": null,
                "RQ_MNPL_REG": null,
                "RQ_CPF": null
            },
            "time": {
                "start": 1717078089.78188,
                "finish": 1717078090.270494,
                "duration": 0.4886140823364258,
                "processing": 0.09770989418029785,
                "date_start": "2024-05-30T16:08:09+02:00",
                "date_finish": "2024-05-30T16:08:10+02:00",
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
Object

Объект, содержащий значения полей реквизита

time
time

Информация о времени выполнения запроса

Ответ в случае ошибки

HTTP-статус: 400

{
            "error": "",
            "error_description": "The Requisite with ID '27' is not found"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Текст ошибки

Описание

Пустая строка

The Requisite with ID '27' is not found

Реквизит с указанным идентификатором не найден

Пустая строка

Access denied.

Недостаточно прав доступа для получения реквизита

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

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

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

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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