Метод для получения справочника

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

GET

/v1/dicts

Метод для получения справочника

Запрос

Query Parameters

name

string

Идентификатор справочника

Header Parameters

Authorization

string

required

Access token полученный через SSO

Ответы

• 200
• 400
• 401
• 403
• 404
• 429
• 500
• 503

Успешный ответ

• application/json

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

Schema

name

string

required

Идентификатор справочника

archive

string

required

zip-архив, зашифрованный в base64

{
  "name": "GenericLetterTyp",
  "archive": "string"
}

"Ошибка в запросе"

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request запроса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Ошибка валидации	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request запроса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

• application/json

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

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

"Не авторизован"

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• application/json

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

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

"Операция не может быть выполнена: доступ к ресурсу запрещен"

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция PAY_DOC_RU. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

• application/json

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

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Справочник с указанным идентификатором не найден

• application/json

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

Schema

cause

string

Тип ошибки

referenceId

uuid

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

{
  "cause": "string",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string",
  "checks": [
    {
      "level": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

"Превышен лимит запросов"

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• application/json

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

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

"Внутренняя ошибка сервера"

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• application/json

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

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

"Сервис временно недоступен"

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• application/json

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

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Loading...

Loading...