GET /checks

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

Заголовки

Название Описание
Authorization Заголовок авторизации

Параметры

Название Тип Формат Обязательность Описание
correlationId string ^\w{1,256} false Идентификатор группы
externalId string ^\w{1,256} false Клиентский идентификатор
subjectId string Guid false Идентификатор проверяемого субъекта
cadastralNumber string Guid false Идентификатор кадастрового номера, по которому заказана проверка
type string CheckType false Тип проверки. В одном запросе можно указывать несколько типов проверок
state string CheckState false Статус проверки
from date-time ISO 8601: YYYY-MM-DDTHH:MM.S& false Дата в формате ISO 8601. Если параметр указывается, то в результатах поиска будут получены проверки, созданные позднее указанной даты
to date-time ISO 8601: YYYY-MM-DDTHH:MM.S& false Дата в формате ISO 8601. Если параметр указывается, то в результатах поиска будут получены проверки, созданные ранее указанной даты
afterCheckId string Guid false Идентификатор проверки, после которой необходимо получить список. Если параметр указан, то в результатах поиска будут располагаться проверки, которые были созданы ранее указанной. Указанная проверка не будет содержаться в ответе
count string ^\d false Количество проверок, содержащееся в ответе. Максимальное значение 30. Значение по умолчанию 30

Если ни один из параметров не будет передан, то в ответе будет содержаться 30 последних созданных проверок.

Пример

  GET /realty/assessment/v1/checks?subjectId=3f813a2f-958b-499b-90c7-a038d98955c0
  Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c

Ответы

200

Тело ответа

Поиск прошел успешно. В теле ответа содержится:

Название Тип Формат Обязательность Описание
items array Check true Список найденных проверок
lastCheckId string Guid true Идентификатор последней проверки

Если по результатам поиска не было найдено ни одной проверки, удовлетворяющей заданным параметрам, то:

  • объект items будет содержать пустой массив;
  • поле lastCheckId будет отсутствовать.

Заголовки ответа

Название Описание
Content-Type Тип контента: application/json

Пример ответа

  HTTP 200
  Content-Type: Application/json
{
  "items":
  [
    {
      "checkId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
      "corelationId": "fc88aa01-c2f2-4498-bbb2-5c7218e69585",
      "externalId": "4f8e9e60-74f9-4e00-9fae-abf021ea0314",
      "creationDate": "2011-01-01T15:03:01.012345Z",
      "checkType": "Fssp",
      "checkState": "Processing",
      "fssp": {
        "subjectId": "3f813a2f-958b-499b-90c7-a038d98955c0",
        "regions": [
          "54",
          "77"
          ]
        }
      }
  ],
  "lastCheckId": "7720902d-b025-4d9b-92a1-288a61e09b9d"

]

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки Описание
WrongFieldValue Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message

Пример ответа

  HTTP 400
  Content-Type Application/json
  {
      "code": "validation",
      "message": "Failed to validate request",
      "target": "api",
      "errors":
      [
        {
          "code": "WrongFieldValue",
          "message": "subjectId should be guid",
          "target": "AssessmentApi"
        }
      ]
  }

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации