Объекты экземпляра продукта

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

GET /(company_code)/v2/aol/entry/(entry_code)

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

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код запрашиваемого экземпляра. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных экземпляра. Включаемые поля зависят от роли авторизованного пользователя.

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

  • 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

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

Обновить данные экземпляра

PUT /(company_code)/v2/aol/entry/(entry_code)

Обновить данные экземпляра

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

Если профиль экземпляра приостановлен, возвращает код ошибки auth.restricted.

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

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код экземпляра для обновления. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
JSON-объект запроса:
 
  • 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

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

Удалить экземпляр

DELETE /(company_code)/v2/aol/entry/(entry_code)

Аннулировать экземпляр

Если профиль экземпляра приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код удаляемого экземпляра. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных экземпляра

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

  • 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

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

Заменить экземпляр

POST /(company_code)/v2/aol/entry/(entry_code)/replace

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

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

Массив ответа data содержит объекты данных замененного и нового экземпляров.

Если экземпляр с переданным внешним идентификатором уже существует, возвращает код ошибки auth.restricted.

Если профиль экземпляра приостановлен, возвращает код ошибки auth.restricted.

Если класс экземпляров настроен для зачисления экземпляра с использованием OAuth, пользователи с ролью CLIENT должны передавать поля запроса oauth_code и oauth_redirect_uri вместо полей данных экземпляра. Выполняется проверка OAuth, и данные экземпляра получаются от провайдера OAuth.

Если провайдер OAuth возвращает тот же идентификатор пользователя OAuth, который используется в заменяемом экземпляре, возвращает код ошибки oauth.identifier.used.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код экземпляра для замены. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
JSON-объект запроса:
 
  • external_id (string) – (Необязательно) Идентификатор во внешней системе для нового экземпляра
  • entry_nr (string/null) – (Необязательно) Номер экземпляра
  • entry_date (string) – (Необязательно) Дата вступления в силу экземпляра
  • name (string/null) – (Необязательно) Название экземпляра для отображения
  • details (string/null) – (Необязательно) Текст описания экземпляра
  • attributes (array) – (Необязательно) Объекты данных атрибутов экземпляра (см. ниже)
  • oauth_code (string) – (Необязательно) Код OAuth в виде, полученном от провайдера OAuth
  • oauth_redirect_uri (string) – (Необязательно) URI перенаправления в виде, переданном провайдеру OAuth
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (array) – Объекты данных экземпляра. Включаемые поля зависят от роли авторизованного пользователя.

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

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

Имя поля Тип Описание
seq integer Последовательный номер атрибута, от 1 до 20
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.oauth.failed
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • oauth.identifier.used
  • object.id.notfound
  • request.validation.failed

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

Привязать внешний экземпляр

POST /(company_code)/v2/aol/entry/(entry_code)/attach

Привязать внешний экземпляр (создать привязку)

Если внешний экземпляр не найден или не принадлежит тому же профилю, что и основной экземпляр, возвращается код ошибки request.validation.failed.

Если профиль экземпляра приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код экземпляра для обновления. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
JSON-объект запроса:
 
  • foreign_entry_code (string) – Код внешнего экземпляра для привязки. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
  • allocation_option (string/null) – (Необязательно) Метод распределения бонусов
  • allocation_operator (string/null) – (Необязательно) Оператор сравнения для значения распределения
  • allocation_value (string/null) – (Необязательно) Значение распределения бонусов
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных экземпляра

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

  • 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

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

Отвязать внешний экземпляр

POST /(company_code)/v2/aol/entry/(entry_code)/detach

Отвязать внешний экземпляр (удалить привязки)

Если внешний экземпляр не найден или не принадлежит тому же профилю, что и основной экземпляр, возвращается код ошибки request.validation.failed.

Если профиль экземпляра приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код экземпляра для обновления. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
JSON-объект запроса:
 
  • foreign_entry_code (string) – Код внешнего экземпляра для отвязывания. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных экземпляра

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

  • 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

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

Удалить привязку экземпляров

DELETE /(company_code)/v2/aol/entry/(entry_code)/combination/(int: combination_id)

Удалить привязку экземпляров

Если профиль экземпляра приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код экземпляра для обновления. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
  • combination_id – Идентификатор удаляемой привязки
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных экземпляра

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

  • 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

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

Заменить привязку экземпляров

POST /(company_code)/v2/aol/entry/(entry_code)/combination/(int: combination_id)/replace

Заменить внешний экземпляр в привязки

Если внешний экземпляр не найден или не принадлежит тому же профилю, что и основной экземпляр, возвращается код ошибки request.validation.failed.

Если профиль экземпляра приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код экземпляра для обновления. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
  • combination_id – Идентификатор привязки для обновления
JSON-объект запроса:
 
  • foreign_entry_code (string) – Код внешнего экземпляра для привязки. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
  • allocation_option (string/null) – (Необязательно) Метод распределения бонусов
  • allocation_operator (string/null) – (Необязательно) Оператор сравнения для значения распределения
  • allocation_value (string/null) – (Необязательно) Значение распределения бонусов
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных экземпляра

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

  • 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

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

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

PUT /(company_code)/v2/aol/entry/(entry_code)/tag/(tag_name)

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

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код запрашиваемого экземпляра. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
  • tag_name – Название метки экземпляра для установки
JSON-объект запроса:
 
  • tag_date (string) – (Необязательно) Дата начала действия значения метки в формате ISO: YYYY-MM-DD
  • discontinue_date (string) – (Необязательно) Дата окончания действия значения метки в формате ISO: YYYY-MM-DD
  • value (string) – Значение метки
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных экземпляра

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

  • 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

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

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

DELETE /(company_code)/v2/aol/entry/(entry_code)/tag/(tag_name)

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

Если профиль экземпляра приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • entry_code – Код запрашиваемого экземпляра. Для всех пользователей принимается мнемокод экземпляра. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор экземпляра.
  • tag_name – Название метки экземпляра для установки
JSON-объект запроса:
 
  • discontinue_date (string) – (Необязательно) Дата окончания действия значения метки в формате ISO: YYYY-MM-DD
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных экземпляра

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

  • 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

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