Оновлення payment status та note для попереднього запису через Public API

У цій статті описано 2 методи Public API, які дозволяють оновити вже існуючий попередній запис: статус онлайн-оплати та примітку.

Матеріал нижче охоплює лише PATCH-методи. Для отримання access token, використання токена та базового сценарію інтеграції скористайтесь пов’язаними статтями наприкінці документа.

Для обох методів потрібен Bearer token зі scope: gambit:public:prerecord:write.

Зміст

Base URL та авторизація

Використовуйте домен Вашого медичного закладу як base URL:

https://<clinica-web-customer>.medakadem.com.ua

Для обох методів потрібно передавати Bearer token у заголовку запиту:

Authorization: Bearer <access_token>

1. Оновлення статусу оплати

PATCH /api/public/v1/prerecords/{id}/paymentStatus

Метод використовується для оновлення статусу онлайн-оплати вже існуючого попереднього запису.

Тіло запиту

Тіло запиту передається як об’єкт з одним полем value:

{
  "Value": 1
}

Підтримувані значення

  • 0 = NotPaid
  • 1 = Paid
  • null = очистити поточний статус оплати

Приклад запиту

curl --request PATCH \
  --url 'https://<clinica-web-customer>.medakadem.com.ua/api/public/v1/prerecords/123/paymentStatus' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "Value": 1
  }'

2. Оновлення примітки

PATCH /api/public/v1/prerecords/{id}/note

Метод використовується для оновлення примітки вже існуючого попереднього запису.

Тіло запиту

Тіло запиту передається як об’єкт з одним полем value:

{
  "Value": "Пацієнта потрібно попередньо набрати перед візитом"
}

Максимальна довжина примітки — 1000 символів.

Приклад запиту

curl --request PATCH \
  --url 'https://<clinica-web-customer>.medakadem.com.ua/api/public/v1/prerecords/123/note' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "Value": "Пацієнта потрібно попередньо набрати перед візитом"
  }'

Відповіді API

  • 200 OK — попередній запис успішно оновлено
  • 400 Bad Request — помилка валідації, наприклад примітка перевищує допустиму довжину
  • 401 Unauthorized — токен відсутній або недійсний
  • 403 Forbidden — у токена немає scope gambit:public:prerecord:write
  • 404 Not Found — попередній запис з указаним id не знайдено