Запрос описания документооборота¶
Имя ресурса: /docflow/{docflowId}
HTTP метод: GET
Запрос документооборота позволяет получить события по конкретному запрашиваемому документообороту.
Осуществляется методом GET/docflows/{docflowId}
:
- docflowId: идентификатор документооборота.
Пример запроса
GET /realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417 HTTP/1.0
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d
При успешном поиске возвращается объект документооборота DocflowNewsItem в формате Json, где содержится метаинформация, параметры, указанные при генерации запроса (options).
DocflowNewsItem так же может содержать:
- Result - результат запроса в Росреестр
- Error - описание возникшей ошибки
- Requirements - описание действий, которые нужно совершить для продолжения обработки запроса
- Возможные HTTP-коды возврата:
- 200 - успешный поиск;
- 401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
- 403 - если для данного accountId доступ ограничен;
- 404 - отсутствие документооборота с указанным docflowId.