Отримати перелік із результатами по замовленню

Отримати перелік із результатами. Якщо не всі коди в замовлені вже оброблено і параметр forceAllowUnfinishedData != true - буде повернуто помилку 131.
Якщо перелік ще не був створений на сервері, або параметр forceRebuildFile = true - буде ініційовано створення переліку
Якщо параметр onlyGetInfo = true - ця функція незалежно від того готовий файл чи ні поверне стандартну структуру.
Якщо всі умови виконано та файл готовий, буде повернуто файл.

progress_state_text може бути "триває збір даних (XX%)"(1)/"файл створюється (XX%)"(2)/"файл готовий"(3)
для progress_state= 1,2 буде заповнено поле progress_state_percent
Для output_format = "json" видає архів із файлом json. Формат файлу : масив з структур виду
{ "data": {структура PersonStruct, див. /person/detail/information},
"code_requested": string "код"
"updated_datetime": datetime "час останнього оновлення даних"}
Якщр в даних зазначено updated_datetime, але поле data порожнє - це значить, що дані відсутні у реєстрі.
Якщо поле updated_datetime порожнє або менше ніж дата що залежить від параметру ensureValidOnDate з яким визивали функцію /company/request для цього заказу - це значить що оновлення ще не відбувалось (таке можливо якщо forceAllowUnfinishedData=true )

Request

Authorization

Add parameter in query

key

Example:

key: ********************

Query Params

request_number

string

required

номер замовлення (можна вказати декілька чрез кому)

forceAllowUnfinishedData

boolean

optional

створювати файл навіть якщо не всі дані готові

forceRebuildFile

boolean

optional

створювати новий файл навіть, якщо на сервері вже є готовий

onlyGetInfo

boolean

optional

не повертати файл - тільки інформацію. За вмовчанням false

output_format

string

optional

"xlsx"/"json" (умовч:xlsx)

language

string

optional

3 літ. ISO 639-1

key

string

optional

ключ доступу

Responses

🟢200Success

application/json

Body

answer

object

required

fileReady

boolean

required

файл готовий. застаріле - використовувати progress_state

fileCreating

boolean

required

файл створюється. застаріле - використовувати progress_state

progress_state_text

string

required

статус процесу

progress_state

integer | null

required

1-файл створюється,2-всі дані отримано,3-файл готовий

progress_state_percent

number | null

optional

відсоток виконання

status

enum<string>

required

Allowed values:

SuccessWarningError

statusCode

integer

required

message

string

optional

Example

{
    "status": "Success",
    "statusCode": 301,
    "message": "Перелік готовий",
    "answer": {
        "fileReady": true,
        "fileCreating": false,
        "progress_state": 3,
        "progress_state_text": "Файл готовий"
    }
}

🟢200File