Поля адреса

GET /v1/addresses/fields

Возвращает схему полей адреса — список всех допустимых полей с типами, признаками обязательности и доступности для записи.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/addresses/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/addresses/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
const fieldNames = Object.keys(data.fields)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Битрикс24 Тип RO Описание
typeId TYPE_ID number — Тип адреса. Обязательный, неизменяемый после создания
entityTypeId ENTITY_TYPE_ID number — Тип владельца адреса. Обязательный, неизменяемый после создания
entityId ENTITY_ID number — ID владельца адреса. Обязательный, неизменяемый после создания
address1 ADDRESS_1 string — Улица, дом, корпус, строение
address2 ADDRESS_2 string — Квартира, офис
city CITY string — Город
postalCode POSTAL_CODE string — Почтовый индекс
region REGION string — Район
province PROVINCE string — Область
country COUNTRY string — Страна
countryCode COUNTRY_CODE string — Код страны
locAddrId LOC_ADDR_ID number — Идентификатор адреса местоположения
anchorTypeId ANCHOR_TYPE_ID number да Тип сущности, к которой привязан адрес
anchorId ANCHOR_ID number да ID сущности, к которой привязан адрес

RO — поле доступно только для чтения. Колонка «Битрикс24» — имя того же поля в Битрикс24.

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "typeId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "TYPE_ID"
      },
      "entityTypeId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ENTITY_TYPE_ID"
      },
      "entityId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ENTITY_ID"
      },
      "address1": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Улица, дом, корпус, строение"
      },
      "address2": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Квартира / офис"
      },
      "city": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Город"
      },
      "postalCode": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Почтовый индекс"
      },
      "region": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Район"
      },
      "province": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Область"
      },
      "country": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Страна"
      },
      "countryCode": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "COUNTRY_CODE"
      },
      "locAddrId": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Идентификатор адреса местоположения"
      },
      "anchorTypeId": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ANCHOR_TYPE_ID"
      },
      "anchorId": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ANCHOR_ID"
      }
    }
  }
}

Пример ответа при ошибке

403 — у API-ключа нет скоупа crm:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

Поля typeId, entityTypeId, entityId — неизменяемые. Флаг isImmutable: true означает, что после создания адреса эти поля нельзя изменить. Они задают составной ключ и не передаются в теле запросов на обновление.

Смотрите также