HCP Portal coming soon
{
"openapi": "3.1.1",
"info": {
"title": "WebApi | v1",
"version": "1"
},
"servers": [
{
"url": "http://pace-com-qa-backend/"
}
],
"paths": {
"/Chatbot/topics": {
"get": {
"tags": [
"Chatbot"
],
"operationId": "Get topics",
"parameters": [
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatComponentResponseDtoOfChatTopicsComponentResponseData"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Chatbot/topic-questions": {
"get": {
"tags": [
"Chatbot"
],
"operationId": "Get topic questions",
"parameters": [
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatComponentResponseDtoOfChatTopicQuestionsResponseDataDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Chatbot/question-completion": {
"get": {
"tags": [
"Chatbot"
],
"operationId": "Get question completion",
"parameters": [
{
"name": "partial",
"in": "query",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatComponentResponseDtoOfChatQuestionCompletionResponseDataDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Chatbot/chat": {
"post": {
"tags": [
"Chatbot"
],
"operationId": "Send chat message to chatbot",
"parameters": [
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ChatRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ChatRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatInteractionResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Chatbot/feedback/{runId}": {
"post": {
"tags": [
"Chatbot"
],
"operationId": "Send chatbot feedback",
"parameters": [
{
"name": "runId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FeedbackRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IChatComponentResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Chatbot/detailed-negative-feedback/{runId}": {
"post": {
"tags": [
"Chatbot"
],
"operationId": "Send detailed negative feedback",
"parameters": [
{
"name": "runId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetailedNegativeFeedbackRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DetailedNegativeFeedbackRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DetailedNegativeFeedbackRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IChatComponentResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Chatbot/configuration": {
"get": {
"tags": [
"Chatbot"
],
"operationId": "Get chatbot configuration",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatbotConfigurationResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/consents": {
"post": {
"tags": [
"Consent"
],
"operationId": "ConsentToPolicies",
"parameters": [
{
"name": "Application-Id",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "Application-Platform",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "Application-Version",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddConsentRequestDto"
},
"additionalProperties": false
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddConsentRequestDto"
},
"additionalProperties": false
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/policies": {
"get": {
"tags": [
"Policy"
],
"operationId": "GetPolicies",
"parameters": [
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/policies/{policyId}/{versionId}/fulltext": {
"get": {
"tags": [
"Policy"
],
"operationId": "GetPolicyFullText",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "versionId",
"in": "path",
"required": true,
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {}
}
}
}
}
},
"/Consultation/AppointmentType": {
"get": {
"tags": [
"AppointmentType"
],
"operationId": "Get appointment types",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppointmentTypeResponseDto"
},
"additionalProperties": false
}
}
}
}
}
}
},
"/Consultation/Appointment/{id}": {
"get": {
"tags": [
"Appointment"
],
"operationId": "Get appointment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
},
"delete": {
"tags": [
"Appointment"
],
"operationId": "Delete appointment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/Consultation/Appointment": {
"get": {
"tags": [
"Appointment"
],
"operationId": "Get appointments",
"parameters": [
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "typeIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppointmentResponseDto"
},
"additionalProperties": false
}
}
}
}
}
},
"post": {
"tags": [
"Appointment"
],
"operationId": "Create appointment",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AppointmentRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Appointment"
],
"operationId": "Replace appointment",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AppointmentRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Consultation/appointment/{appointmentId}/Recordings/initialize": {
"post": {
"tags": [
"Recordings"
],
"operationId": "Initialize recording upload",
"parameters": [
{
"name": "appointmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordingFileUploadInitializationRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RecordingFileUploadInitializationRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RecordingFileUploadInitializationRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordingFileUploadInitializationResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/Consultation/appointment/{appointmentId}/Recordings/{recordingId}": {
"post": {
"tags": [
"Recordings"
],
"operationId": "Upload recording stream",
"parameters": [
{
"name": "appointmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"ContentType": {
"type": "string",
"additionalProperties": false
},
"ContentDisposition": {
"type": "string",
"additionalProperties": false
},
"Headers": {
"type": "object",
"additionalProperties": false
},
"Length": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int64"
},
"Name": {
"type": "string",
"additionalProperties": false
},
"FileName": {
"type": "string",
"additionalProperties": false
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"patch": {
"tags": [
"Recordings"
],
"operationId": "Update recording",
"parameters": [
{
"name": "appointmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRecordingRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateRecordingRequestDto"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/Consultation/appointment/{appointmentId}/Recordings/{recordingId}/finalize": {
"post": {
"tags": [
"Recordings"
],
"operationId": "Finalize recording upload",
"parameters": [
{
"name": "appointmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinalizeRecordingUploadRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FinalizeRecordingUploadRequestDto"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/contentLibrary/Article/recommended": {
"get": {
"tags": [
"Article"
],
"parameters": [
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false,
"default": "en"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/contentLibrary/Article/{articleId}": {
"get": {
"tags": [
"Article"
],
"parameters": [
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": "integer",
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false,
"default": "en"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/contentLibrary/Article": {
"get": {
"tags": [
"Article"
],
"parameters": [
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "CategoryIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"additionalProperties": false
}
},
{
"name": "TagIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"additionalProperties": false
}
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "SortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortOrder"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false,
"default": "en"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/contentLibrary/Category": {
"get": {
"tags": [
"Category"
],
"parameters": [
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false,
"default": "en"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/contentLibrary/Tag": {
"get": {
"tags": [
"Tag"
],
"parameters": [
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false,
"default": "en"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Identity/configuration": {
"get": {
"tags": [
"Identity"
],
"operationId": "GetConfiguration",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Identity/email-verification-status": {
"get": {
"tags": [
"Identity"
],
"operationId": "EmailVerificationStatus",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailVerificationStatusResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Identity/resend-verification-email": {
"post": {
"tags": [
"Identity"
],
"operationId": "ResendVerificationEmail",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Identity": {
"delete": {
"tags": [
"Identity"
],
"operationId": "DeleteIdentity",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Identity/change-email": {
"patch": {
"tags": [
"Identity"
],
"operationId": "ChangeEmail",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeEmailRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ChangeEmailRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ChangeEmailRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Identity/get-role": {
"get": {
"tags": [
"Identity"
],
"operationId": "GetRole",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/IdentityProperties": {
"get": {
"tags": [
"IdentityProperties"
],
"operationId": "GetIdentityPropertiesWithRole",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesWithRoleResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
},
"post": {
"tags": [
"IdentityProperties"
],
"operationId": "CreateIdentityProperties",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/profiles": {
"post": {
"tags": [
"IdentityProperties"
],
"operationId": "CreateIdentityPropertiesOld",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityPropertiesResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Insights/registeredInsights": {
"get": {
"tags": [
"Insights"
],
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"additionalProperties": false
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/Insights/{insightName}": {
"get": {
"tags": [
"Insights"
],
"parameters": [
{
"name": "insightName",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseInsightsComponentDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/Insights": {
"get": {
"tags": [
"Insights"
],
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/NoteTopic": {
"get": {
"tags": [
"NoteTopic"
],
"operationId": "Get note topics",
"parameters": [
{
"name": "category",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteTopicResponseDto"
},
"additionalProperties": false
}
}
}
}
}
}
},
"/NoteType": {
"get": {
"tags": [
"NoteType"
],
"operationId": "Get note types",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteTypeResponseDto"
},
"additionalProperties": false
}
}
}
}
}
}
},
"/Note/{id}": {
"get": {
"tags": [
"Note"
],
"operationId": "Get note",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
},
"delete": {
"tags": [
"Note"
],
"operationId": "Delete note",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Note": {
"get": {
"tags": [
"Note"
],
"operationId": "Get notes",
"parameters": [
{
"name": "typeIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteResponseDto"
},
"additionalProperties": false
}
}
}
}
}
},
"post": {
"tags": [
"Note"
],
"operationId": "Create note",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NoteRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Note"
],
"operationId": "Replace note",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NoteRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/notification/Register": {
"post": {
"tags": [
"Register"
],
"operationId": "Notifications_Registration",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/notification/Register/deregister": {
"delete": {
"tags": [
"Register"
],
"operationId": "Notifications_Deregistration",
"parameters": [
{
"name": "installationId",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/profile/onboarding/state": {
"get": {
"tags": [
"ProfileOnboarding"
],
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnboardingStateResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"patch": {
"tags": [
"ProfileOnboarding"
],
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnboardingStateUpdateRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OnboardingStateUpdateRequestDto"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/profile/onboarding/layout": {
"get": {
"tags": [
"ProfileOnboarding"
],
"parameters": [
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionLayoutResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/Permission/DataSharing/access": {
"get": {
"tags": [
"DataSharing"
],
"operationId": "GetDataSharingAccessPermissions",
"parameters": [
{
"name": "PageSize",
"in": "query",
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "SortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortOrder"
}
},
{
"name": "searchQuery",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedItemsOfDataSharingPermissionResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Permission/DataSharing/subject": {
"get": {
"tags": [
"DataSharing"
],
"operationId": "GetDataSharingSubjectPermissions",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSharingPermissionResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Permission/DataSharing/{permissionId}": {
"delete": {
"tags": [
"DataSharing"
],
"operationId": "DeleteDataSharingPermission",
"parameters": [
{
"name": "permissionId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Permission/DataSharingRequest/access": {
"get": {
"tags": [
"DataSharingRequest"
],
"operationId": "GetDataSharingAccessPermissionRequests",
"parameters": [
{
"name": "PageSize",
"in": "query",
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "SortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortOrder"
}
},
{
"name": "searchQuery",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedItemsOfDataSharingPermissionRequestResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Permission/DataSharingRequest/subject": {
"get": {
"tags": [
"DataSharingRequest"
],
"operationId": "GetDataSharingSubjectPermissionRequests",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSharingPermissionRequestResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Permission/DataSharingRequest/{id}/accept": {
"post": {
"tags": [
"DataSharingRequest"
],
"operationId": "AcceptDataSharingPermissionRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSharingPermissionResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Permission/DataSharingRequest/{id}/decline": {
"post": {
"tags": [
"DataSharingRequest"
],
"operationId": "DeclineDataSharingPermissionRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSharingPermissionRequestResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Permission/DataSharingRequest/{id}/revoke": {
"post": {
"tags": [
"DataSharingRequest"
],
"operationId": "RevokeDataSharingPermissionRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSharingPermissionRequestResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Tracking/logTypeConfigs": {
"get": {
"tags": [
"Tracking"
],
"operationId": "Get all log type configurations",
"parameters": [
{
"name": "category",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogTypeConfigResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Tracking/logEntries": {
"post": {
"tags": [
"Tracking"
],
"operationId": "LogEntries",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogEntryRequestDto"
},
"additionalProperties": false
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogEntryRequestDto"
},
"additionalProperties": false
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
},
"get": {
"tags": [
"Tracking"
],
"operationId": "GetLogEntries",
"parameters": [
{
"name": "category",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogEntryResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Tracking/logEntries/last": {
"get": {
"tags": [
"Tracking"
],
"operationId": "GetLatestLogEntries",
"parameters": [
{
"name": "category",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogEntryResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/Tracking/checkLogEntries": {
"get": {
"tags": [
"Tracking"
],
"operationId": "CheckLogEntries",
"parameters": [
{
"name": "category",
"in": "query",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
},
"/treatment/Intakes": {
"get": {
"tags": [
"Intakes"
],
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
}
},
{
"name": "notificationsEnabled",
"in": "query",
"schema": {
"type": "boolean",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntakeEntryResponseDto"
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Intakes"
],
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutIntakeRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PutIntakeRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PutIntakeRequestDto"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/treatment/Intakes/{intakeId}": {
"get": {
"tags": [
"Intakes"
],
"parameters": [
{
"name": "intakeId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntakeEntryResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Intakes"
],
"parameters": [
{
"name": "intakeId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/treatment/Medication": {
"get": {
"tags": [
"Medication"
],
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MedicationResponseDto"
},
"additionalProperties": false
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Medication"
],
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMedicationRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateMedicationRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateMedicationRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MedicationResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/treatment/Medication/{id}": {
"get": {
"tags": [
"Medication"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MedicationResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"patch": {
"tags": [
"Medication"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMedicationRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMedicationRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateMedicationRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MedicationResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Medication"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/treatment/Medication/{id}/intake-status": {
"get": {
"tags": [
"Medication"
],
"operationId": "Get Medication Intake Status",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MedicationIntakeStatusResponseDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MedicationIntakeStatusResponseDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MedicationIntakeStatusResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/treatment/PrefabMedications": {
"get": {
"tags": [
"PrefabMedications"
],
"parameters": [
{
"name": "Accept-Language",
"in": "header",
"schema": {
"type": "string",
"additionalProperties": false
}
},
{
"name": "api-version",
"in": "query",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"api-version": "1.0"
}
}
},
{
"name": "X-API-Version",
"in": "header",
"description": "The API version, in the format 'major.minor'.",
"schema": {
"type": "string",
"example": {
"X-API-Version": "1.0"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PredefinedMedicationDto"
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDto"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AddConsentRequestDto": {
"required": [
"policyId",
"version",
"language",
"consented"
],
"type": "object",
"properties": {
"policyId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"version": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"language": {
"type": "string",
"additionalProperties": false
},
"consented": {
"type": "boolean",
"additionalProperties": false
}
},
"additionalProperties": false
},
"AppointmentRequestDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
},
"title": {
"type": "string",
"additionalProperties": false
},
"timeStart": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"timeEnd": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"typeIds": {
"type": "array",
"items": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"additionalProperties": false
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteRequestDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"AppointmentResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
},
"title": {
"type": "string",
"additionalProperties": false
},
"timeStart": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"timeEnd": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppointmentTypeResponseDto"
},
"additionalProperties": false
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"AppointmentTypeResponseDto": {
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"name": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"BaseInsightsComponentDto": {
"additionalProperties": false
},
"BaseScheduleDto": {
"additionalProperties": false
},
"ChangeEmailRequestDto": {
"required": [
"newEmail"
],
"type": "object",
"properties": {
"newEmail": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"ChatbotConfigurationResponseDto": {
"required": [
"chatbotEnabled"
],
"type": "object",
"properties": {
"chatbotEnabled": {
"type": "boolean",
"additionalProperties": false
}
},
"additionalProperties": false
},
"ChatComponentResponseDtoOfChatQuestionCompletionResponseDataDto": {
"required": [
"type",
"data"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"additionalProperties": false
},
"data": {
"$ref": "#/components/schemas/ChatQuestionCompletionResponseDataDto"
}
},
"additionalProperties": false
},
"ChatComponentResponseDtoOfChatTopicQuestionsResponseDataDto": {
"required": [
"type",
"data"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"additionalProperties": false
},
"data": {
"$ref": "#/components/schemas/ChatTopicQuestionsResponseDataDto"
}
},
"additionalProperties": false
},
"ChatComponentResponseDtoOfChatTopicsComponentResponseData": {
"required": [
"type",
"data"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"additionalProperties": false
},
"data": {
"$ref": "#/components/schemas/ChatTopicsComponentResponseData"
}
},
"additionalProperties": false
},
"ChatInteractionResponseDto": {
"required": [
"reason",
"components"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"additionalProperties": false
},
"components": {
"$ref": "#/components/schemas/JsonArray"
}
},
"additionalProperties": false
},
"ChatQuestionCompletionResponseDataDto": {
"required": [
"partial",
"completions"
],
"type": "object",
"properties": {
"partial": {
"type": "string",
"additionalProperties": false
},
"completions": {
"type": "array",
"items": {
"type": "string",
"additionalProperties": false
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ChatRequestDto": {
"required": [
"question"
],
"type": "object",
"properties": {
"question": {
"type": "string",
"additionalProperties": false
},
"filterQuery": {
"type": [
"null",
"string"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"ChatTopicQuestionsResponseDataDto": {
"required": [
"topic",
"questions"
],
"type": "object",
"properties": {
"text": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"topic": {
"type": "string",
"additionalProperties": false
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicQuestionResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ChatTopicsComponentResponseData": {
"required": [
"topics"
],
"type": "object",
"properties": {
"text": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"topics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ClientPlatform": {
"enum": [
"Ios",
"AndroidFcm"
],
"additionalProperties": false
},
"ConfigurationResponseDto": {
"type": "object",
"properties": {
"isEmailVerificationRequired": {
"type": "boolean",
"additionalProperties": false
},
"supportedCountries": {
"type": "array",
"items": {
"type": "string",
"additionalProperties": false
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"CreateMedicationRequestDto": {
"required": [
"startDate",
"name",
"activeIngredient",
"medicationFormat",
"medicationFormatIconUrl",
"medicationUnit",
"schedule",
"notificationsEnabled",
"category"
],
"type": "object",
"properties": {
"startDate": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"endDate": {
"type": [
"null",
"string"
],
"additionalProperties": false,
"format": "date-time"
},
"name": {
"type": "string",
"additionalProperties": false
},
"activeIngredient": {
"type": "string",
"additionalProperties": false
},
"medicationFormat": {
"type": "string",
"additionalProperties": false
},
"medicationFormatIconUrl": {
"type": "string",
"additionalProperties": false
},
"medicationUnit": {
"type": "string",
"additionalProperties": false
},
"intakeInstructions": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"schedule": {
"$ref": "#/components/schemas/BaseScheduleDto"
},
"notificationsEnabled": {
"type": "boolean",
"additionalProperties": false
},
"category": {
"maxLength": 255,
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"DataSharingPermissionRequestResponseDto": {
"required": [
"id",
"subjectIdentityId",
"accessorIdentityId",
"accessorReferenceName",
"expiresAt",
"type",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
},
"subjectIdentityId": {
"type": "string",
"additionalProperties": false
},
"accessorIdentityId": {
"type": "string",
"additionalProperties": false
},
"accessorReferenceName": {
"type": "string",
"additionalProperties": false
},
"expiresAt": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"type": {
"type": "string",
"additionalProperties": false
},
"status": {
"type": "string",
"additionalProperties": false
},
"subjectReferenceName": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"subjectEmail": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"accessorEmail": {
"type": [
"null",
"string"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"DataSharingPermissionResponseDto": {
"required": [
"id",
"subjectIdentityId",
"accessorIdentityId",
"accessorReferenceName",
"type",
"createdAt"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
},
"subjectIdentityId": {
"type": "string",
"additionalProperties": false
},
"accessorIdentityId": {
"type": "string",
"additionalProperties": false
},
"accessorReferenceName": {
"type": "string",
"additionalProperties": false
},
"type": {
"type": "string",
"additionalProperties": false
},
"createdAt": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"subjectReferenceName": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"subjectEmail": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"accessorEmail": {
"type": [
"null",
"string"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"DetailedNegativeFeedbackRequestDto": {
"required": [
"detailedNegativeFeedbackKey"
],
"type": "object",
"properties": {
"detailedNegativeFeedbackKey": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"DeviceRegistrationRequestDto": {
"required": [
"platform",
"handle",
"installationId"
],
"type": "object",
"properties": {
"platform": {
"$ref": "#/components/schemas/ClientPlatform"
},
"handle": {
"type": "string",
"additionalProperties": false
},
"installationId": {
"type": "string",
"additionalProperties": false
},
"tags": {
"type": "array",
"items": {
"type": "string",
"additionalProperties": false
},
"additionalProperties": false
},
"templatesToRegister": {
"type": "array",
"items": {
"type": "string",
"additionalProperties": false
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"DeviceRegistrationResponseDto": {
"required": [
"installationId"
],
"type": "object",
"properties": {
"installationId": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"EmailVerificationStatusResponseDto": {
"type": "object",
"properties": {
"verified": {
"type": "boolean",
"additionalProperties": false
}
},
"additionalProperties": false
},
"EncryptionInfoRequestDto": {
"required": [
"v",
"alg",
"iv",
"keyId",
"wrappedDek"
],
"type": "object",
"properties": {
"v": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"alg": {
"maxLength": 100,
"type": "string",
"additionalProperties": false
},
"iv": {
"maxLength": 500,
"type": "string",
"additionalProperties": false
},
"keyId": {
"maxLength": 500,
"type": "string",
"additionalProperties": false
},
"wrappedDek": {
"maxLength": 500,
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"ErrorResponseDto": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"additionalProperties": false
},
"error": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"FeedbackRequestDto": {
"required": [
"score"
],
"type": "object",
"properties": {
"score": {
"$ref": "#/components/schemas/FeedbackScore"
}
},
"additionalProperties": false
},
"FeedbackScore": {
"type": "integer",
"additionalProperties": false
},
"FinalizeRecordingUploadRequestDto": {
"required": [
"authTag"
],
"type": "object",
"properties": {
"authTag": {
"maxLength": 500,
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"IChatComponentResponseDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"IdentityPropertiesRequestDto": {
"required": [
"country"
],
"type": "object",
"properties": {
"country": {
"type": [
"null",
"string"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"IdentityPropertiesResponseDto": {
"required": [
"identityId",
"country"
],
"type": "object",
"properties": {
"identityId": {
"type": "string",
"additionalProperties": false
},
"country": {
"type": [
"null",
"string"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"IdentityPropertiesWithRoleResponseDto": {
"required": [
"identityId",
"country",
"role"
],
"type": "object",
"properties": {
"identityId": {
"type": "string",
"additionalProperties": false
},
"country": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"role": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"InputScaleConfigResponseDto": {
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"type": {
"type": "string",
"additionalProperties": false
},
"steps": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/InputScaleStepResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"InputScaleStepResponseDto": {
"type": "object",
"properties": {
"value": {
"type": "string",
"additionalProperties": false
},
"name": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"IntakeEntryResponseDto": {
"required": [
"id",
"plannedAt",
"plannedDose",
"medicationName",
"medicationUnit",
"medicationId",
"notificationsEnabled"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false
},
"plannedAt": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"actionAt": {
"type": [
"null",
"string"
],
"additionalProperties": false,
"format": "date-time"
},
"intakeInstructions": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"skipReason": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/IntakeSkipReason"
}
]
},
"plannedDose": {
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$",
"type": [
"number",
"string"
],
"additionalProperties": false,
"format": "float"
},
"takenDose": {
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$",
"type": [
"null",
"number",
"string"
],
"additionalProperties": false,
"format": "float"
},
"medicationName": {
"type": "string",
"additionalProperties": false
},
"medicationFormatIconUrl": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"medicationUnit": {
"type": "string",
"additionalProperties": false
},
"medicationId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"notificationsEnabled": {
"type": "boolean",
"additionalProperties": false
}
},
"additionalProperties": false
},
"IntakeSkipReason": {
"additionalProperties": false
},
"IResponseQuestionComponent": {
"type": "object",
"additionalProperties": false
},
"JsonArray": {
"type": "array",
"additionalProperties": false
},
"LogEntryRequestDto": {
"type": "object",
"properties": {
"logTypeConfigId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"entryTimeStart": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"entryTimeEnd": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogValueRequestDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"LogEntryResponseDto": {
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"createdAt": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"entryTimeStart": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"entryTimeEnd": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"logTypeConfigId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogValueResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"LogInputConfigResponseDto": {
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"name": {
"type": "string",
"additionalProperties": false
},
"dataType": {
"type": "string",
"additionalProperties": false
},
"scaleConfig": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/InputScaleConfigResponseDto"
}
]
},
"unit": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/UnitResponseDto"
}
]
}
},
"additionalProperties": false
},
"LogTypeConfigResponseDto": {
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"name": {
"type": "string",
"additionalProperties": false
},
"category": {
"type": "string",
"additionalProperties": false
},
"inputConfigs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogInputConfigResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"LogValueRequestDto": {
"type": "object",
"properties": {
"logInputConfigId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"integerValue": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"doubleValue": {
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$",
"type": [
"null",
"number",
"string"
],
"additionalProperties": false,
"format": "double"
},
"unitId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
"additionalProperties": false
},
"LogValueResponseDto": {
"type": "object",
"properties": {
"logInputConfigId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"integerValue": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"doubleValue": {
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$",
"type": [
"null",
"number",
"string"
],
"additionalProperties": false,
"format": "double"
},
"unitId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
"additionalProperties": false
},
"MedicationIntakeStatusResponseDto": {
"type": "object",
"properties": {
"lastIntakeDate": {
"type": [
"null",
"string"
],
"additionalProperties": false,
"format": "date-time"
},
"nextIntakeDate": {
"type": [
"null",
"string"
],
"additionalProperties": false,
"format": "date-time"
}
},
"additionalProperties": false
},
"MedicationResponseDto": {
"required": [
"id",
"startDate",
"name",
"activeIngredient",
"medicationFormat",
"medicationFormatIconUrl",
"medicationUnit",
"schedule",
"notificationsEnabled",
"category"
],
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"startDate": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"endDate": {
"type": [
"null",
"string"
],
"additionalProperties": false,
"format": "date-time"
},
"name": {
"type": "string",
"additionalProperties": false
},
"activeIngredient": {
"type": "string",
"additionalProperties": false
},
"medicationFormat": {
"type": "string",
"additionalProperties": false
},
"medicationFormatIconUrl": {
"type": "string",
"additionalProperties": false
},
"medicationUnit": {
"type": "string",
"additionalProperties": false
},
"intakeInstructions": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"schedule": {
"$ref": "#/components/schemas/BaseScheduleDto"
},
"notificationsEnabled": {
"type": "boolean",
"additionalProperties": false
},
"category": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"NoteRequestDto": {
"required": [
"id",
"title",
"content",
"createdAt",
"typeIds",
"topicIds"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
},
"title": {
"type": "string",
"additionalProperties": false
},
"content": {
"type": "string",
"additionalProperties": false
},
"createdAt": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"typeIds": {
"type": "array",
"items": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"additionalProperties": false
},
"topicIds": {
"type": "array",
"items": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"NoteResponseDto": {
"required": [
"id",
"title",
"content",
"createdAt",
"types",
"topics"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
},
"title": {
"type": "string",
"additionalProperties": false
},
"content": {
"type": "string",
"additionalProperties": false
},
"createdAt": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteTypeResponseDto"
},
"additionalProperties": false
},
"topics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteTopicResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"NoteTopicResponseDto": {
"required": [
"id",
"name",
"category",
"tipContent"
],
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"name": {
"type": "string",
"additionalProperties": false
},
"category": {
"type": "string",
"additionalProperties": false
},
"tipContent": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"NoteTypeResponseDto": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"name": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"OnboardingStateResponseDto": {
"type": "object",
"properties": {
"hasSkippedOnboarding": {
"type": "boolean",
"additionalProperties": false
},
"onboardingPresentedOnLaunch": {
"type": "boolean",
"additionalProperties": false
},
"unansweredQuestionsCount": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
}
},
"additionalProperties": false
},
"OnboardingStateUpdateRequestDto": {
"required": [
"hasSkippedOnboarding",
"onboardingPresentedOnLaunch"
],
"type": "object",
"properties": {
"hasSkippedOnboarding": {
"type": "boolean",
"additionalProperties": false
},
"onboardingPresentedOnLaunch": {
"type": "boolean",
"additionalProperties": false
}
},
"additionalProperties": false
},
"PaginatedItemsOfDataSharingPermissionRequestResponseDto": {
"required": [
"page",
"pageSize",
"totalItems",
"data"
],
"type": "object",
"properties": {
"page": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"pageSize": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"totalItems": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"totalPages": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSharingPermissionRequestResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"PaginatedItemsOfDataSharingPermissionResponseDto": {
"required": [
"page",
"pageSize",
"totalItems",
"data"
],
"type": "object",
"properties": {
"page": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"pageSize": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"totalItems": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"totalPages": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSharingPermissionResponseDto"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"PredefinedMedicationDto": {
"required": [
"activeIngredient",
"medicationFormat",
"medicationFormatIconUrl",
"medicationUnit",
"brand",
"category"
],
"type": "object",
"properties": {
"activeIngredient": {
"type": "string",
"additionalProperties": false
},
"medicationFormat": {
"type": "string",
"additionalProperties": false
},
"medicationFormatIconUrl": {
"type": "string",
"additionalProperties": false,
"format": "uri"
},
"medicationUnit": {
"type": "string",
"additionalProperties": false
},
"brand": {
"type": "string",
"additionalProperties": false
},
"category": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"title": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"status": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"detail": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"instance": {
"type": [
"null",
"string"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"PutIntakeRequestDto": {
"required": [
"id",
"actionAt"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false
},
"actionAt": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"doseOverride": {
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$",
"type": [
"null",
"number",
"string"
],
"additionalProperties": false,
"format": "float"
},
"skipReason": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/IntakeSkipReason"
}
]
}
},
"additionalProperties": false
},
"QuestionLayoutResponseDto": {
"required": [
"entries"
],
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IResponseQuestionComponent"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"RecordingFileUploadInitializationRequestDto": {
"required": [
"recordingName",
"mimeType",
"recordedDate",
"durationInSeconds",
"encryptionInfo"
],
"type": "object",
"properties": {
"recordingName": {
"maxLength": 250,
"type": "string",
"additionalProperties": false
},
"mimeType": {
"maxLength": 50,
"type": "string",
"additionalProperties": false
},
"recordedDate": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"durationInSeconds": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"encryptionInfo": {
"$ref": "#/components/schemas/EncryptionInfoRequestDto"
}
},
"additionalProperties": false
},
"RecordingFileUploadInitializationResponseDto": {
"required": [
"recordingId"
],
"type": "object",
"properties": {
"recordingId": {
"type": "string",
"additionalProperties": false,
"format": "uuid"
}
},
"additionalProperties": false
},
"RoleResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false
},
"name": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"SortOrder": {
"enum": [
"asc",
"desc"
],
"additionalProperties": false
},
"TopicQuestionResponseDto": {
"required": [
"id",
"question",
"topic"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false
},
"question": {
"type": "string",
"additionalProperties": false
},
"topic": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"TopicResponseDto": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"additionalProperties": false
},
"name": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"UnitResponseDto": {
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"additionalProperties": false,
"format": "int32"
},
"name": {
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"UpdateMedicationRequestDto": {
"required": [
"startDate",
"name",
"activeIngredient",
"medicationFormat",
"medicationFormatIconUrl",
"medicationUnit",
"schedule",
"notificationsEnabled",
"category"
],
"type": "object",
"properties": {
"startDate": {
"type": "string",
"additionalProperties": false,
"format": "date-time"
},
"endDate": {
"type": [
"null",
"string"
],
"additionalProperties": false,
"format": "date-time"
},
"name": {
"type": "string",
"additionalProperties": false
},
"activeIngredient": {
"type": "string",
"additionalProperties": false
},
"medicationFormat": {
"type": "string",
"additionalProperties": false
},
"medicationFormatIconUrl": {
"type": "string",
"additionalProperties": false
},
"medicationUnit": {
"type": "string",
"additionalProperties": false
},
"intakeInstructions": {
"type": [
"null",
"string"
],
"additionalProperties": false
},
"schedule": {
"$ref": "#/components/schemas/BaseScheduleDto"
},
"notificationsEnabled": {
"type": "boolean",
"additionalProperties": false
},
"category": {
"maxLength": 255,
"type": "string",
"additionalProperties": false
}
},
"additionalProperties": false
},
"UpdateRecordingRequestDto": {
"type": "object",
"properties": {
"recordingName": {
"maxLength": 250,
"type": [
"null",
"string"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"tags": [
{
"name": "Chatbot"
},
{
"name": "Consent"
},
{
"name": "Policy"
},
{
"name": "AppointmentType"
},
{
"name": "Appointment"
},
{
"name": "Recordings"
},
{
"name": "Article"
},
{
"name": "Category"
},
{
"name": "Tag"
},
{
"name": "Identity"
},
{
"name": "IdentityProperties"
},
{
"name": "Insights"
},
{
"name": "NoteTopic"
},
{
"name": "NoteType"
},
{
"name": "Note"
},
{
"name": "Register"
},
{
"name": "ProfileOnboarding"
},
{
"name": "DataSharing"
},
{
"name": "DataSharingRequest"
},
{
"name": "Tracking"
},
{
"name": "Intakes"
},
{
"name": "Medication"
},
{
"name": "PrefabMedications"
}
]
}