Для використання API потрібні скоупи: "gambit:erp".
Якщо немає потрібних scope, то повертатиметься помилка - Code 403 Forbidden
За допомогою запитів по API можна виконувати такі дії з файлами:
1. Створити новий
Для завантаження файлів потрібно виконати кілька послідовних дій, а саме:
- виконати запит: POST: /api/erp/v1/patients/{patientId}/analysis/{analysisId}/files/initialize/{fileName}
де {patientId} унікальний ідентифікатор пацієнта, {analysisId} унікальний ідентифікатор аналізу, {fileName} назва файлу, який буде завантажено (унікальні ідентифікатори і назву файлу потрібно вносити без фігурних дужок). З пустим тілом запиту;
Responses:
При успішному виконані запиту повернеться - Code 200 Success
Якщо файл з таким іменем вже існує, то повернеться помилка - Code 409 Conflict
- в response body на попередній запит повернеться url (посилання на завантаження файлу). Щоб завантажити файл, потрібно взяти отриманий url і виконати запит PUT: {responseUrl}
де {responseUrl} url отриманий в попередньому кроці (url потрібно вносити без фігурних дужок). Тіло запиту - це сам файл;
Responses:
При успішному виконані запиту повернеться - Code 201 Success
- виконати запит POST: /api/erp/v1/patients/{patientId}/analysis/{analysisId}/files/{fileName}
де {patientId} унікальний ідентифікатор пацієнта, {analysisId} унікальний ідентифікатор аналізу, {fileName} назва файлу, який буде завантажено (унікальні ідентифікатори і назву файлу потрібно вносити без фігурних дужок). З пустим тілом запиту;
Responses:
При успішному виконані запиту повернеться - Code 200 Success
2. Отримати весь список файлів
Потрібно виконати запит GET: /api/erp/v1/patients/{patientId}/analysis/{analysisId}/files
де {patientId} унікальний ідентифікатор пацієнта, {analysisId} унікальний ідентифікатор аналізу (унікальні ідентифікатори потрібно вносити без фігурних дужок).
Example Value:
Responses:
При успішному виконані запиту повернеться - Code 200 Success
3. Статус відправки на e-mail/viber
Для можливості відправити файл на e-mail/viber потрібно поставити відповідний статус. Для цього потрібно виконати запит PATCH: /api/erp/v1/patients/{patientId}/analysis/{analysisId}/files/{id}
де {patientId} унікальний ідентифікатор пацієнта, {analysisId} унікальний ідентифікатор аналізу, {id} унікальний ідентифікатор файлу (унікальні ідентифікатори потрібно вносити без фігурних дужок). З параметром isSend=true (default значення при завантаженні файлу завжди isSend=false).
Responses:
При успішному виконані запиту повернеться - Code 200 Success
4. Видалити файл
Для видалення файлу потрібно виконати запит DELETE: /api/erp/v1/patients/{patientId}/analysis/{analysisId}/files/{id}
де {patientId} унікальний ідентифікатор пацієнта, {analysisId} унікальний ідентифікатор аналізу, {id} унікальний ідентифікатор файлу (унікальні ідентифікатори потрібно вносити без фігурних дужок).
Responses:
При успішному виконані запиту повернеться - Code 200 Success