Мультиклиниковость

Мультиклиниковость (АПИ)

Структура моделей, назначение полей

Модель Сlinics — Список клиник, работающих в программе

The followings are the available columns in table 'clinics':

* @property integer $id
* @property string $title // Название
* @property string $address // Адрес
* @property string $phone // Телефон
* @property integer $city_id // Город
* @property string $start_time // Начало работы
* @property string $end_time // Конец работы
* @property string $internet_address // Интернет адрес
* @property integer $guest_client_id // Гостевой клиент
* @property string $time_zone // Часовой пояс, Region/City, например Europe/Moscow
* @property string $logo_url // Логотип
* @property string $status // ACTIVE или DELETED
* @property string $telegram
* @property string $whatsapp
* @property string $email

Модель clinicsToClients — Связь клиентов с клиниками

* @property integer $id
* @property integer $client_id // Клиент
* @property integer $clinic_id // Клиника

При создании клиента и счета программа сама записывает связь с клиникой. Клиника берется из clinic_id запроса. API-ключ один на весь домен.

Модель ClinicsToDocuments — Связь документов в программе с клиниками

* @property integer $id
* @property enum('invoice','store','cassa','medcard','vaccine') $document_name // Тип документа
* @property integer $document_id // ID документа
* @property integer $clinic_id // ID клиники

Примеры запросов

Общие сведения о запросах к API

Пример clinics

curl -i -H "Accept: application/json" -H "X-REST-API-KEY: ваш_ключ" https://example/rest/api/clinics/1


{
     "success": true,
     "message": "Record Retrieved Successfully",
     "data": {
          "totalCount": 1,
          "clinics": {
               "id": "1",
               "title": "Ветклиника \"Здоровье!\"",
               "address": "Шевченко 54 ",
               "phone": "1234568",
               "city_id": "253",
               "start_time": null,
               "end_time": null,
               "internet_address": "",
               "guest_client_id": "5484",
               "time_zone": "Europe/Kiev"
          }
     }
}

Пример clinicsToClients

curl -i -H "Accept: application/json" -H "X-REST-API-KEY: ваш_ключ" https://example/rest/api/clinicsToClients/1
{
     "success": true,
     "message": "Record Retrieved Successfully",
     "data": {
          "totalCount": 1,
          "clinicsToClients": {
               "id": "1",
               "client_id": "1",
               "clinic_id": "1"
          }
     }
}


Пример ClinicsToDocuments

curl -i -H "Accept: application/json" -H "X-REST-API-KEY: ваш_ключ" https://example/rest/api/clinicsToDocuments/1
{
     "success": true,
     "message": "Record Retrieved Successfully",
     "data": {
          "totalCount": 1,
          "clinicsToDocuments": {
               "id": "1",
               "document_name": "cassa",
               "document_id": "1",
               "clinic_id": "1"
          }
     }
}
Powered by