Метод используется для получения одностраничного списка атрибутов, доступных для создания аккаунта (см. Создание аккаунта). Метод возвращает следующую информацию для каждого доступного типа аккаунта (см. ):
-
Основные и дополнительные атрибуты аккаунта, для которых в настройках кастомизации установлен признак Отображать при создании клиента (см. ).
-
Требования к формату значений атрибутов.
GET {reseller_domain}/internal_api/new_account_attributes
В этой статье:
Авторизация
Требуется авторизация с помощью access token пользователя.
Аргументы
|
Название |
Тип параметра |
Тип данных |
Обязательный/
|
Описание |
|---|---|---|---|---|
|
Content-Type |
header |
string |
Обязательный |
Тип данных, передаваемых в запросе. Укажите application/vnd.api+json |
|
Accept |
header |
string |
Обязательный |
Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json |
|
X-Api-Locale |
header |
string |
Опциональный |
Двухбуквенный код языка данных в ответе |
|
Authorization |
header |
string |
Обязательный |
Действующий access token пользователя. Формат: |
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
|
filter[account_type_id] |
query |
string |
Опциональный |
Предназначен для фильтрации списка по ID типа аккаунта. Можно указать несколько значений через запятую |
Модель ответа
|
Название |
Тип данных |
Описание |
|||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
data |
array of objects |
Данные ответа |
|||||||||||||||
|
|
id |
string |
ID типа аккаунта |
||||||||||||||
|
|
type |
string |
Тип данных |
||||||||||||||
|
|
attributes |
object |
Информация об атрибутах для создания аккаунта указанного типа |
||||||||||||||
|
|
|
account_attributes |
array of objects |
Список атрибутов для создания аккаунта указанного типа |
|||||||||||||
|
|
|
|
name |
string |
Название атрибута |
||||||||||||
|
|
|
|
key |
string |
Ключ атрибута |
||||||||||||
|
|
|
|
optional |
bool |
Признак необязательности атрибута:
|
||||||||||||
|
|
|
|
type |
string |
Тип данных атрибута:
|
||||||||||||
|
|
|
|
available_values |
array |
Список допустимых значений:
|
||||||||||||
|
|
|
|
default_value |
зависит от атрибута |
Значение дополнительного атрибута по умолчанию |
||||||||||||
|
|
|
|
readonly |
bool |
Признак недоступности для изменения после создания аккаунта:
|
||||||||||||
|
|
|
|
category |
object |
Группа, к которой относится атрибут, в виде объекта:
|
||||||||||||
|
|
|
|
description |
string |
Описание атрибута |
||||||||||||
|
|
|
|
priority |
integer |
Приоритет отображения на странице со списком атрибутов (см.
) |
||||||||||||
|
|
|
|
helpful_description |
string |
Описание атрибута для отображения в виде подсказки на указанном языке (см.
) |
||||||||||||
|
|
|
|
custom_attribute |
bool |
Признак дополнительного атрибута: |
||||||||||||
|
|
|
|
autofill_organization |
bool |
Признак доступности сервиса автозаполнения для атрибута при создании аккаунта указанного типа (см. Сервис автозаполнения):
|
||||||||||||
|
|
|
|
format |
string |
Регулярное выражение для контроля указываемых значений дополнительного атрибута |
||||||||||||
|
meta |
object |
Дополнительная информация |
|||||||||||||||
|
|
server_current_time |
string |
Текущие дата и время сервера |
||||||||||||||
Пример запроса
curl --location --request GET 'https://test.activeplatform.com/internal_api/new_account_attributes' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'
Пример ответа
{
"data": [
{
"id": "1",
"type": "new_account_attributes",
"attributes": {
"name": "Business",
"key": "business",
"account_attributes": [
{
"name": "Zip",
"key": "zip",
"optional": false,
"type": "string",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 1,
"helpful_description": null,
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Company Name",
"key": "primary_name",
"optional": false,
"type": "string",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 2,
"helpful_description": null,
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Country",
"key": "country",
"optional": false,
"type": "list",
"available_values": [
{
"key": "AF",
"name": "Afghanistan"
},
{
"key": "AL",
"name": "Algeria"
}
],
"default_value": "AF",
"readonly": false,
"category": null,
"description": "",
"priority": 3,
"helpful_description": "",
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Region",
"key": "region",
"optional": false,
"type": "string",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 4,
"helpful_description": "",
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "City",
"key": "city",
"optional": false,
"type": "string",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 5,
"helpful_description": null,
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Street",
"key": "street",
"optional": false,
"type": "string",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 6,
"helpful_description": null,
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Phone",
"key": "phone",
"optional": false,
"type": "phone",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 9,
"helpful_description": null,
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Last name",
"key": "last_name",
"optional": false,
"type": "string",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 10,
"helpful_description": null,
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "First name",
"key": "first_name",
"optional": false,
"type": "string",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 11,
"helpful_description": null,
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Middle name",
"key": "middle_name",
"optional": true,
"type": "string",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 12,
"helpful_description": "",
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Email",
"key": "email",
"optional": false,
"type": "email",
"available_values": [],
"default_value": null,
"readonly": false,
"category": null,
"description": "",
"priority": 13,
"helpful_description": null,
"custom_attribute": false,
"autofill_organization": false
},
{
"name": "Date",
"key": "date",
"optional": true,
"type": "date",
"available_values": [],
"default_value": "",
"readonly": false,
"category": null,
"description": "",
"priority": 14,
"helpful_description": null,
"custom_attribute": true,
"autofill_organization": false,
"format": ""
},
{
"name": "Agree",
"key": "checkbox",
"optional": true,
"type": "checkbox",
"available_values": [
true,
false
],
"default_value": "",
"readonly": false,
"category": null,
"description": "",
"priority": 15,
"helpful_description": null,
"custom_attribute": true,
"autofill_organization": false,
"format": ""
},
{
"name": "Password",
"key": "pwd",
"optional": true,
"type": "password",
"available_values": [],
"default_value": "",
"readonly": false,
"category": {
"id": "2",
"name": "Microsoft"
},
"description": "",
"priority": 16,
"helpful_description": null,
"custom_attribute": true,
"autofill_organization": false,
"format": ""
}
]
}
}
],
"meta": {
"server_current_time": "2023-08-14T12:34:56.548945+0300"
}
}