- Создал(а) Ульшин Роман [X], редактировал(а) Федоров Антон авг. 11, 2021
Вы просматриваете старую версию данной страницы. Смотрите текущую версию.
Сравнить с текущим просмотр истории страницы
« Предыдущий Версия 2 Следующий »
Описание доступно на развернутом сервисе в виде swagger-ui.
Тестовый сервис - https://2drtest.softrust.ru/vs/swagger/index.html
Либо здесь в виде описания сервиса в формате open-api - swagger.json. Можно просматривать на https://editor.swagger.io/, скопировав туда содержимое или загрузив в виде файла.
swagger.json - 1.1 - 11.08.2021 Развернуть исходный код
{ "openapi": "3.0.1", "info": { "title": "VirtualSchool - Сервис интеграции с виртуальной школой", "contact": { "name": "Confluence docs", "url": "https://confluence.softrust.ru/pages/viewpage.action?pageId=24379505" }, "version": "v1" }, "servers": [ { "url": "https://2drtest.softrust.ru/vs" } ], "paths": { "/disp/conclusions/{dispCardGuid}": { "get": { "tags": [ "DispConclusions" ], "summary": "Получение заключения по гуиду карты диспансеризации.", "parameters": [ { "name": "dispCardGuid", "in": "path", "description": "Гуид карты диспансеризации.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "8bd52d36-775f-498d-9ca3-3c66298dbf20" } ], "responses": { "200": { "description": "Заключение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conclusion" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/disp/conclusions": { "get": { "tags": [ "DispConclusions" ], "summary": "Получение списка заключений по диспансеризации.", "parameters": [ { "name": "snils", "in": "query", "description": "СНИЛС пациента.", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Начало периода. По умолчанию не применяется.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Конец периода. По умолчанию текущий момент.", "schema": { "type": "string", "format": "date-time" } }, { "name": "take", "in": "query", "description": "Постраничный вывод. Размер страницы.", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "skip", "in": "query", "description": "Постраничный вывод. Пропуск элементов.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "orderDesc", "in": "query", "description": "Сортировка по дате. По умолчанию по убыванию - сначала новое.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Список заключений.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConclusionPaginationDto" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/educational-records": { "get": { "tags": [ "EducationalRecords" ], "summary": "Получение записей об обучении.", "parameters": [ { "name": "take", "in": "query", "description": "Постраничный вывод. Размер страницы.", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "skip", "in": "query", "description": "Постраничный вывод. Пропуск элементов.", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "Список записей об обучении.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationalRecordDtoPaginationDto" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/educational-records/{id}": { "get": { "tags": [ "EducationalRecords" ], "summary": "Получение записи об обучении.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор записи.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Запись об обучении.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationalRecordDto" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "EducationalRecords" ], "summary": "Создание или обновление записи об обучении.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор записи об обучении.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Запись.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationalRecordDto" } } } }, "responses": { "204": { "description": "Успех." }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "EducationalRecords" ], "summary": "Удаление записи об обучении.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор записи.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Успех." }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/organizations": { "get": { "tags": [ "Organizations" ], "summary": "Получение списка организаций.", "parameters": [ { "name": "take", "in": "query", "description": "Постраничный вывод. Размер страницы.", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "skip", "in": "query", "description": "Постраничный вывод. Пропуск элементов.", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "Список организаций.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoPaginationDto" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/organizations/{id}": { "get": { "tags": [ "Organizations" ], "summary": "Получение организации по идентификатору.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор организации.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Организация.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Organizations" ], "summary": "Обновление или создание организации.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор организации.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Организация.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } } }, "responses": { "204": { "description": "Успех." }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Organizations" ], "summary": "Удаление организации.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор организации.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Успех." }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/organizations/{id}/groups/{groupId}": { "get": { "tags": [ "Organizations" ], "summary": "Получение группы в организации.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор организации.", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "Идентификатор группы.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Группа.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Organizations" ], "summary": "Обновление или создание группы в организации.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор организации.", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "Идентификатор группы.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Группа.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } }, "responses": { "204": { "description": "Успех." }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Organizations" ], "summary": "Удаление группы из организации.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор организации.", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "Идентификатор группы.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Успех." }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/treatments/{id}": { "get": { "tags": [ "Treatments" ], "summary": "Получение случая лечения.", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор случая лечения.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Случай лечения.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentWithExemptionsDto" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/treatments": { "get": { "tags": [ "Treatments" ], "summary": "Получение списка случаев лечения.", "parameters": [ { "name": "Snils", "in": "query", "schema": { "type": "string" } }, { "name": "StartDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Список случаев лечения.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentWithExemptionsDtoPaginationDto" } } } }, "400": { "description": "Ошибка формата запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Ошибка авторизации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Ошибка сервера.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "Conclusion": { "type": "object", "properties": { "date": { "type": "string", "description": "Дата.", "format": "date-time" }, "doctor": { "type": "string", "description": "Врач. \r\nФИО (Должность).", "nullable": true }, "medicalOrganisation": { "type": "string", "description": "ЛПУ.\r\nКраткое имя ЛПУ - Мкод.", "nullable": true }, "dispCardGuid": { "type": "string", "description": "Идентификатор карты диспансеризации.", "format": "uuid" }, "dispTypeName": { "type": "string", "description": "Имя типа диспансеризации.", "nullable": true }, "dispTypeCode": { "type": "string", "description": "Код типа диспансеризации.", "nullable": true }, "snils": { "type": "string", "description": "СНИЛС пациента.", "nullable": true }, "detalization": { "type": "array", "items": { "$ref": "#/components/schemas/Detalization" }, "description": "Детализация заключения.", "nullable": true } }, "additionalProperties": false, "description": "Заключение по диспансеризации." }, "ConclusionPaginationDto": { "type": "object", "properties": { "take": { "type": "integer", "description": "Размер страницы.", "format": "int32" }, "skip": { "type": "integer", "description": "Пропуск объектов.", "format": "int32" }, "totalCount": { "type": "integer", "description": "Всего объектов по заданному фильтру.", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Conclusion" }, "description": "Объекты.", "nullable": true } }, "additionalProperties": false, "description": "Постраничный вывод." }, "Detalization": { "type": "object", "properties": { "guid": { "type": "string", "description": "Идентификатор вопроса.", "format": "uuid" }, "name": { "type": "string", "description": "Наименование вопроса.", "nullable": true }, "value": { "type": "string", "description": "Значение ответа.", "nullable": true }, "type": { "type": "string", "description": "Тип вопроса.", "nullable": true } }, "additionalProperties": false, "description": "Детализация заключения." }, "EducationalRecordDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор. Код записи об обучении.", "nullable": true }, "snils": { "type": "string", "description": "СНИЛС обучающегося.", "nullable": true }, "levelId": { "type": "integer", "description": "Уровень обучения (1 - ДОО, 2 - ОО).", "format": "int32" }, "startDate": { "type": "string", "description": "Дата начала обучения.", "format": "date-time" }, "endDate": { "type": "string", "description": "Дата окончания обучения.", "format": "date-time", "nullable": true }, "groupId": { "type": "string", "description": "Идентификатор группы.", "nullable": true }, "organizationId": { "type": "string", "description": "Идентификатор образовательной организации.", "nullable": true } }, "additionalProperties": false, "description": "Запись об обучении. Группы и учащиеся." }, "EducationalRecordDtoPaginationDto": { "type": "object", "properties": { "take": { "type": "integer", "description": "Размер страницы.", "format": "int32" }, "skip": { "type": "integer", "description": "Пропуск объектов.", "format": "int32" }, "totalCount": { "type": "integer", "description": "Всего объектов по заданному фильтру.", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EducationalRecordDto" }, "description": "Объекты.", "nullable": true } }, "additionalProperties": false, "description": "Постраничный вывод." }, "ExemptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор освобождения.", "format": "uuid" }, "treatmentId": { "type": "string", "description": "Идентификатор случая лечения.", "format": "uuid" }, "typeId": { "type": "integer", "description": "Тип освобождения.", "format": "int32" }, "startDate": { "type": "string", "description": "Дата начала освобождения.", "format": "date-time" }, "endDate": { "type": "string", "description": "Дата окончания освобождения.", "format": "date-time" } }, "additionalProperties": false, "description": "Освобождение." }, "GroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор группы.", "nullable": true }, "name": { "type": "string", "description": "Наименование группы.", "nullable": true } }, "additionalProperties": false, "description": "Группа обучающегося." }, "OrganizationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор образовательной организации.", "nullable": true }, "inn": { "type": "string", "description": "ИНН образовательной организации.", "nullable": true }, "name": { "type": "string", "description": "Наименование образовательной организации.", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" }, "description": "Массив групп, входящих в организацию.", "nullable": true } }, "additionalProperties": false, "description": "Образовательная организация." }, "OrganizationDtoPaginationDto": { "type": "object", "properties": { "take": { "type": "integer", "description": "Размер страницы.", "format": "int32" }, "skip": { "type": "integer", "description": "Пропуск объектов.", "format": "int32" }, "totalCount": { "type": "integer", "description": "Всего объектов по заданному фильтру.", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationDto" }, "description": "Объекты.", "nullable": true } }, "additionalProperties": false, "description": "Постраничный вывод." }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "TreatmentWithExemptionsDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор случая лечения.", "format": "uuid" }, "snils": { "type": "string", "description": "СНИЛС обучающегося.", "nullable": true }, "date": { "type": "string", "description": "Дата формирования справки.", "format": "date-time" }, "typeId": { "type": "integer", "description": "Тип случая лечения.", "format": "int32" }, "opened": { "type": "boolean", "description": "Открытый случай лечения" }, "exemptions": { "type": "array", "items": { "$ref": "#/components/schemas/ExemptionDto" }, "description": "Массив освобождений по случаю.", "nullable": true } }, "additionalProperties": false, "description": "Случай лечения с освобождениями." }, "TreatmentWithExemptionsDtoPaginationDto": { "type": "object", "properties": { "take": { "type": "integer", "description": "Размер страницы.", "format": "int32" }, "skip": { "type": "integer", "description": "Пропуск объектов.", "format": "int32" }, "totalCount": { "type": "integer", "description": "Всего объектов по заданному фильтру.", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TreatmentWithExemptionsDto" }, "description": "Объекты.", "nullable": true } }, "additionalProperties": false, "description": "Постраничный вывод." } }, "securitySchemes": { "Basic": { "type": "http", "description": "Basic Authorization header using the Bearer scheme.", "scheme": "Basic" } } }, "security": [ { "Basic": [] } ] }
Ошибка отображения макрокоманды «children»
null
- Нет меток