GET /docflows/{docflowId}

Метод позволяет получить описание документооборота.

Переменные

Название Тип Формат Обязательность Описание
docflowId string Guid true Идентификатор документооборота

Заголовки

Название Описание
If-None-Match Метка изменения документооорота. Если заголовок указан, то документооорот будет получен, если он был изменен позднее указанной в заголовке метки.
Authorization Заголовок авторизации

Пример

GET /realty/rosreestr/v2/docflows/1f3ba8ad-b868-46f2-9088-56aa2753bc88
Authorization: ReestroAuth apiKey=235dc85c-f7f9-4dc0-8bbf-dad9e0185afd&portal.orgid=1748b89b-7d34-4d47-b479-b06b40ab1a30
If-None-Match: 1543569295708

Ответы

200

Тело ответа

Описание документооборота получено. В теле ответа содержится описание документооборота Docflow.

Объект Declarant будет включать все реквизиты субъекта subject или представителя representative. Данные будут соответствовать тем, которые содержались в указанных объектах на момент отправки документооборота.

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

Название Описание
ETag Метка изменения документооорота
Content-Type Тип содержимого

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

  HTTP 200
  ETag: 1543569295708
  Content-Type: Application/json
{
  "docflowId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88",
  "docflowState": "Sent",
  "docflowType": "ObjectExtract",
  "creationDate": "2011-01-01T15:03:01.012345Z",
  "objectExtract":
  {
    "objectExtractType": "Base",
    "object":
    [
      {
        "cadastralNumber": "54:12:345814:45"
      }
    ]
  }
}

304

Документооборот не был изменен с указанной в заголовке If-None-Match метки.

400

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

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

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

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

401

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

403

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

404

Документооборот не найден.