Объекты продукта

Перечислить продукты

GET /(company_code)/v2/aol/product

Получить список доступных продуктов

Этот вызов не требует сессионного токена. Доступные продукты определяются переданным API-ключом.

Заголовки запроса:  

• Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>

URL-параметры запроса:  

• primary (boolean) – (Необязательно) Получить только основной продукт для клиентского приложения
• product_class (string) – (Необязательно) Код класса продукта, по которому фильтровать результаты, либо список кодов, разделенных запятыми

JSON-объект ответа:  

• status (string) – success или error
• data (array) – Объекты данных продукта
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных продукта

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля	Тип	Описание
mnemocode	string	Мнемокод продукта
product_class	string	Код класса продукта
name	string	Название продукта для отображения
status	string	Код статуса продукта: I (действует), C (закрыт) или S (приостановлен)
effective_date	string	Дата начала действия в формате ISO: YYYY-MM-DD
discontinue_date	string	Дата прекращения действия в формате ISO: YYYY-MM-DD
details	object	Данные информационного наполнения продукта для отображения
attributes	array	Объекты данных атрибутов продукта (см. ниже)
primary	boolean	Флаг, указывающий, основной ли это продукт для клиентского приложения

Поля данных атрибута

У каждого объекта из массива attributes в объекте данных продукта в ответе есть следующие поля:

Имя поля	Тип	Описание
seq	integer	Последовательный номер атрибута, от 1 до 20
label	string	Метка атрибута для отображения
value	string	Значение атрибута

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• request.validation.failed

Подробнее см. Коды ошибок.

Получить данные продукта

GET /(company_code)/v2/aol/product/(product_code)

Получить данные продукта

Этот вызов не требует сессионного токена. Доступные продукты определяются переданным API-ключом.

Заголовки запроса:  

• Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>

Параметры:

• product_code – Мнемокод запрашиваемого продукта

JSON-объект ответа:  

• status (string) – success или error
• data (object) – Объект данных продукта
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных продукта

Объект ответа data содержит следующие поля:

Имя поля	Тип	Описание
mnemocode	string	Мнемокод продукта
product_class	string	Код класса продукта
name	string	Название продукта для отображения
status	string	Код статуса продукта: I (действует), C (закрыт) или S (приостановлен)
effective_date	string	Дата начала действия в формате ISO: YYYY-MM-DD
discontinue_date	string	Дата прекращения действия в формате ISO: YYYY-MM-DD
details	object	Данные информационного наполнения продукта для отображения
attributes	array	Объекты данных атрибутов продукта (см. ниже)
primary	boolean	Флаг, указывающий, основной ли это продукт для клиентского приложения

Поля данных атрибута

У каждого объекта из массива attributes в объекте данных продукта в ответе есть следующие поля:

Имя поля	Тип	Описание
seq	integer	Последовательный номер атрибута, от 1 до 20
label	string	Метка атрибута для отображения
value	string	Значение атрибута

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• object.id.notfound

Подробнее см. Коды ошибок.

Обновить данные продукта

PUT /(company_code)/v2/aol/product/(product_code)

Обновить данные продукта

Все поля данных в JSON запроса необязательны, любое поле может быть опущено, если его значение не изменилось.

Если статус продукта равен S или C, возвращает код ошибки auth.restricted.

Заголовки запроса:  

• Authorization – Bearer <сессионный_токен>, либо Signature <подпись>

Параметры:

• product_code – Мнемокод продукта для обновления

JSON-объект запроса:  

• name (string/null) – (Необязательно) Название продукта
• attributes (array) – (Необязательно) Объекты данных атрибутов продукта (см. ниже)

JSON-объект ответа:  

• status (string) – success или error
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
• data (object) – Обновленный объект данных продукта

Поля данных атрибута в запросе

У каждого объекта в массиве запроса attributes есть следующие поля:

Имя поля	Тип	Описание
seq	integer	Последовательный номер атрибута, от 1 до 10
value	string	Новое значение атрибута

Последовательные номера атрибутов должны быть теми же, что в объектах атрибутов, возвращаемыми API в данных продукта.

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• auth.header.missing
• auth.header.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• auth.restricted
• object.id.notfound
• request.validation.failed

Подробнее см. Коды ошибок.

Перечислить комбинации продуктов

GET /(company_code)/v2/aol/product/(product_code)/combination

Перечислить комбинации продуктов

Этот вызов не требует сессионного токена. Доступные продукты определяются переданным API-ключом.

Параметры:

• product_code – Мнемокод запрашиваемого продукта

URL-параметры запроса:  

• foreign_product_class (string) – (Необязательно) Код внешнего класса продукта, по которому фильтровать результаты, либо список кодов, разделенных запятыми
• seq (integer/string) – (Необязательно) Последовательный номер комбинации, по которому фильтровать результаты, либо список номеров, разделенных запятыми

JSON-объект ответа:  

• status (string) – success или error
• data (array) – Объекты данных комбинаций продуктов
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных комбинации продуктов

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля	Тип	Описание
seq	integer	Последовательный номер комбинации
foreign_product	string	Мнемокод внешнего продукта
foreign_product_class	string	Код класса внешнего продукта
foreign_product_name	string	Название внешнего продукта
foreign_product_status	string	Код статуса внешнего продукта: I (действует), C (закрыт) или S (приостановлен)
details	object	Данные информационного наполнения комбинации продуктов для отображения
suspend_flag	boolean	Указывает, приостановлена ли комбинация продуктов

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• object.id.notfound
• request.validation.failed

Подробнее см. Коды ошибок.

Перечислить классы экземпляров

GET /(company_code)/v2/aol/product/(product_code)/entryclass

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

Некоторые из возвращаемых значений зависят от роли пользователя. Если этот вызов используется до аутентификации пользователя, его нужно выполнить снова для авторизованного пользователя.

Заголовки запроса:  

• Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>

Параметры:

• product_code – Мнемокод запрашиваемого продукта

URL-параметры запроса:  

• name (string) – (Необязательно) Название класса экземпляра, по которому фильтровать результаты, либо список названий, разделенных запятыми

JSON-объект ответа:  

• status (string) – success или error
• data (array) – Объекты данных классов экземпляров
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных класса экземпляра

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля	Тип	Описание
name	string	Название класса экземпляра
details	object	Данные информационного наполнения класса экземпляров для отображения
product	string	Мнемокод продукта
product_class	string	Код класса продукта
enabled_flag	boolean	Указывает, включен ли класс экземпляров
multiple_entry	boolean	Указывает, позволяет ли класс экземпляров профилю иметь более одного экземпляра
one_to_many	boolean	Указывает, позволяет ли класс экземпляров экземпляру иметь более одной привязки
signup_flag	boolean	Указывает, позволяет ли класс экземпляров пользователю регистрировать клиента для получения нового экземпляра
signup_disclaimers	array	Объекты данных юридических соглашений, которые пользователь должен принять для регистрации
enroll_flag	boolean	Указывает, позволяет ли класс экземпляров пользователю зачислять новый экземпляр клиенту
enroll_disclaimers	array	Массив объектов данных юридических соглашений, которые пользователь должен принять для зачисления
enroll_oauth_provider	integer/null	Идентификатор провайдера OAuth, используемого для зачисления нового экземпляра
entry_nr_mask	string/null	Маска (регулярное выражение) для проверки формата номера экземпляра
entry_nr_input_mask	string/null	Маска формата для поля ввода номера экземпляра в пользовательском интерфейсе
card_product_alt	string/null	Название продукта платежной карты для отображения
card_payment_org	string/null	Название организации платежной карты для отображения
tags	array	Имена меток, доступных для этого класса экземпляров, в виде строк

Поля соглашений

Каждый член массивов signup_disclaimers и enroll_disclaimers это объект со следующими полями:

Имя поля	Тип	Допускает null	Описание
code	string	Нет	Код соглашения
title	string	Нет	Название соглашения для отображения
description	string	Нет	Краткое описание соглашения
link	string	Нет	URL ссылки на текст юридического соглашения

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• auth.header.missing
• auth.header.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• object.id.notfound

Подробнее см. Коды ошибок.

Перечислить комбинации классов экземпляров

GET /(company_code)/v2/aol/product/(product_code)/entryclass/combination

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

Заголовки запроса:  

• Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>

Параметры:

• product_code – Мнемокод запрашиваемого продукта

URL-параметры запроса:  

• primary_entry_class (string) – (Необязательно) Название основного класса экземпляра, по которому фильтровать результаты, либо список названий, разделенных запятыми
• foreign_product (string) – (Необязательно) Мнемокод внешнего продукта, по которому фильтровать результаты, либо список мнемокодов, разделенных запятыми
• foreign_product_class (string) – (Необязательно) Код внешнего класса продукта, по которому фильтровать результаты, либо список кодов, разделенных запятыми

JSON-объект ответа:  

• status (string) – success или error
• data (array) – Объекты данных комбинаций классов экземпляров
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных комбинации классов экземпляра

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля	Тип	Описание
name	string	Название комбинации классов экземпляров
seq	integer	Последовательный номер комбинации
primary_entry_class	string	Название основного класса экземпляра
foreign_entry_class	string	Название внешнего класса экземпляра
foreign_product	string	Мнемокод внешнего продукта
foreign_product_class	string	Код класса внешнего продукта
details	object	Данные информационного наполнения комбинации классов экземпляров для отображения
options	array	Допустимые настройки распределения комбинации классов экземпляров
enabled_flag	boolean	Указывает, включена ли комбинация
primary_flag	boolean	Указывает, является ли комбинация основной для класса экземпляров

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• auth.header.missing
• auth.header.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• object.id.notfound

Подробнее см. Коды ошибок.

[УСТАРЕЛО] Перечислить комбинации классов экземпляров

GET /(company_code)/v2/aol/product/(product_code)/entryclass/(name)/combination

[УСТАРЕЛО] Получить данные доступных комбинаций классов экземпляров

Заголовки запроса:  

• Authorization – Bearer <сессионный_токен>, либо Signature <подпись>

Параметры:

• product_code – Мнемокод запрашиваемого продукта
• name – Название запрашиваемого класса экземпляров

URL-параметры запроса:  

• foreign_product_class (string) – (Необязательно) Код внешнего класса продукта, по которому фильтровать результаты, либо список кодов, разделенных запятыми

JSON-объект ответа:  

• status (string) – success или error
• data (array) – Объекты данных комбинаций классов экземпляров
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных комбинации классов экземпляра

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля	Тип	Описание
name	string	Название комбинации классов экземпляров
seq	integer	Последовательный номер комбинации
foreign_entry_class	object	Объект данных внешнего класса экземпляров
details	object	Данные информационного наполнения комбинации классов экземпляров для отображения
options	array	Допустимые настройки распределения комбинации классов экземпляров
enabled_flag	boolean	Указывает, включена ли комбинация
primary_flag	boolean	Указывает, является ли комбинация основной для класса экземпляров

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• auth.header.missing
• auth.header.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• object.id.notfound

Подробнее см. Коды ошибок.

Перечислить метки класса экземпляров

GET /(company_code)/v2/aol/product/(product_code)/entryclass/(name)/tag

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

Заголовки запроса:  

• Authorization – Bearer <сессионный_токен>, либо Signature <подпись>

Параметры:

• product_code – Мнемокод запрашиваемого продукта
• name – Название запрашиваемого класса экземпляров

URL-параметры запроса:  

• tag_name (string) – (Необязательно) Название метки, по которому фильтровать результаты, либо список названий, разделенных запятыми

JSON-объект ответа:  

• status (string) – success или error
• data (array) – Объекты данных меток класса экземпляров
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных метки класса экземпляра

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля	Тип	Описание
tag_name	string	Название метки
read_only_flag	boolean	Указывает, запрещено ли пользователю обновлять значения этой метки
values	array/null	Массив объектов допустимых значений. null означает, что принимается любое значение.

Поля данных значения

У каждого объекта в массиве values есть следующие поля:

Имя поля	Тип	Допускает null	Описание
code	string	Нет	Код значения
meaning	string	Нет	Текстовое описание значения

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• auth.header.missing
• auth.header.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• object.id.notfound

Подробнее см. Коды ошибок.

Calculate Conversion for Entry Class Combination

POST /(company_code)/v2/aol/product/(product_code)/entryclass/(entry_class_name)/combination/(combination_name)/calc

Calculate conversion result for Entry Class combination

Заголовки запроса:  

• Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>

Параметры:

• product_code – Mnemocode of product
• entry_class_name – Name of primary entry class of combination
• combination_name – Name of entry class combination

JSON-объект запроса:  

• amount (integer) – Amount (in one-hundredths) of currency to convert

JSON-объект ответа:  

• status (string) – success или error
• data (integer) – Resulting amount (in one-hundredths) of converted currency
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

• auth.apikey.missing
• auth.apikey.invalid
• auth.header.missing
• auth.header.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• object.id.notfound
• request.validation.failed

Подробнее см. Коды ошибок.