API Архимед+
Версия v3
Примечание: Для доступа к методам интеграции необходимо отправлять GET/POST запросы на
https://newapi.archimed-soft.ru/api/v3/{method}?{ПАРАМЕТРЫ}
Примечание
Появилась новая версия API
Авторизация
Для выполнения методов необходима авторизация. Описание авторизации тут.
Таблица соответствия методов
Метод получения пациентов
Запрос "medcards"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/medcards?fields[]=id&fields[]=last_name&filters[0][field]=phone&filters[0][value]=1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "7",
"last_name": "Максимов",
"first_name": "Максим",
"middle_name": "Максимович",
"birthdate": "13.02.1990",
"phone": "1",
"gendertype": "0",
"creationdate": "11.10.2016",
"changedate": "05.04.2019 14:26:23",
"number": "2",
"work_name": "ООО \"Агропроммаш\"",
"office_name": "",
"profession": "Повар",
"phone1": "222",
"email": "",
"sms_send": 1,
"email_send": 0,
"registration_address": "г Казань ул. Мира д.2 кв.1",
"residence_address": "",
"doc_name": "Паспорт",
"doc_series": "9333",
"doc_number": "555555",
"doc_issue": "Отделением УФМС",
"doc_date": "21.05.2010"
},
{
"id": "514",
"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"birthdate": "13.04.1993",
"phone": "1",
"gendertype": "1",
"creationdate": "11.10.2016",
"changedate": "05.04.2019 14:26:23",
"number": "2",
"work_name": "ООО \"Агропроммаш\"",
"office_name": "",
"profession": "Инженер",
"phone1": "222",
"email": "",
"sms_send": 1,
"email_send": 0,
"registration_address": "г Казань ул. Мира д.2 кв.2",
"residence_address": "",
"doc_name": "Паспорт",
"doc_series": "9334",
"doc_number": "555556",
"doc_issue": "Отделением УФМС",
"doc_date": "22.05.2010"
}
],
"total": 2,
"page": 1,
"limit": 100
}
Где: |
data |
Найденные медкарты |
id |
Id пациента |
last_name |
Фамилия пациента |
first_name |
Имя пациента |
middle_name |
Отчество пациента |
phone |
Телефон пациента |
birthdate |
Дата рождения пациента |
gendertype |
Пол пациента: 0 - мужской, 1 - женский, 2 - неопределено |
creationdate |
Дата создания мед карты |
changedate |
Дата и время изменения мед карты |
number |
Номер медкарты |
work_name |
Место работы |
office_name |
Отделение |
profession |
Профессия |
phone1 |
Дополнительный телефон |
email |
Email |
sms_send |
Согласие на SMS-рассылку |
email_send |
Согласие на Email-рассылку |
registration_address |
Адрес регистрации |
residence_address |
Фактический адрес проживания |
doc_name |
Название документа |
doc_series |
Серия документа |
doc_number |
Номер документа |
doc_issue |
Кем выдан документ |
doc_date |
Когда выдан документ |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения пациента по id
Запрос "medcards/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/medcards/2?fields[]=id&fields[]=name
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "2",
"last_name": "Иванов",
"first_name": "Сергей",
"middle_name": "Анатольевич",
"birthdate": "23.12.1967",
"phone": "7953256544",
"gendertype": "0",
"creationdate": "11.10.2016",
"changedate": "05.04.2019 14:26:23",
"number": "3",
"work_name": "ООО \"Агропроммаш\"",
"office_name": "",
"profession": "Повар",
"phone1": "222",
"email": "",
"sms_send": 1,
"email_send": 0,
"registration_address": "г Казань ул. Мира д.2 кв.1",
"residence_address": "",
"doc_name": "Паспорт",
"doc_series": "9333",
"doc_number": "555555",
"doc_issue": "Отделением УФМС",
"doc_date": "21.05.2010"
}
Где: |
id |
Id пациента |
last_name |
Фамилия пациента |
first_name |
Имя пациента |
middle_name |
Отчество пациента |
phone |
Телефон пациента |
birthdate |
Дата рождения пациента |
gendertype |
Пол пациента: 0 - мужской, 1 - женский, 2 - неопределено |
creationdate |
Дата создания мед карты |
changedate |
Дата и время изменения мед карты |
number |
Номер медкарты |
work_name |
Место работы |
office_name |
Отделение |
profession |
Профессия |
phone1 |
Дополнительный телефон |
email |
Email |
sms_send |
Согласие на SMS-рассылку |
email_send |
Согласие на Email-рассылку |
registration_address |
Адрес регистрации |
residence_address |
Фактический адрес проживания |
doc_name |
Название документа |
doc_series |
Серия документа |
doc_number |
Номер документа |
doc_issue |
Кем выдан документ |
doc_date |
Когда выдан документ |
Метод создания мед карты пациента
Запрос "medcards (POST)"
Метод |
POST |
Параметры |
Название параметра |
Описание |
Обязательно |
last_name |
(POST) Фамилия пациента |
Да |
first_name |
(POST) Имя пациента |
Да |
middle_name |
(POST) Отчество пациента |
Нет |
birthdate |
(POST) Дата рождения пациента |
Да |
phone |
(POST) Телефон пациента |
Да |
phone_alt |
(POST) Дополнительный телефон пациента |
Нет |
email |
(POST) Email пациента |
Нет |
info_source_id |
(POST) Id источника информации |
Нет |
work_name |
(POST) Место работы пациента |
Нет |
profession |
(POST) Должность пациента |
Нет |
email_agree |
(POST) Согласие на Email-рассылку (0 - не выбрано, 1 - согласен, 2 - не согласен) |
Нет |
sms_agree |
(POST) Согласие на SMS-рассылку (0 - не выбрано, 1 - согласен, 2 - не согласен) |
Нет |
https://newapi.archimed-soft.ru/api/v3/medcards
Body:
{
"last_name": "Тестовый",
"first_name": "Пациент",
"middle_name": "Тестович",
"birthdate": "23.12.1967",
"phone": "+79555555555",
"phone_alt": "+79001232323",
"email": "email@mail.ru",
"info_source_id": 1,
"work_name": "Работа",
"profession": "Дожность",
"email_agree": 1,
"sms_agree": 2
}
В ответ на запрос Вы получите ответ в формате
JSON:
{
"status": "Ok",
"id": 1937
}
Где: |
status |
Статус |
id |
Id созданной мед карты |
error |
Код ошибки |
message |
Сообщение ошибки |
Метод получения талонов пациента
Запрос "medcards/{id}/talons"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/medcards/1/talons
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "306",
"patient_id": "170",
"patient_name": "Иванов Иван Иванович",
"patient_phone": "79993003295",
"begintime": "11:00:00",
"endtime": "12:00:00",
"date": "28.02.2020",
"datetime": "28.02.2020 11:00:00",
"doc_id": "11",
"status_id": "1",
"status": "Запись",
"creation_datetime": "27.02.2020 10:01:04",
"update_datetime": "27.02.2020 10:01:05",
"reception_type_id": "0",
"reception_type": "",
"com_status_id": "0",
"com_status": "",
"info_source_id": "0",
"info_source": "",
"record_type_id": "1",
"record_type": "По телефону"
},
{
"id": "307",
"patient_id": "170",
"patient_name": "Иванов Иван Иванович",
"patient_phone": "79993003295",
"begintime": "11:00:00",
"endtime": "12:00:00",
"date": "28.02.2020",
"datetime": "28.02.2020 11:00:00",
"doc_id": "11",
"status_id": "1",
"status": "Запись",
"creation_datetime": "27.02.2020 10:01:04",
"update_datetime": "27.02.2020 10:01:05",
"reception_type_id": "0",
"reception_type": "",
"com_status_id": "0",
"com_status": "",
"info_source_id": "0",
"info_source": "",
"record_type_id": "1",
"record_type": "По телефону"
}
],
"total": 94,
"page": 20,
"limit": 2
}
Где: |
data |
Данные |
data.id |
Id талона |
data.patient_id |
Id пациента |
data.patient_phone |
Телефон пациента |
data.begintime |
Начало приема |
data.endtime |
Конец приема |
data.date |
Дата приема |
data.datetime |
Дата и время |
data.doc_id |
Id доктора |
data.status_id |
Id статуса |
data.status |
Статус |
data.creation_datetime |
Дата и время создания |
data.update_datetime |
Дата и время изменения |
data.reception_type_id |
Id вида приема |
data.reception_type |
Наименование вида приема |
data.сomm_status_id |
Id коммуникационного статуса |
data.сomm_status |
Наименование коммуникационного статуса |
data.info_source_id |
Id источника информации |
data.info_source |
Наименование источника информации |
data.record_type_id |
Id типа записи |
data.record_type |
Наименование типа записи |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения докторов
Запрос "doctors"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/doctors?limit=2
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"last_name": "Андреев",
"first_name": "Петр",
"middle_name": "Сергеевич",
"type": "Врач УЗИ",
"code": "",
"max_time": "30",
"phone": "79164143428",
"snils": "",
"info": "",
"zone_id": 1,
"zone": "Участок №1",
"branch_id": 1,
"branch": "Неврология 1",
"scientific_degree_id": 2,
"scientific_degree": "д.м.н"
},
{
"id": "6",
"last_name": "Администратор",
"first_name": "Николай",
"middle_name": "Николаевич",
"type": "Администратор",
"code": "",
"max_time": "30",
"phone": "89654563211",
"snils": "",
"info": "",
"zone_id": null,
"zone": "",
"branch_id": 8,
"branch": "Терапия 1",
"scientific_degree_id": null,
"scientific_degree": ""
}
],
"total": 23,
"page": 1,
"limit": "2"
}
Где: |
data |
Доктора |
id |
Id доктора |
last_name |
Фамилия доктора |
first_name |
Имя доктора |
middle_name |
Отчество доктора |
type |
Специализация доктора |
code |
Код врача |
max_time |
Время приема по умолчанию (в минутах) |
phone |
Телефон |
snils |
СНИЛС |
info |
Дополнительная информация |
zone_id |
Id участка |
zone |
Название участка |
branch_id |
Id отделения |
branch |
Отделение |
scientific_degree_id |
Id ученой степени |
scientific_degree |
Ученая степень |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения доктора по id
Запрос "doctors/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/doctors/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"last_name": "Андреев",
"first_name": "Петр",
"middle_name": "Сергеевич",
"type": "Врач УЗИ",
"code": "",
"max_time": "30",
"phone": "79164143428",
"snils": "",
"info": "",
"zone_id": 1,
"zone": "Участок №1",
"branch_id": 1,
"branch": "Неврология 1",
"scientific_degree_id": 2,
"scientific_degree": "д.м.н"
}
Где: |
id |
Id доктора |
last_name |
Фамилия доктора |
first_name |
Имя доктора |
middle_name |
Отчество доктора |
type |
Специализация доктора |
code |
Код врача |
max_time |
Время приема по умолчанию (в минутах) |
phone |
Телефон |
snils |
СНИЛС |
info |
Дополнительная информация |
zone_id |
Id участка |
zone |
Название участка |
branch_id |
Id отделения |
branch |
Отделение |
scientific_degree_id |
Id ученой степени |
scientific_degree |
Ученая степень |
Метод получения талонов доктора
Запрос "doctors/{id}/talons"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/doctors/1/talons
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "306",
"patient_id": "170",
"patient_name": "Иванов Иван Иванович",
"patient_phone": "79993003295",
"begintime": "11:00:00",
"endtime": "12:00:00",
"date": "28.02.2020",
"datetime": "28.02.2020 11:00:00",
"doc_id": "11",
"status_id": "1",
"status": "Запись",
"creation_datetime": "27.02.2020 10:01:04",
"update_datetime": "27.02.2020 10:01:05",
"reception_type_id": "0",
"reception_type": "",
"com_status_id": "0",
"com_status": "",
"info_source_id": "0",
"info_source": "",
"record_type_id": "1",
"record_type": "По телефону"
},
{
"id": "307",
"patient_id": "170",
"patient_name": "Иванов Иван Иванович",
"patient_phone": "79993003295",
"begintime": "11:00:00",
"endtime": "12:00:00",
"date": "28.02.2020",
"datetime": "28.02.2020 11:00:00",
"doc_id": "11",
"status_id": "1",
"status": "Запись",
"creation_datetime": "27.02.2020 10:01:04",
"update_datetime": "27.02.2020 10:01:05",
"reception_type_id": "0",
"reception_type": "",
"com_status_id": "0",
"com_status": "",
"info_source_id": "0",
"info_source": "",
"record_type_id": "1",
"record_type": "По телефону"
}
],
"total": 94,
"page": 20,
"limit": 2
}
Где: |
data |
Данные |
data.id |
Id талона |
data.patient_id |
Id пациента |
data.patient_phone |
Телефон пациента |
data.begintime |
Начало приема |
data.endtime |
Конец приема |
data.date |
Дата приема |
data.datetime |
Дата и время |
data.doc_id |
Id доктора |
data.status_id |
Id статуса |
data.status |
Статус |
data.creation_datetime |
Дата и время создания |
data.update_datetime |
Дата и время изменения |
data.reception_type_id |
Id вида приема |
data.reception_type |
Наименование вида приема |
data.сomm_status_id |
Id коммуникационного статуса |
data.сomm_status |
Наименование коммуникационного статуса |
data.info_source_id |
Id источника информации |
data.info_source |
Наименование источника информации |
data.record_type_id |
Id типа записи |
data.record_type |
Наименование типа записи |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения талонов
Запрос "talons"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/talons
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "306",
"patient_id": "170",
"patient_name": "Иванов Иван Иванович",
"patient_phone": "79993003295",
"begintime": "11:00:00",
"endtime": "12:00:00",
"date": "28.02.2020",
"datetime": "28.02.2020 11:00:00",
"doc_id": "11",
"status_id": "1",
"status": "Запись",
"creation_datetime": "27.02.2020 10:01:04",
"update_datetime": "27.02.2020 10:01:05",
"reception_type_id": "0",
"reception_type": "",
"com_status_id": "0",
"com_status": "",
"info_source_id": "0",
"info_source": "",
"record_type_id": "1",
"record_type": "По телефону"
},
{
"id": "307",
"patient_id": "170",
"patient_name": "Иванов Иван Иванович",
"patient_phone": "79993003295",
"begintime": "11:00:00",
"endtime": "12:00:00",
"date": "28.02.2020",
"datetime": "28.02.2020 11:00:00",
"doc_id": "11",
"status_id": "1",
"status": "Запись",
"creation_datetime": "27.02.2020 10:01:04",
"update_datetime": "27.02.2020 10:01:05",
"reception_type_id": "0",
"reception_type": "",
"com_status_id": "0",
"com_status": "",
"info_source_id": "0",
"info_source": "",
"record_type_id": "1",
"record_type": "По телефону"
}
],
"total": 94,
"page": 20,
"limit": 2
}
Где: |
data |
Данные |
data.id |
Id талона |
data.patient_id |
Id пациента |
data.patient_phone |
Телефон пациента |
data.begintime |
Начало приема |
data.endtime |
Конец приема |
data.date |
Дата приема |
data.datetime |
Дата и время |
data.doc_id |
Id доктора |
data.status_id |
Id статуса |
data.status |
Статус |
data.creation_datetime |
Дата и время создания |
data.update_datetime |
Дата и время изменения |
data.reception_type_id |
Id вида приема |
data.reception_type |
Наименование вида приема |
data.сomm_status_id |
Id коммуникационного статуса |
data.сomm_status |
Наименование коммуникационного статуса |
data.info_source_id |
Id источника информации |
data.info_source |
Наименование источника информации |
data.record_type_id |
Id типа записи |
data.record_type |
Наименование типа записи |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения талона по id
Запрос "talons/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/talons/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "306",
"patient_id": "170",
"patient_name": "Иванов Иван Иванович",
"patient_phone": "79993003295",
"begintime": "11:00:00",
"endtime": "12:00:00",
"date": "28.02.2020",
"datetime": "28.02.2020 11:00:00",
"doc_id": "11",
"status_id": "1",
"status": "Запись",
"creation_datetime": "27.02.2020 10:01:04",
"update_datetime": "27.02.2020 10:01:05",
"reception_type_id": "0",
"reception_type": "",
"com_status_id": "0",
"com_status": "",
"info_source_id": "0",
"info_source": "",
"record_type_id": "1",
"record_type": "По телефону"
}
Где: |
id |
Id талона |
patient_id |
Id пациента |
patient_phone |
Телефон пациента |
begintime |
Начало приема |
endtime |
Конец приема |
date |
Дата приема |
datetime |
Дата и время |
doc_id |
Id доктора |
status_id |
Id статуса |
status |
Статус |
creation_datetime |
Дата и время создания |
update_datetime |
Дата и время изменения |
reception_type_id |
Id вида приема |
reception_type |
Наименование вида приема |
сomm_status_id |
Id коммуникационного статуса |
сomm_status |
Наименование коммуникационного статуса |
info_source_id |
Id источника информации |
info_source |
Наименование источника информации |
record_type_id |
Id типа записи |
record_type |
Наименование типа записи |
Метод обновления талона по id
Запрос "talons/{id} (PUT)"
Метод |
PUT |
Параметры |
Название параметра |
Описание |
Обязательно |
status_id |
(BODY) Id статуса |
Да |
https://newapi.archimed-soft.ru/api/v3/talons/1
Body:
{
"status_id": 1
}
В ответ на запрос Вы получите ответ в формате
JSON:
{
"status": "success"
}
Где: |
status |
Статус операции: success|error |
reason |
Причина ошибки |
Метод создания талона
Запрос "talons (POST)"
Метод |
POST |
Параметры |
Название параметра |
Описание |
Обязательно |
doc_id |
(POST) Id врача |
Да |
begintime |
(POST) Время начала приема, в формате hh:mm |
Да |
endtime |
(POST) Время окончания приема, в формате hh:mm. Рассчитывается автоматически при пустом значении |
Нет |
date |
(POST) Дата приема, в формате DD.MM.YYYY |
Да |
last_name |
(POST) Фамилия пациента, не обязателелен при передаче patient_id |
Условно обязателен |
first_name |
(POST) Имя пациента, не обязателелен при передаче patient_id |
Условно обязателен |
middle_name |
(POST) Отчество пациента |
Нет |
birthdate |
(POST) Дата рождения пациента, не обязателелен при передаче patient_id |
Условно обязателен |
phone |
(POST) Телефон пациента, не обязателелен при передаче patient_id |
Условно обязателен |
email |
(POST) Email пациента |
Нет |
info |
(POST) Примечание |
Нет |
patient_id |
(POST) Id пациента |
Нет |
status_id |
(POST) Id статуса талона |
Нет |
info_source_id |
(POST) Id источника информации |
Нет |
reception_type_id |
(POST) Id вида приема |
Нет |
com_status_id |
(POST) Id коммуникационного статуса |
Нет |
record_type_id |
(POST) Id типа записи |
Нет |
email_agree |
(POST) Согласие на Email-рассылку (0 - не выбрано, 1 - согласен, 2 - не согласен) |
Нет |
sms_agree |
(POST) Согласие на SMS-рассылку (0 - не выбрано, 1 - согласен, 2 - не согласен) |
Нет |
https://newapi.archimed-soft.ru/api/v3/talons
Body:
{
"doc_id": 1,
"begintime": "11:00",
"endtime": "12:00",
"date": "13.11.2020",
"last_name": "Тестова",
"first_name": "Тест",
"middle_name": "Тестовна",
"birthdate": "01.01.1999",
"phone": "+79555555555",
"email": "email@mail.ru",
"info": "hello",
"patient_id": "",
"status_id": 2,
"info_source_id": 3,
"reception_type_id": 3,
"com_status_id": 4,
"record_type_id": 5,
"email_agree": 1,
"sms_agree": 2
}
В ответ на запрос Вы получите ответ в формате
JSON:
{
"status": "Ok",
"talon_id": "1937"
}
Где: |
status |
Статус |
talon_id |
Id созданного талона |
error |
Код ошибки |
message |
Сообщение ошибки |
Метод получения статусов талона
Запрос "talonstatuses"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/talonstatuses
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"name": "Запись"
},
{
"id": "2",
"name": "Прибыл"
},
{
"id": "3",
"name": "Убыл"
},
{
"id": "4",
"name": "Отмена"
},
{
"id": "5",
"name": "Долг"
}
],
"total": 5,
"page": 1,
"limit": 100
}
Где: |
data |
Данные |
data.id |
Id статуса |
data.name |
Название статуса |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения статуса талона по id
Запрос "talonstatuses/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/talonstatuses/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"name": "Запись"
}
Где: |
id |
Id статуса |
name |
Название статуса |
Метод получения услуг
Запрос "services"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/services
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"kind": 1,
"code": "N-000003",
"name": "Антисептическое средство",
"altcode": " ",
"altname": " ",
"barcode": " ",
"info": "",
"group_name": "Материалы",
"group_id": "83",
"mz_code": "",
"cito_cost": 0,
"duration": 0,
"base_cost": 5,
"purchase_price": 0,
"denomination": 0,
"unit_id": 5,
"unit": "г"
}
],
"total": 1,
"page": 1,
"limit": 100
}
Где: |
data |
Данные |
data.id |
Id услуги |
data.kind |
Тип позиции: 0 - Услуга, 1 - Товар, 2 - Сертификат, 3 - Абонемент, 4 - Бонусная карта |
data.code |
Код услуги |
data.name |
Название услуги |
data.altcode |
Альтернативный код услуги |
data.altname |
Альтернативное наименование |
data.barcode |
Штрихкод |
data.info |
Информация |
data.group_id |
Id группы |
data.group_name |
Название группы |
data.mz_code |
Код услуги (МЗ) |
data.cito_cost |
Цена CITO |
data.duration |
Продолжительность в минутах |
data.base_cost |
Базовая стоимость |
data.purchase_price |
Цена закупки |
data.denomination |
Номинал сертификата |
data.unit_id |
Id единицы измерения товара |
data.unit |
Единица измерения товара |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения услуги по id
Запрос "services/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/services/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"kind": 1,
"code": "N-000003",
"name": "Антисептическое средство",
"altcode": " ",
"altname": " ",
"barcode": " ",
"info": "",
"group_name": "Материалы",
"group_id": "83",
"mz_code": "",
"cito_cost": 0,
"duration": 0,
"base_cost": 5,
"purchase_price": 0,
"denomination": 0,
"unit_id": 5,
"unit": "г"
}
Где: |
id |
Id услуги |
kind |
Тип позиции: 0 - Услуга, 1 - Товар, 2 - Сертификат, 3 - Абонемент, 4 - Бонусная карта |
code |
Код услуги |
name |
Название услуги |
altcode |
Альтернативный код услуги |
altname |
Альтернативное наименование |
barcode |
Штрихкод |
info |
Информация |
group_id |
Id группы |
group_name |
Название группы |
mz_code |
Код услуги (МЗ) |
cito_cost |
Цена CITO |
duration |
Продолжительность в минутах |
base_cost |
Базовая стоимость |
purchase_price |
Цена закупки |
denomination |
Номинал сертификата |
unit_id |
Id единицы измерения товара |
unit |
Единица измерения товара |
Метод получения групп услуг
Запрос "groupservices"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/groupservices
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "2",
"code": "2",
"name": "Исследования, анализы, функциональная диагностика, манипуляции",
"owner": "0",
"order_index": "00_01"
},
{
"id": "3",
"code": "2.1",
"name": "Анализы",
"owner": "2",
"order_index": "01_00"
}
],
"total": 13,
"page": 1,
"limit": 3
}
Где: |
data |
Данные |
data.id |
Id группы |
data.code |
Код группы |
data.name |
Название группы |
data.owner |
Id родителя группы (при отсутствии 0) |
data.order_index |
Номер по порядку |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения группы услуг по id
Запрос "groupservices/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/groupservices/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"code": "1",
"name": "Специалисты",
"owner": "0",
"order_index": "00_00"
}
Где: |
id |
Id группы |
code |
Код группы |
name |
Название группы |
owner |
Id родителя группы (при отсутствии 0) |
order_index |
Номер по порядку |
Метод получения корпусов
Запрос "buildings"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/buildings
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"name": "Корпус 1",
"address": "ул. Космонавтов, 41"
},
{
"id": "3",
"name": "Корпус 2",
"address": "ул. Ямашева, 1"
}
],
"total": 2,
"page": 1,
"limit": 100
}
Где: |
data |
Данные |
data.id |
Id корпуса |
data.name |
Наименование корпуса |
data.address |
Адрес |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения корпуса по id
Запрос "buildings/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/buildings/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"name": "Корпус 1",
"address": "ул. Космонавтов, 41"
}
Где: |
id |
Id корпуса |
name |
Наименование корпуса |
address |
Адрес |
Метод получения специализаций
Запрос "specializations"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/specializations
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"name": "Терапевт"
},
{
"id": "3",
"name": "Массажист"
}
],
"total": 43,
"page": 1,
"limit": 2
}
Где: |
data |
Данные |
data.id |
Id специализации |
data.name |
Наименование специализации |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения специализации по id
Запрос "specializations/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/specializations/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"name": "Терапевт"
}
Где: |
id |
Id специализации |
name |
Наименование специализации |
Метод получения виды приема
Запрос "talonreceptiontypes"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/talonreceptiontypes
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"name": "Консультация"
},
{
"id": "2",
"name": "Процедура"
},
{
"id": "9",
"name": "Онлайн-консультация"
}
],
"total": 3,
"page": 1,
"limit": 100
}
Где: |
data |
Данные |
data.id |
Id вида приема |
data.name |
Наименование вида приема |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения вида приема по id
Запрос "talonreceptiontypes/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/talonreceptiontypes/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"name": "Консультация"
}
Где: |
id |
Id вида приема |
name |
Наименование вида приема |
Метод получения коммуникационных статусов
Запрос "taloncomstatuses"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/taloncomstatuses
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"name": "Не связывались"
},
{
"id": "2",
"name": "Звонили"
},
{
"id": "3",
"name": "Отправили SMS"
},
{
"id": "4",
"name": "Отправили Email"
},
{
"id": "5",
"name": "Не взял трубку"
}
],
"total": 5,
"page": 1,
"limit": 100
}
Где: |
data |
Данные |
data.id |
Id коммуникационного статуса |
data.name |
Наименование коммуникационного статуса |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения коммуникационного статуса по id
Запрос "taloncomstatuses/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/taloncomstatuses/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"name": "Не связывались"
}
Где: |
id |
Id коммуникационного статуса |
name |
Наименование коммуникационного статуса |
Метод получения источников информации
Запрос "infosources"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/infosources
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"name": "Рекламный буклет"
},
{
"id": "2",
"name": "Интернет"
},
{
"id": "3",
"name": "Знакомые"
},
{
"id": "4",
"name": "Газета"
}
],
"total": 7,
"page": 1,
"limit": 100
}
Где: |
data |
Данные |
data.id |
Id источника информации |
data.name |
Наименование источника информации |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения источника информации по id
Запрос "infosources/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/infosources/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"name": "Рекламный буклет"
}
Где: |
id |
Id источника информации |
name |
Наименование источника информации |
Метод получения типов записи
Запрос "talonrecordtype"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
filters |
Набор фильтров по полям, [{"field":"{поле}", "value":"{значение}, "co":"{оператор сравнения(по умолчанию "=")}"}, ...] |
Нет |
sortBy |
Поле для сортировки |
Нет |
sortType |
Тип сортировки: 1 - по возрастанию (по умолчанию), -1 по убыванию |
Нет |
page |
Страница пагинации, по умолчанию 1 |
Нет |
limit |
Количество выгружаемых записей, по умолчанию 100 |
Нет |
https://newapi.archimed-soft.ru/api/v3/talonrecordtype
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"id": "1",
"name": "По телефону"
},
{
"id": "2",
"name": "От стойки"
},
{
"id": "3",
"name": "Направлен другим специалистом"
},
{
"id": "5",
"name": "Онлайн-запись"
},
{
"id": "7",
"name": "Мобильное приложение"
}
],
"total": 16,
"page": 1,
"limit": 100
}
Где: |
data |
Данные |
data.id |
Id типа записи |
data.name |
Наименование типа записи |
total |
Общее количество записей |
limit |
Количество выгружаемых записей |
page |
Страница |
Метод получения типа записи по id
Запрос "talonrecordtype/{id}"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
fields |
Набор полей, ["поле1", "поле2", ...] |
Нет |
https://newapi.archimed-soft.ru/api/v3/talonrecordtype/1
В ответ на запрос Вы получите ответ в формате
JSON:
{
"id": "1",
"name": "По телефону"
}
Где: |
id |
Id типа записи |
name |
Наименование типа записи |
Метод получения интревалов
Запрос "intervals"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
date_from |
Дата с, в формате DD.MM.YYYY |
Да |
date_to |
Дата по, в формате DD.MM.YYYY |
Да |
doc_id |
Фильтр по id доктора |
Нет |
spec_id |
Фильтр по id специализации |
Нет |
build_id |
Фильтр по id корпуса |
Нет |
https://newapi.archimed-soft.ru/api/v3/intervals?date_from=01.08.2020&date_to=31.08.2020
В ответ на запрос Вы получите ответ в формате
JSON:
{
"doctors": [
{
"id": 8,
"name": "Сергеев Иван Петрович",
"primary_spec": "Хирург",
"primary_spec_id": "34",
"specs": [
{
"id": "32",
"name": "Аллерголог"
},
{
"id": "34",
"name": "Хирург"
}
],
"schedules": [
{
"id": "2005",
"build_id": "1",
"build_name": "Корпус 1",
"room": "Кабинет № 2",
"address": "ул. Космонавтов, 41",
"kind": "0",
"date": "18.08.2020",
"start": "08:00",
"end": "09:00",
"intervals": [
{
"start": "08:00",
"end": "08:20",
"free": true
},
{
"start": "08:20",
"end": "08:40",
"free": true
},
{
"start": "08:40",
"end": "09:00",
"free": false
}
]
}
]
}
]
}
Где: |
doctors |
Список докторов |
doctors.id |
Id доктора |
doctors.name |
ФИО доктора |
doctors.primary_spec |
Основная специализация доктора |
doctors.primary_spec_id |
Id основной специализации доктора |
doctors.specs |
Список дополнительных специализаций доктора |
doctors.schedules |
Расписание доктора |
doctors.schedules.id |
Id расписания |
doctors.schedules.build_id |
Id корпуса |
doctors.schedules.build_name |
Наименование корпуса |
doctors.schedules.room |
Наименование кабинета |
doctors.schedules.address |
Адрес |
doctors.schedules.kind |
Тип дня в расписании работы доктора: 0 - Запись разрешена, 1 - Запись разрешена с предупреждением, 2 - Запись запрещена, 3 - Запись запрещена, кроме принимающего доктора |
doctors.schedules.date |
Дата приема |
doctors.schedules.start |
Начало приема |
doctors.schedules.end |
Конец приема |
doctors.schedules.intervals |
Интервалы приема доктора |
doctors.schedules.intervals.start |
Начало интервала |
doctors.schedules.intervals.end |
Конец интервала |
doctors.schedules.intervals.free |
Отметка свободен ли интервал |
Список доступных складов для врачей
Запрос "doctors/{id}/stores"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
id |
ID Врача |
Да |
https://newapi.archimed-soft.ru/api/v3/doctors/6/stores
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"poses": [
{
"id": 2,
"name": "Касса 2- Корпус 2"
}
],
"stores": [
{
"id": 3,
"name": "Дополнительный"
},
{
"id": 2,
"name": "Основной склад хранения"
}
]
}
]
}
Где: |
data |
Список правил |
data.poses |
Кассы |
data.stores |
Склады |
Список услуг, которые может оказать врач
Запрос "doctors/{id}/services"
Метод |
GET |
Параметры |
Название параметра |
Описание |
Обязательно |
id |
ID Врача |
Да |
https://newapi.archimed-soft.ru/api/v3/doctors/6/services
В ответ на запрос Вы получите ответ в формате
JSON:
{
"data": [
{
"groupid": 751,
"groupname": "Разное",
"services": [
{
"id": 14466,
"name": "Зп руслан",
"type": 0,
"price": 32000,
"materials": [
{
"id": 10641,
"name": "Энерион",
"quant": 1,
"ismult": false,
"isediting": true,
"accessnotdeparture": false,
"meausereunitid": 0
}
]
}
]
}
]
}
Где: |
data |
Список категории услуг |
data.groupid |
Id категории услуги |
data.groupname |
Название категории услуги |
data.services.id |
Id услуги |
data.services.name |
Название услуги |
data.services.type |
Тип позиции. 0 - услуга, 1 м атериал, 2 - абонемент, 3 - сертификат, 4 - бонусная карта. |
data.services.price |
Стоимость услуги (базовая из прайса) |
data.services.materials |
Материалы услуги |
data.services.materials.id |
Id материала |
data.services.materials.name |
Название материала |
data.services.materials.qualt |
Количество списываемого материала по умолчанию из справочника |
data.services.materials.ismult |
Умножать на количество начисленных услуг. |
data.services.materials.isediting |
Разрешить редактировать количество списываемого материала |
data.services.materials.accessnotdeparture |
Разрешить не списывать |
data.services.materials.meauserenitid |
Ссылка на ед.измерения материала |