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

Обновлено 11 марта 2025

POST

/info/subscriptions/allPreferencesUsage

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

Запрос

Header Parameters

RqUID

string

required

Возможные значения: <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

Уникальный идентификатор запроса

Sberx-System-Id
string
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Идентификатор внешней системы
Example: SUPERAPP
Sberx-Sub-System-Id
string
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Идентификатор внешней подсистемы
Example: SBER_PRIME

• application/json

Body

required

clientKeyType

string

Возможные значения: [SBER_ID, EPC_RB_ID, EPC_CB_ID, ERIB_ID, MDM_ID, DIALOG_ID, MOBILE_PHONE, EMAIL, ESIA_ID, SUB, CRM_ID, CRM_ID_NO_CLIENT]

Тип внешнего идентификатора потребителя (По умолчанию SUB)

clientKey

string

required

Значение должно соответствовать регулярному выражению ^[A-Fa-f0-9]{16,100}$

Внешний идентификатор клиента (Примечание: Допускается конвертация значения данного поля шлюзом интеграции при keyType = SUB)

dayBegin

date

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$

День начала периода включительно

dayEnd

date

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$

День завершения периода включительно

aggregatorIds

string[]

Возможные значения: <= 100

Перечень идентификаторов агрегаторов группы пакетов (При отсутствии производится поиск действующих подписок по всем агрегаторам)

paging

object

Параметры пагинации

page

int32

Возможные значения: >= 0 и <= 1000000

Номер страницы

size

int32

Возможные значения: >= 0 и <= 1000000

Количество элементов на странице

sorts

object[]

Possible values: <= 30

Параметры сортировки

Array [

field

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Наименование поля

direction

string

Возможные значения: [ASC, DESC]

Направление сортировки

]

Ответы

• 200
• 400
• 401
• 403
• 404
• 408
• 409
• 422
• 500
• 503

OK

• application/json

• Схема
• Пример из схемы

Schema

preferences

object[]

required

Possible values: <= 1000

Список представлений операций по подпискам клиента

Array [

packetOfferPrice

number

required

Возможные значения: >= 0 и <= 1000000

Базовая стоимость пакета

currentCalculatedPacketOfferPrice

number

Возможные значения: >= 0 и <= 1000000

Текущая расчетная стоимость следующего периода

currentCalculatedDiscountAmount

number

Возможные значения: >= 0 и <= 1000000

Сумма скидок которые могут быть применены к оплате следующего периода

currentCalculatedPaymentExpiredIncreaseDays

int32

Возможные значения: >= 0 и <= 2147483647

Количество дней которые могут быть применены к оплате следующего периода для его увеличения

currentPreferences

object[]

Possible values: <= 1000

Перечень акций которые могут быть применены к оплате следующего периода

Array [

system

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Мнемоническое наименование системы владельца акции

subSystem

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Мнемоническое наименование подсистемы владельца акции

id

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Z-_ ]{1,36}$

Идентификатор акционной компании

name

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Наименование акции преференции

article

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,100}$

Артикул ячейки корзины

]

appliedPreferences

object[]

required

Possible values: <= 1000

Перечень заказов с примененными преференциями

Array [

orderId

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Z-_ ]{1,32}$

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

authDate

string

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$

Дата время авторизации платежа

preferences

object[]

required

Possible values: <= 100

Перечень примененных преференций

Array [

system

string

required

Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$

Мнемоническое наименование системы владельца акции

subSystem

string

required

Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$

Мнемоническое наименование подсистемы владельца акции

id

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,36}$

Идентификатор акционной компании

name

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$

Наименование акции преференции

article

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Артикул ячейки корзины

utilizationAmount

number

required

Возможные значения: >= 0 и <= 1000000

Примененная к платежу сумма скидки

utilizationPaymentExpiredIncreaseDays

int32

required

Возможные значения: >= 0 и <= 1000000

Использованное в платеже количество дней прибавки к сроку действия подписки

]

]

]

page

object

Параметры пагинации

number

int32

required

Возможные значения: >= 0 и <= 1000000

Номер страницы

size

int32

required

Возможные значения: >= 0 и <= 2147483647

Количество элементов на странице

totalPages

int32

required

Возможные значения: >= 0 и <= 2147483647

Всего страниц

totalElements

int64

required

Возможные значения: >= 0 и <= 2147483647

Всего элементов

{
  "preferences": [
    {
      "packetOfferPrice": 123.25,
      "currentCalculatedPacketOfferPrice": 123.25,
      "currentCalculatedDiscountAmount": 123.25,
      "currentCalculatedPaymentExpiredIncreaseDays": 257,
      "currentPreferences": [
        {
          "system": "MASS_PERS",
          "subSystem": "BLOCK_C",
          "id": "54531d01-ec26-41c0-ada4-d0609080dbd9",
          "name": "700 Лет Тульскому прянику",
          "article": "32423243-32423"
        }
      ],
      "appliedPreferences": [
        {
          "orderId": "12321-12321",
          "authDate": "2019-03-12T23:34:12.456+0300",
          "preferences": [
            {
              "system": "MASS_PERS",
              "subSystem": "BLOCK_C",
              "id": "54531d01-ec26-41c0-ada4-d0609080dbd9",
              "name": "700 Лет Тульскому прянику",
              "article": "32423243-32423",
              "utilizationAmount": 1500,
              "utilizationPaymentExpiredIncreaseDays": 10
            }
          ]
        }
      ]
    }
  ],
  "page": {
    "number": 15,
    "size": 100,
    "totalPages": 38,
    "totalElements": 412
  }
}

Bad Request

• application/json

• Схема
• Пример из схемы

Schema

oneOf

• SberapiError
• HttpError

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 250 characters, Value must match regular expression ^(.*)$

Дополнительная информация

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{}

Unauthorized

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Forbidden

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Not Found

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Request Timeout

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Conflict

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Unprocessable Entity

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Internal Server Error

• application/json

• Схема
• Пример из схемы

Schema

oneOf

• SberapiError
• HttpError

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 250 characters, Value must match regular expression ^(.*)$

Дополнительная информация

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{}

Service Unavailable

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

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

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Loading...

Loading...