{ "openapi": "3.1.0", "info": { "title": "Huddle API", "version": "1.0.0", "description": "Read-only HTTP API over the Huddle organisation database. All endpoints are GET-only apart from the token endpoint; the API performs no writes.", "contact": { "name": "Huddle API", "url": "https://huddle-api.parentweb.online" } }, "servers": [ { "url": "https://huddle-api.parentweb.online", "description": "Current environment" } ], "tags": [ { "name": "auth", "description": "Authentication" }, { "name": "aba-authorization", "description": "Read-only view of `aba_authorization`." }, { "name": "active-appointments", "description": "Read-only view of `active_appointments`." }, { "name": "ai-document-review-documents", "description": "Read-only view of `ai_document_review_documents`." }, { "name": "ai-document-review-prompts", "description": "Read-only view of `ai_document_review_prompts`." }, { "name": "ai-document-review-submissions", "description": "Read-only view of `ai_document_review_submissions`." }, { "name": "ais-center-absences", "description": "Read-only view of `ais_center_absences`." }, { "name": "ais-generated-schedules", "description": "Read-only view of `ais_generated_schedules`." }, { "name": "ais-schedule-snapshots", "description": "Read-only view of `ais_schedule_snapshots`." }, { "name": "ais-schedule-templates", "description": "Read-only view of `ais_schedule_templates`." }, { "name": "ais-staff-schedule-audit", "description": "Read-only view of `ais_staff_schedule_audit`." }, { "name": "allergy", "description": "Read-only view of `allergy`." }, { "name": "appointment", "description": "Read-only view of `appointment`." }, { "name": "assent-withdrawal-flag", "description": "Read-only view of `assent_withdrawal_flag`." }, { "name": "assent-withdrawal-resolution", "description": "Read-only view of `assent_withdrawal_resolution`." }, { "name": "assessment-administration", "description": "Read-only view of `assessment_administration`." }, { "name": "assessment-item", "description": "Read-only view of `assessment_item`." }, { "name": "assessment-item-type", "description": "Read-only view of `assessment_item_type`." }, { "name": "assessment-item-value", "description": "Read-only view of `assessment_item_value`." }, { "name": "assessment-scores", "description": "Read-only view of `assessment_scores`." }, { "name": "assessment-type", "description": "Read-only view of `assessment_type`." }, { "name": "assessment-type-scores", "description": "Read-only view of `assessment_type_scores`." }, { "name": "assessment-types", "description": "Read-only view of `assessment_types`." }, { "name": "assessment-utilized-in-diagnosis", "description": "Read-only view of `assessment_utilized_in_diagnosis`." }, { "name": "assessments", "description": "Read-only view of `assessments`." }, { "name": "authorization-tracking", "description": "Read-only view of `authorization_tracking`." }, { "name": "binder-check", "description": "Read-only view of `binder_check`." }, { "name": "center", "description": "Read-only view of `center`." }, { "name": "chart", "description": "Read-only view of `chart`." }, { "name": "chart-flag", "description": "Read-only view of `chart_flag`." }, { "name": "chart-flags-count-view", "description": "Read-only view of `chart_flags_count_view`." }, { "name": "checked-out-sessions-today", "description": "Read-only view of `checked_out_sessions_today`." }, { "name": "checkin", "description": "Read-only view of `checkin`." }, { "name": "client", "description": "Read-only view of `client`." }, { "name": "client-allergy", "description": "Read-only view of `client_allergy`." }, { "name": "client-center-history", "description": "Read-only view of `client_center_history`." }, { "name": "client-connected-contact-connection", "description": "Read-only view of `client_connected_contact_connection`." }, { "name": "client-connected-contact-connection-new", "description": "Read-only view of `client_connected_contact_connection_new`." }, { "name": "client-diagnosis", "description": "Read-only view of `client_diagnosis`." }, { "name": "client-incident-report", "description": "Read-only view of `client_incident_report`." }, { "name": "client-insurance", "description": "Read-only view of `client_insurance`." }, { "name": "client-motivator", "description": "Read-only view of `client_motivator`." }, { "name": "client-stats", "description": "Read-only view of `client_stats`." }, { "name": "client-status-history", "description": "Read-only view of `client_status_history`." }, { "name": "client-transition-planning", "description": "Read-only view of `client_transition_planning`." }, { "name": "conditions", "description": "Read-only view of `conditions`." }, { "name": "connected-contact", "description": "Read-only view of `connected_contact`." }, { "name": "connected-contact-new", "description": "Read-only view of `connected_contact_new`." }, { "name": "coordination-of-care", "description": "Read-only view of `coordination_of_care`." }, { "name": "current-checked-in", "description": "Read-only view of `current_checked_in`." }, { "name": "data-point", "description": "Read-only view of `data_point`." }, { "name": "diagnosis", "description": "Read-only view of `diagnosis`." }, { "name": "dictation-log", "description": "Read-only view of `dictation_log`." }, { "name": "discipline", "description": "Read-only view of `discipline`." }, { "name": "fee-schedule", "description": "Read-only view of `fee_schedule`." }, { "name": "fee-schedule-view", "description": "Read-only view of `fee_schedule_view`." }, { "name": "fluency-run", "description": "Read-only view of `fluency_run`." }, { "name": "global-annotation", "description": "Read-only view of `global_annotation`." }, { "name": "global-config", "description": "Read-only view of `global_config`." }, { "name": "handwashing-log", "description": "Read-only view of `handwashing_log`." }, { "name": "holidays", "description": "Read-only view of `holidays`." }, { "name": "insurance-company", "description": "Read-only view of `insurance_company`." }, { "name": "job-title", "description": "Read-only view of `job_title`." }, { "name": "job-title-discipline", "description": "Read-only view of `job_title_discipline`." }, { "name": "job-title-mapping", "description": "Read-only view of `job_title_mapping`." }, { "name": "learner-level", "description": "Read-only view of `learner_level`." }, { "name": "learner-profile-category", "description": "Read-only view of `learner_profile_category`." }, { "name": "learner-profile-input", "description": "Read-only view of `learner_profile_input`." }, { "name": "learner-profile-save", "description": "Read-only view of `learner_profile_save`." }, { "name": "learner-update", "description": "Read-only view of `learner_update`." }, { "name": "license-certification", "description": "Read-only view of `license_certification`." }, { "name": "license-certification-credentialing-body", "description": "Read-only view of `license_certification_credentialing_body`." }, { "name": "location", "description": "Read-only view of `location`." }, { "name": "mastered-target", "description": "Read-only view of `mastered_target`." }, { "name": "note-banned-text", "description": "Read-only view of `note_banned_text`." }, { "name": "note-generation-log", "description": "Read-only view of `note_generation_log`." }, { "name": "note-question", "description": "Read-only view of `note_question`." }, { "name": "note-question-ai-review-prompt", "description": "Read-only view of `note_question_ai_review_prompt`." }, { "name": "note-question-answer", "description": "Read-only view of `note_question_answer`." }, { "name": "note-question-choice", "description": "Read-only view of `note_question_choice`." }, { "name": "note-question-sentence", "description": "Read-only view of `note_question_sentence`." }, { "name": "note-question-two-tiered-choice-primary", "description": "Read-only view of `note_question_two_tiered_choice_primary`." }, { "name": "note-question-two-tiered-choice-secondary", "description": "Read-only view of `note_question_two_tiered_choice_secondary`." }, { "name": "note-question-type", "description": "Read-only view of `note_question_type`." }, { "name": "note-template", "description": "Read-only view of `note_template`." }, { "name": "note-template-question-bridge", "description": "Read-only view of `note_template_question_bridge`." }, { "name": "notifications", "description": "Read-only view of `notifications`." }, { "name": "parent-contact-log", "description": "Read-only view of `parent_contact_log`." }, { "name": "parent-contact-meeting-barrier-option", "description": "Read-only view of `parent_contact_meeting_barrier_option`." }, { "name": "parent-contact-parent-reported-reason-option", "description": "Read-only view of `parent_contact_parent_reported_reason_option`." }, { "name": "parent-training-goal", "description": "Read-only view of `parent_training_goal`." }, { "name": "parent-training-goal-status-option", "description": "Read-only view of `parent_training_goal_status_option`." }, { "name": "parent-training-log", "description": "Read-only view of `parent_training_log`." }, { "name": "parent-training-log-goal-entry", "description": "Read-only view of `parent_training_log_goal_entry`." }, { "name": "reports", "description": "Read-only view of `reports`." }, { "name": "rules-engine-logs", "description": "Read-only view of `rules_engine_logs`." }, { "name": "scheduler-centers", "description": "Read-only view of `scheduler_centers`." }, { "name": "school", "description": "Read-only view of `school`." }, { "name": "service", "description": "Read-only view of `service`." }, { "name": "signature", "description": "Read-only view of `signature`." }, { "name": "spot-goal", "description": "Read-only view of `spot_goal`." }, { "name": "staff", "description": "Read-only view of `staff`." }, { "name": "staff-certification-licensure", "description": "Read-only view of `staff_certification_licensure`." }, { "name": "staff-education", "description": "Read-only view of `staff_education`." }, { "name": "staff-insurance-credentialing", "description": "Read-only view of `staff_insurance_credentialing`." }, { "name": "staff-leave", "description": "Read-only view of `staff_leave`." }, { "name": "standard-rate", "description": "Read-only view of `standard_rate`." }, { "name": "suggested-edit", "description": "Read-only view of `suggested_edit`." }, { "name": "supervising-bcba-connection", "description": "Read-only view of `supervising_bcba_connection`." }, { "name": "supervising-staff-connection", "description": "Read-only view of `supervising_staff_connection`." }, { "name": "treatment-plan", "description": "Read-only view of `treatment_plan`." }, { "name": "treatment-plan-ai-review-audit", "description": "Read-only view of `treatment_plan_ai_review_audit`." }, { "name": "treatment-plan-payer-rule", "description": "Read-only view of `treatment_plan_payer_rule`." }, { "name": "treatment-plan-revision", "description": "Read-only view of `treatment_plan_revision`." }, { "name": "trial-entry", "description": "Read-only view of `trial_entry`." }, { "name": "trial-entry-edit", "description": "Read-only view of `trial_entry_edit`." } ], "paths": { "/api/public/v1/auth/token": { "post": { "operationId": "issueToken", "summary": "Exchange client credentials for an access token", "description": "Send your `client_id` and `client_secret` to receive a short-lived bearer token. Send that token as `Authorization: Bearer ` on every other request.", "tags": [ "auth" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "client_id", "client_secret" ], "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" } } } } } }, "responses": { "200": { "description": "A bearer token.", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string", "example": "Bearer" }, "expires_in": { "type": "integer", "example": 900 }, "scopes": { "type": "array", "items": { "type": "string" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/api/public/v1/aba-authorization": { "get": { "operationId": "list_aba_authorization", "summary": "List aba-authorization", "description": "Read-only view of `aba_authorization`.", "tags": [ "aba-authorization" ], "security": [ { "bearerAuth": [ "read:aba-authorization" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "start_date", "end_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client", "in": "query", "description": "Exact-match filter on `client`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "client_insurance_id", "in": "query", "description": "Exact-match filter on `client_insurance_id`.", "schema": { "type": "string" } }, { "name": "direct_units", "in": "query", "description": "Exact-match filter on `direct_units`.", "schema": { "type": "string" } }, { "name": "protocol_modification_units", "in": "query", "description": "Exact-match filter on `protocol_modification_units`.", "schema": { "type": "string" } }, { "name": "parent_training_units", "in": "query", "description": "Exact-match filter on `parent_training_units`.", "schema": { "type": "string" } }, { "name": "assessment_units", "in": "query", "description": "Exact-match filter on `assessment_units`.", "schema": { "type": "string" } }, { "name": "supporting_assessment_units", "in": "query", "description": "Exact-match filter on `supporting_assessment_units`.", "schema": { "type": "string" } }, { "name": "group_parent_training_units", "in": "query", "description": "Exact-match filter on `group_parent_training_units`.", "schema": { "type": "string" } }, { "name": "two_to_one_direct_units", "in": "query", "description": "Exact-match filter on `two_to_one_direct_units`.", "schema": { "type": "string" } }, { "name": "treatment_planning_units", "in": "query", "description": "Exact-match filter on `treatment_planning_units`.", "schema": { "type": "string" } }, { "name": "authorization_number", "in": "query", "description": "Exact-match filter on `authorization_number`.", "schema": { "type": "string" } }, { "name": "discipline", "in": "query", "description": "Exact-match filter on `discipline`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "authorization_documentation", "in": "query", "description": "Exact-match filter on `authorization_documentation`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "client_insurance_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client_insurance.id`.", "nullable": true }, "direct_units": { "type": "integer", "nullable": true }, "protocol_modification_units": { "type": "integer", "nullable": true }, "parent_training_units": { "type": "integer", "nullable": true }, "assessment_units": { "type": "integer", "nullable": true }, "supporting_assessment_units": { "type": "integer", "nullable": true }, "group_parent_training_units": { "type": "integer", "nullable": true }, "two_to_one_direct_units": { "type": "integer", "nullable": true }, "treatment_planning_units": { "type": "integer", "nullable": true }, "authorization_number": { "type": "string", "nullable": true }, "discipline": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "notes": { "type": "string", "nullable": true }, "authorization_documentation": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/aba-authorization/{id}": { "get": { "operationId": "get_aba_authorization", "summary": "Get a single aba-authorization record", "tags": [ "aba-authorization" ], "security": [ { "bearerAuth": [ "read:aba-authorization" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "client_insurance_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client_insurance.id`.", "nullable": true }, "direct_units": { "type": "integer", "nullable": true }, "protocol_modification_units": { "type": "integer", "nullable": true }, "parent_training_units": { "type": "integer", "nullable": true }, "assessment_units": { "type": "integer", "nullable": true }, "supporting_assessment_units": { "type": "integer", "nullable": true }, "group_parent_training_units": { "type": "integer", "nullable": true }, "two_to_one_direct_units": { "type": "integer", "nullable": true }, "treatment_planning_units": { "type": "integer", "nullable": true }, "authorization_number": { "type": "string", "nullable": true }, "discipline": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "notes": { "type": "string", "nullable": true }, "authorization_documentation": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/active-appointments": { "get": { "operationId": "list_active_appointments", "summary": "List active-appointments", "description": "Read-only view of `active_appointments`.", "tags": [ "active-appointments" ], "security": [ { "bearerAuth": [ "read:active-appointments" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "deleted_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Exact-match filter on `service`.", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Exact-match filter on `location`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "staff_signature", "in": "query", "description": "Exact-match filter on `staff_signature`.", "schema": { "type": "string" } }, { "name": "note_from_huddle_charts", "in": "query", "description": "Exact-match filter on `note_from_huddle_charts`.", "schema": { "type": "string" } }, { "name": "authorization_id", "in": "query", "description": "Exact-match filter on `authorization_id`.", "schema": { "type": "string" } }, { "name": "Units", "in": "query", "description": "Exact-match filter on `Units`.", "schema": { "type": "string" } }, { "name": "start_time", "in": "query", "description": "Exact-match filter on `start_time`.", "schema": { "type": "string" } }, { "name": "end_time", "in": "query", "description": "Exact-match filter on `end_time`.", "schema": { "type": "string" } }, { "name": "documentation_completed", "in": "query", "description": "Exact-match filter on `documentation_completed`.", "schema": { "type": "string" } }, { "name": "deleted_at", "in": "query", "description": "Exact-match filter on `deleted_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "service": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "location": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `location.id`.", "nullable": true }, "status": { "type": "string", "nullable": true }, "staff_signature": { "type": "string", "nullable": true }, "note_from_huddle_charts": { "type": "string", "nullable": true }, "authorization_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `aba_authorization.id`.", "nullable": true }, "Units": { "type": "integer", "format": "int64", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "format": "date-time", "nullable": true }, "documentation_completed": { "type": "string", "format": "date-time", "nullable": true }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/active-appointments/{id}": { "get": { "operationId": "get_active_appointments", "summary": "Get a single active-appointments record", "tags": [ "active-appointments" ], "security": [ { "bearerAuth": [ "read:active-appointments" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "service": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "location": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `location.id`.", "nullable": true }, "status": { "type": "string", "nullable": true }, "staff_signature": { "type": "string", "nullable": true }, "note_from_huddle_charts": { "type": "string", "nullable": true }, "authorization_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `aba_authorization.id`.", "nullable": true }, "Units": { "type": "integer", "format": "int64", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "format": "date-time", "nullable": true }, "documentation_completed": { "type": "string", "format": "date-time", "nullable": true }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ai-document-review-documents": { "get": { "operationId": "list_ai_document_review_documents", "summary": "List ai-document-review-documents", "description": "Read-only view of `ai_document_review_documents`.", "tags": [ "ai-document-review-documents" ], "security": [ { "bearerAuth": [ "read:ai-document-review-documents" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "is_active", "in": "query", "description": "Exact-match filter on `is_active`.", "schema": { "type": "string" } }, { "name": "custom_text", "in": "query", "description": "Exact-match filter on `custom_text`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "custom_text": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ai-document-review-documents/{id}": { "get": { "operationId": "get_ai_document_review_documents", "summary": "Get a single ai-document-review-documents record", "tags": [ "ai-document-review-documents" ], "security": [ { "bearerAuth": [ "read:ai-document-review-documents" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "custom_text": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ai-document-review-prompts": { "get": { "operationId": "list_ai_document_review_prompts", "summary": "List ai-document-review-prompts", "description": "Read-only view of `ai_document_review_prompts`.", "tags": [ "ai-document-review-prompts" ], "security": [ { "bearerAuth": [ "read:ai-document-review-prompts" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } }, { "name": "prompt", "in": "query", "description": "Exact-match filter on `prompt`.", "schema": { "type": "string" } }, { "name": "document_review_id", "in": "query", "description": "Exact-match filter on `document_review_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "prompt": { "type": "string", "nullable": true }, "document_review_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `ai_document_review_documents.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ai-document-review-prompts/{id}": { "get": { "operationId": "get_ai_document_review_prompts", "summary": "Get a single ai-document-review-prompts record", "tags": [ "ai-document-review-prompts" ], "security": [ { "bearerAuth": [ "read:ai-document-review-prompts" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "prompt": { "type": "string", "nullable": true }, "document_review_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `ai_document_review_documents.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ai-document-review-submissions": { "get": { "operationId": "list_ai_document_review_submissions", "summary": "List ai-document-review-submissions", "description": "Read-only view of `ai_document_review_submissions`.", "tags": [ "ai-document-review-submissions" ], "security": [ { "bearerAuth": [ "read:ai-document-review-submissions" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "submitted_by_email", "in": "query", "description": "Exact-match filter on `submitted_by_email`.", "schema": { "type": "string" } }, { "name": "submitted_by_name", "in": "query", "description": "Exact-match filter on `submitted_by_name`.", "schema": { "type": "string" } }, { "name": "document_review_id", "in": "query", "description": "Exact-match filter on `document_review_id`.", "schema": { "type": "string" } }, { "name": "total_score", "in": "query", "description": "Exact-match filter on `total_score`.", "schema": { "type": "string" } }, { "name": "flagged_count", "in": "query", "description": "Exact-match filter on `flagged_count`.", "schema": { "type": "string" } }, { "name": "approved_count", "in": "query", "description": "Exact-match filter on `approved_count`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "submitted_by_email": { "type": "string", "nullable": true }, "submitted_by_name": { "type": "string", "nullable": true }, "document_review_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `ai_document_review_documents.id`.", "nullable": true }, "total_score": { "type": "number", "nullable": true }, "flagged_count": { "type": "integer", "nullable": true }, "approved_count": { "type": "integer", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ai-document-review-submissions/{id}": { "get": { "operationId": "get_ai_document_review_submissions", "summary": "Get a single ai-document-review-submissions record", "tags": [ "ai-document-review-submissions" ], "security": [ { "bearerAuth": [ "read:ai-document-review-submissions" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "submitted_by_email": { "type": "string", "nullable": true }, "submitted_by_name": { "type": "string", "nullable": true }, "document_review_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `ai_document_review_documents.id`.", "nullable": true }, "total_score": { "type": "number", "nullable": true }, "flagged_count": { "type": "integer", "nullable": true }, "approved_count": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-center-absences": { "get": { "operationId": "list_ais_center_absences", "summary": "List ais-center-absences", "description": "Read-only view of `ais_center_absences`.", "tags": [ "ais-center-absences" ], "security": [ { "bearerAuth": [ "read:ais-center-absences" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "center_id", "updated_at" ], "default": "center_id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "center_id": { "type": "integer", "format": "int64", "nullable": true }, "saved_absences": { "type": "object", "nullable": true }, "cs_team_absences": { "type": "object", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "outside_providers": { "type": "object", "nullable": true }, "outside_provider_assignments": { "type": "object", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-center-absences/{id}": { "get": { "operationId": "get_ais_center_absences", "summary": "Get a single ais-center-absences record", "tags": [ "ais-center-absences" ], "security": [ { "bearerAuth": [ "read:ais-center-absences" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `center_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "center_id": { "type": "integer", "format": "int64", "nullable": true }, "saved_absences": { "type": "object", "nullable": true }, "cs_team_absences": { "type": "object", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "outside_providers": { "type": "object", "nullable": true }, "outside_provider_assignments": { "type": "object", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-generated-schedules": { "get": { "operationId": "list_ais_generated_schedules", "summary": "List ais-generated-schedules", "description": "Read-only view of `ais_generated_schedules`.", "tags": [ "ais-generated-schedules" ], "security": [ { "bearerAuth": [ "read:ais-generated-schedules" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "center_id", "schedule_date", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "schedule_date", "in": "query", "description": "Exact-match filter on `schedule_date`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "center_id": { "type": "integer", "format": "int64", "nullable": true }, "schedule_date": { "type": "string", "format": "date", "nullable": true }, "schedule_data": { "type": "object", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-generated-schedules/{id}": { "get": { "operationId": "get_ais_generated_schedules", "summary": "Get a single ais-generated-schedules record", "tags": [ "ais-generated-schedules" ], "security": [ { "bearerAuth": [ "read:ais-generated-schedules" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `center_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "center_id": { "type": "integer", "format": "int64", "nullable": true }, "schedule_date": { "type": "string", "format": "date", "nullable": true }, "schedule_data": { "type": "object", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-schedule-snapshots": { "get": { "operationId": "list_ais_schedule_snapshots", "summary": "List ais-schedule-snapshots", "description": "Read-only view of `ais_schedule_snapshots`.", "tags": [ "ais-schedule-snapshots" ], "security": [ { "bearerAuth": [ "read:ais-schedule-snapshots" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "schedule_date", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "schedule_date", "in": "query", "description": "Exact-match filter on `schedule_date`.", "schema": { "type": "string" } }, { "name": "snapshot_type", "in": "query", "description": "Exact-match filter on `snapshot_type`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "schedule_notes", "in": "query", "description": "Exact-match filter on `schedule_notes`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "nullable": true }, "schedule_date": { "type": "string", "format": "date", "nullable": true }, "snapshot_type": { "type": "string", "nullable": true }, "schedule_data": { "type": "object", "nullable": true }, "absences_data": { "type": "object", "nullable": true }, "cs_team_absences_data": { "type": "object", "nullable": true }, "created_by": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "schedule_notes": { "type": "string", "description": "Long-form notes shown at top of schedule UI and exports. Separate from short history caption `notes`.", "nullable": true }, "input_data": { "type": "object", "description": "Self-contained input bundle (roster_json, provided_absences, cs_team_absences, engine_config, outside_provider_assignments, tough_day, version, provenance) captured at generation time. Populated only for snapshot_type='generated'; always NULL for 'published'/'restored'.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-schedule-snapshots/{id}": { "get": { "operationId": "get_ais_schedule_snapshots", "summary": "Get a single ais-schedule-snapshots record", "tags": [ "ais-schedule-snapshots" ], "security": [ { "bearerAuth": [ "read:ais-schedule-snapshots" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "nullable": true }, "schedule_date": { "type": "string", "format": "date", "nullable": true }, "snapshot_type": { "type": "string", "nullable": true }, "schedule_data": { "type": "object", "nullable": true }, "absences_data": { "type": "object", "nullable": true }, "cs_team_absences_data": { "type": "object", "nullable": true }, "created_by": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "schedule_notes": { "type": "string", "description": "Long-form notes shown at top of schedule UI and exports. Separate from short history caption `notes`.", "nullable": true }, "input_data": { "type": "object", "description": "Self-contained input bundle (roster_json, provided_absences, cs_team_absences, engine_config, outside_provider_assignments, tough_day, version, provenance) captured at generation time. Populated only for snapshot_type='generated'; always NULL for 'published'/'restored'.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-schedule-templates": { "get": { "operationId": "list_ais_schedule_templates", "summary": "List ais-schedule-templates", "description": "Read-only view of `ais_schedule_templates`.", "tags": [ "ais-schedule-templates" ], "security": [ { "bearerAuth": [ "read:ais-schedule-templates" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "center_id", "updated_at" ], "default": "center_id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "slot_key", "in": "query", "description": "Exact-match filter on `slot_key`.", "schema": { "type": "string" } }, { "name": "staff_count", "in": "query", "description": "Exact-match filter on `staff_count`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "updated_by_staff_id", "in": "query", "description": "Exact-match filter on `updated_by_staff_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "center_id": { "type": "integer", "format": "int64", "nullable": true }, "slot_key": { "type": "string", "nullable": true }, "template_data": { "type": "object", "nullable": true }, "staff_count": { "type": "integer", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_by": { "type": "string", "nullable": true }, "updated_by_staff_id": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-schedule-templates/{id}": { "get": { "operationId": "get_ais_schedule_templates", "summary": "Get a single ais-schedule-templates record", "tags": [ "ais-schedule-templates" ], "security": [ { "bearerAuth": [ "read:ais-schedule-templates" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `center_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "center_id": { "type": "integer", "format": "int64", "nullable": true }, "slot_key": { "type": "string", "nullable": true }, "template_data": { "type": "object", "nullable": true }, "staff_count": { "type": "integer", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_by": { "type": "string", "nullable": true }, "updated_by_staff_id": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-staff-schedule-audit": { "get": { "operationId": "list_ais_staff_schedule_audit", "summary": "List ais-staff-schedule-audit", "description": "Read-only view of `ais_staff_schedule_audit`.", "tags": [ "ais-staff-schedule-audit" ], "security": [ { "bearerAuth": [ "read:ais-staff-schedule-audit" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "schedule_date", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "schedule_date", "in": "query", "description": "Exact-match filter on `schedule_date`.", "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Exact-match filter on `section`.", "schema": { "type": "string" } }, { "name": "pod_id", "in": "query", "description": "Exact-match filter on `pod_id`.", "schema": { "type": "string" } }, { "name": "staff_name", "in": "query", "description": "Exact-match filter on `staff_name`.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Exact-match filter on `role`.", "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "Exact-match filter on `action`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "nullable": true }, "schedule_date": { "type": "string", "format": "date", "nullable": true }, "section": { "type": "string", "nullable": true }, "pod_id": { "type": "string", "nullable": true }, "staff_name": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "created_by": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/ais-staff-schedule-audit/{id}": { "get": { "operationId": "get_ais_staff_schedule_audit", "summary": "Get a single ais-staff-schedule-audit record", "tags": [ "ais-staff-schedule-audit" ], "security": [ { "bearerAuth": [ "read:ais-staff-schedule-audit" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "nullable": true }, "schedule_date": { "type": "string", "format": "date", "nullable": true }, "section": { "type": "string", "nullable": true }, "pod_id": { "type": "string", "nullable": true }, "staff_name": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "created_by": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/allergy": { "get": { "operationId": "list_allergy", "summary": "List allergy", "description": "Read-only view of `allergy`.", "tags": [ "allergy" ], "security": [ { "bearerAuth": [ "read:allergy" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } }, { "name": "allergy_image", "in": "query", "description": "Exact-match filter on `allergy_image`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "allergy_image": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/allergy/{id}": { "get": { "operationId": "get_allergy", "summary": "Get a single allergy record", "tags": [ "allergy" ], "security": [ { "bearerAuth": [ "read:allergy" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "allergy_image": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/appointment": { "get": { "operationId": "list_appointment", "summary": "List appointment", "description": "Read-only view of `appointment`.", "tags": [ "appointment" ], "security": [ { "bearerAuth": [ "read:appointment" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "deleted_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Exact-match filter on `service`.", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Exact-match filter on `location`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "staff_signature", "in": "query", "description": "Exact-match filter on `staff_signature`.", "schema": { "type": "string" } }, { "name": "note_from_huddle_charts", "in": "query", "description": "Exact-match filter on `note_from_huddle_charts`.", "schema": { "type": "string" } }, { "name": "authorization_id", "in": "query", "description": "Exact-match filter on `authorization_id`.", "schema": { "type": "string" } }, { "name": "Units", "in": "query", "description": "Exact-match filter on `Units`.", "schema": { "type": "string" } }, { "name": "start_time", "in": "query", "description": "Exact-match filter on `start_time`.", "schema": { "type": "string" } }, { "name": "end_time", "in": "query", "description": "Exact-match filter on `end_time`.", "schema": { "type": "string" } }, { "name": "documentation_completed", "in": "query", "description": "Exact-match filter on `documentation_completed`.", "schema": { "type": "string" } }, { "name": "deleted_at", "in": "query", "description": "Exact-match filter on `deleted_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "service": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "location": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `location.id`.", "nullable": true }, "status": { "type": "string", "nullable": true }, "staff_signature": { "type": "string", "nullable": true }, "note_from_huddle_charts": { "type": "string", "nullable": true }, "authorization_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `aba_authorization.id`.", "nullable": true }, "Units": { "type": "integer", "format": "int64", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "format": "date-time", "nullable": true }, "documentation_completed": { "type": "string", "format": "date-time", "nullable": true }, "deleted_at": { "type": "string", "format": "date-time", "description": "used for soft deletes", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/appointment/{id}": { "get": { "operationId": "get_appointment", "summary": "Get a single appointment record", "tags": [ "appointment" ], "security": [ { "bearerAuth": [ "read:appointment" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "service": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "location": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `location.id`.", "nullable": true }, "status": { "type": "string", "nullable": true }, "staff_signature": { "type": "string", "nullable": true }, "note_from_huddle_charts": { "type": "string", "nullable": true }, "authorization_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `aba_authorization.id`.", "nullable": true }, "Units": { "type": "integer", "format": "int64", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "format": "date-time", "nullable": true }, "documentation_completed": { "type": "string", "format": "date-time", "nullable": true }, "deleted_at": { "type": "string", "format": "date-time", "description": "used for soft deletes", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assent-withdrawal-flag": { "get": { "operationId": "list_assent_withdrawal_flag", "summary": "List assent-withdrawal-flag", "description": "Read-only view of `assent_withdrawal_flag`.", "tags": [ "assent-withdrawal-flag" ], "security": [ { "bearerAuth": [ "read:assent-withdrawal-flag" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Exact-match filter on `appointment_id`.", "schema": { "type": "string" } }, { "name": "date_of_service", "in": "query", "description": "Exact-match filter on `date_of_service`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "date_of_service": { "type": "string", "format": "date", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assent-withdrawal-flag/{id}": { "get": { "operationId": "get_assent_withdrawal_flag", "summary": "Get a single assent-withdrawal-flag record", "tags": [ "assent-withdrawal-flag" ], "security": [ { "bearerAuth": [ "read:assent-withdrawal-flag" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "date_of_service": { "type": "string", "format": "date", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assent-withdrawal-resolution": { "get": { "operationId": "list_assent_withdrawal_resolution", "summary": "List assent-withdrawal-resolution", "description": "Read-only view of `assent_withdrawal_resolution`.", "tags": [ "assent-withdrawal-resolution" ], "security": [ { "bearerAuth": [ "read:assent-withdrawal-resolution" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "resolved_by", "in": "query", "description": "Exact-match filter on `resolved_by`.", "schema": { "type": "string" } }, { "name": "note", "in": "query", "description": "Exact-match filter on `note`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "resolved_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "note": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "description": "Resolution time. Clears flags outstanding as of this moment; later flags can re-lock.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assent-withdrawal-resolution/{id}": { "get": { "operationId": "get_assent_withdrawal_resolution", "summary": "Get a single assent-withdrawal-resolution record", "tags": [ "assent-withdrawal-resolution" ], "security": [ { "bearerAuth": [ "read:assent-withdrawal-resolution" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "resolved_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "note": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "description": "Resolution time. Clears flags outstanding as of this moment; later flags can re-lock.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-administration": { "get": { "operationId": "list_assessment_administration", "summary": "List assessment-administration", "description": "Read-only view of `assessment_administration`.", "tags": [ "assessment-administration" ], "security": [ { "bearerAuth": [ "read:assessment-administration" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Exact-match filter on `date`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "assessment_type", "in": "query", "description": "Exact-match filter on `assessment_type`.", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Exact-match filter on `url`.", "schema": { "type": "string" } }, { "name": "significance_level", "in": "query", "description": "Exact-match filter on `significance_level`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "date": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "assessment_type": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_type.id`.", "nullable": true }, "url": { "type": "string", "nullable": true }, "significance_level": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-administration/{id}": { "get": { "operationId": "get_assessment_administration", "summary": "Get a single assessment-administration record", "tags": [ "assessment-administration" ], "security": [ { "bearerAuth": [ "read:assessment-administration" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "date": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "assessment_type": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_type.id`.", "nullable": true }, "url": { "type": "string", "nullable": true }, "significance_level": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-item": { "get": { "operationId": "list_assessment_item", "summary": "List assessment-item", "description": "Read-only view of `assessment_item`.", "tags": [ "assessment-item" ], "security": [ { "bearerAuth": [ "read:assessment-item" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "assessment_item_type_id", "in": "query", "description": "Exact-match filter on `assessment_item_type_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "assessment_item_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_item_type.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-item/{id}": { "get": { "operationId": "get_assessment_item", "summary": "Get a single assessment-item record", "tags": [ "assessment-item" ], "security": [ { "bearerAuth": [ "read:assessment-item" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "assessment_item_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_item_type.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-item-type": { "get": { "operationId": "list_assessment_item_type", "summary": "List assessment-item-type", "description": "Read-only view of `assessment_item_type`.", "tags": [ "assessment-item-type" ], "security": [ { "bearerAuth": [ "read:assessment-item-type" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "assessment_type_id", "in": "query", "description": "Exact-match filter on `assessment_type_id`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "returns_as_string", "in": "query", "description": "Exact-match filter on `returns_as_string`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_type.id`.", "nullable": true }, "name": { "type": "string", "nullable": true }, "returns_as_string": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-item-type/{id}": { "get": { "operationId": "get_assessment_item_type", "summary": "Get a single assessment-item-type record", "tags": [ "assessment-item-type" ], "security": [ { "bearerAuth": [ "read:assessment-item-type" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_type.id`.", "nullable": true }, "name": { "type": "string", "nullable": true }, "returns_as_string": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-item-value": { "get": { "operationId": "list_assessment_item_value", "summary": "List assessment-item-value", "description": "Read-only view of `assessment_item_value`.", "tags": [ "assessment-item-value" ], "security": [ { "bearerAuth": [ "read:assessment-item-value" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "assessment_administration_id", "in": "query", "description": "Exact-match filter on `assessment_administration_id`.", "schema": { "type": "string" } }, { "name": "assessment_item_id", "in": "query", "description": "Exact-match filter on `assessment_item_id`.", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Exact-match filter on `value`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_administration_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_administration.id`.", "nullable": true }, "assessment_item_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_item.id`.", "nullable": true }, "value": { "type": "string", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-item-value/{id}": { "get": { "operationId": "get_assessment_item_value", "summary": "Get a single assessment-item-value record", "tags": [ "assessment-item-value" ], "security": [ { "bearerAuth": [ "read:assessment-item-value" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_administration_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_administration.id`.", "nullable": true }, "assessment_item_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_item.id`.", "nullable": true }, "value": { "type": "string", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-scores": { "get": { "operationId": "list_assessment_scores", "summary": "List assessment-scores", "description": "Read-only view of `assessment_scores`.", "tags": [ "assessment-scores" ], "security": [ { "bearerAuth": [ "read:assessment-scores" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "assessment_id", "in": "query", "description": "Exact-match filter on `assessment_id`.", "schema": { "type": "string" } }, { "name": "assessment_type_score_id", "in": "query", "description": "Exact-match filter on `assessment_type_score_id`.", "schema": { "type": "string" } }, { "name": "score", "in": "query", "description": "Exact-match filter on `score`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessments.id`.", "nullable": true }, "assessment_type_score_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_type_scores.id`.", "nullable": true }, "score": { "type": "number", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-scores/{id}": { "get": { "operationId": "get_assessment_scores", "summary": "Get a single assessment-scores record", "tags": [ "assessment-scores" ], "security": [ { "bearerAuth": [ "read:assessment-scores" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessments.id`.", "nullable": true }, "assessment_type_score_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_type_scores.id`.", "nullable": true }, "score": { "type": "number", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-type": { "get": { "operationId": "list_assessment_type", "summary": "List assessment-type", "description": "Read-only view of `assessment_type`.", "tags": [ "assessment-type" ], "security": [ { "bearerAuth": [ "read:assessment-type" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Exact-match filter on `url`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-type/{id}": { "get": { "operationId": "get_assessment_type", "summary": "Get a single assessment-type record", "tags": [ "assessment-type" ], "security": [ { "bearerAuth": [ "read:assessment-type" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-type-scores": { "get": { "operationId": "list_assessment_type_scores", "summary": "List assessment-type-scores", "description": "Read-only view of `assessment_type_scores`.", "tags": [ "assessment-type-scores" ], "security": [ { "bearerAuth": [ "read:assessment-type-scores" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "assessment_score_name", "in": "query", "description": "Exact-match filter on `assessment_score_name`.", "schema": { "type": "string" } }, { "name": "assessment_type_id", "in": "query", "description": "Exact-match filter on `assessment_type_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_score_name": { "type": "string", "nullable": true }, "assessment_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_types.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-type-scores/{id}": { "get": { "operationId": "get_assessment_type_scores", "summary": "Get a single assessment-type-scores record", "tags": [ "assessment-type-scores" ], "security": [ { "bearerAuth": [ "read:assessment-type-scores" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_score_name": { "type": "string", "nullable": true }, "assessment_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_types.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-types": { "get": { "operationId": "list_assessment_types", "summary": "List assessment-types", "description": "Read-only view of `assessment_types`.", "tags": [ "assessment-types" ], "security": [ { "bearerAuth": [ "read:assessment-types" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "assessment_name", "in": "query", "description": "Exact-match filter on `assessment_name`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_name": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-types/{id}": { "get": { "operationId": "get_assessment_types", "summary": "Get a single assessment-types record", "tags": [ "assessment-types" ], "security": [ { "bearerAuth": [ "read:assessment-types" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "assessment_name": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-utilized-in-diagnosis": { "get": { "operationId": "list_assessment_utilized_in_diagnosis", "summary": "List assessment-utilized-in-diagnosis", "description": "Read-only view of `assessment_utilized_in_diagnosis`.", "tags": [ "assessment-utilized-in-diagnosis" ], "security": [ { "bearerAuth": [ "read:assessment-utilized-in-diagnosis" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessment-utilized-in-diagnosis/{id}": { "get": { "operationId": "get_assessment_utilized_in_diagnosis", "summary": "Get a single assessment-utilized-in-diagnosis record", "tags": [ "assessment-utilized-in-diagnosis" ], "security": [ { "bearerAuth": [ "read:assessment-utilized-in-diagnosis" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessments": { "get": { "operationId": "list_assessments", "summary": "List assessments", "description": "Read-only view of `assessments`.", "tags": [ "assessments" ], "security": [ { "bearerAuth": [ "read:assessments" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "assessment_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "assessment_date", "in": "query", "description": "Exact-match filter on `assessment_date`.", "schema": { "type": "string" } }, { "name": "assessment_type_id", "in": "query", "description": "Exact-match filter on `assessment_type_id`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "is_archived", "in": "query", "description": "Exact-match filter on `is_archived`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "assessment_date": { "type": "string", "format": "date", "nullable": true }, "assessment_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_types.id`.", "nullable": true }, "notes": { "type": "string", "nullable": true }, "is_archived": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/assessments/{id}": { "get": { "operationId": "get_assessments", "summary": "Get a single assessments record", "tags": [ "assessments" ], "security": [ { "bearerAuth": [ "read:assessments" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "assessment_date": { "type": "string", "format": "date", "nullable": true }, "assessment_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `assessment_types.id`.", "nullable": true }, "notes": { "type": "string", "nullable": true }, "is_archived": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/authorization-tracking": { "get": { "operationId": "list_authorization_tracking", "summary": "List authorization-tracking", "description": "Read-only view of `authorization_tracking`.", "tags": [ "authorization-tracking" ], "security": [ { "bearerAuth": [ "read:authorization-tracking" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "current_auth_start_date", "current_auth_end_date", "new_auth_start_date", "new_auth_end_date", "auth_sent_date", "initial_determination_date", "created_at", "updated_at", "completed_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "cr_authorization_id", "in": "query", "description": "Exact-match filter on `cr_authorization_id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "insurance_company_id", "in": "query", "description": "Exact-match filter on `insurance_company_id`.", "schema": { "type": "string" } }, { "name": "client_name", "in": "query", "description": "Exact-match filter on `client_name`.", "schema": { "type": "string" } }, { "name": "insurance_company", "in": "query", "description": "Exact-match filter on `insurance_company`.", "schema": { "type": "string" } }, { "name": "current_auth_start_date", "in": "query", "description": "Exact-match filter on `current_auth_start_date`.", "schema": { "type": "string" } }, { "name": "current_auth_end_date", "in": "query", "description": "Exact-match filter on `current_auth_end_date`.", "schema": { "type": "string" } }, { "name": "manager", "in": "query", "description": "Exact-match filter on `manager`.", "schema": { "type": "string" } }, { "name": "provider_supplier", "in": "query", "description": "Exact-match filter on `provider_supplier`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "new_auth_start_date", "in": "query", "description": "Exact-match filter on `new_auth_start_date`.", "schema": { "type": "string" } }, { "name": "new_auth_end_date", "in": "query", "description": "Exact-match filter on `new_auth_end_date`.", "schema": { "type": "string" } }, { "name": "auth_sent_date", "in": "query", "description": "Exact-match filter on `auth_sent_date`.", "schema": { "type": "string" } }, { "name": "auth_sent_by", "in": "query", "description": "Exact-match filter on `auth_sent_by`.", "schema": { "type": "string" } }, { "name": "initial_determination_date", "in": "query", "description": "Exact-match filter on `initial_determination_date`.", "schema": { "type": "string" } }, { "name": "initial_determination", "in": "query", "description": "Exact-match filter on `initial_determination`.", "schema": { "type": "string" } }, { "name": "auth_in_ehr", "in": "query", "description": "Exact-match filter on `auth_in_ehr`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Exact-match filter on `source`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } }, { "name": "completed_at", "in": "query", "description": "Exact-match filter on `completed_at`.", "schema": { "type": "string" } }, { "name": "completed_by", "in": "query", "description": "Exact-match filter on `completed_by`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "cr_authorization_id": { "type": "integer", "nullable": true }, "client_id": { "type": "integer", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "insurance_company_id": { "type": "integer", "description": "This is a Foreign Key to `insurance_company.id`.", "nullable": true }, "client_name": { "type": "string", "nullable": true }, "insurance_company": { "type": "string", "nullable": true }, "current_auth_start_date": { "type": "string", "format": "date", "nullable": true }, "current_auth_end_date": { "type": "string", "format": "date", "nullable": true }, "manager": { "type": "string", "nullable": true }, "provider_supplier": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "new_auth_start_date": { "type": "string", "format": "date", "nullable": true }, "new_auth_end_date": { "type": "string", "format": "date", "nullable": true }, "auth_sent_date": { "type": "string", "format": "date", "nullable": true }, "auth_sent_by": { "type": "integer", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "initial_determination_date": { "type": "string", "format": "date", "nullable": true }, "initial_determination": { "type": "string", "nullable": true }, "auth_in_ehr": { "type": "boolean", "nullable": true }, "notes": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_by": { "type": "integer", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/authorization-tracking/{id}": { "get": { "operationId": "get_authorization_tracking", "summary": "Get a single authorization-tracking record", "tags": [ "authorization-tracking" ], "security": [ { "bearerAuth": [ "read:authorization-tracking" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "cr_authorization_id": { "type": "integer", "nullable": true }, "client_id": { "type": "integer", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "insurance_company_id": { "type": "integer", "description": "This is a Foreign Key to `insurance_company.id`.", "nullable": true }, "client_name": { "type": "string", "nullable": true }, "insurance_company": { "type": "string", "nullable": true }, "current_auth_start_date": { "type": "string", "format": "date", "nullable": true }, "current_auth_end_date": { "type": "string", "format": "date", "nullable": true }, "manager": { "type": "string", "nullable": true }, "provider_supplier": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "new_auth_start_date": { "type": "string", "format": "date", "nullable": true }, "new_auth_end_date": { "type": "string", "format": "date", "nullable": true }, "auth_sent_date": { "type": "string", "format": "date", "nullable": true }, "auth_sent_by": { "type": "integer", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "initial_determination_date": { "type": "string", "format": "date", "nullable": true }, "initial_determination": { "type": "string", "nullable": true }, "auth_in_ehr": { "type": "boolean", "nullable": true }, "notes": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_by": { "type": "integer", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/binder-check": { "get": { "operationId": "list_binder_check", "summary": "List binder-check", "description": "Read-only view of `binder_check`.", "tags": [ "binder-check" ], "security": [ { "bearerAuth": [ "read:binder-check" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Exact-match filter on `date`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "note", "in": "query", "description": "Exact-match filter on `note`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "child_is_making_progress", "in": "query", "description": "Exact-match filter on `child_is_making_progress`.", "schema": { "type": "string" } }, { "name": "data_are_consistently_collected", "in": "query", "description": "Exact-match filter on `data_are_consistently_collected`.", "schema": { "type": "string" } }, { "name": "databased_decions_are_made_frequent_enough", "in": "query", "description": "Exact-match filter on `databased_decions_are_made_frequent_enough`.", "schema": { "type": "string" } }, { "name": "behaviors_targetted_for_reduction_are_decreasing", "in": "query", "description": "Exact-match filter on `behaviors_targetted_for_reduction_are_decreasing`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "note": { "type": "string", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "child_is_making_progress": { "type": "boolean", "nullable": true }, "data_are_consistently_collected": { "type": "boolean", "nullable": true }, "databased_decions_are_made_frequent_enough": { "type": "boolean", "nullable": true }, "behaviors_targetted_for_reduction_are_decreasing": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/binder-check/{id}": { "get": { "operationId": "get_binder_check", "summary": "Get a single binder-check record", "tags": [ "binder-check" ], "security": [ { "bearerAuth": [ "read:binder-check" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "note": { "type": "string", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "child_is_making_progress": { "type": "boolean", "nullable": true }, "data_are_consistently_collected": { "type": "boolean", "nullable": true }, "databased_decions_are_made_frequent_enough": { "type": "boolean", "nullable": true }, "behaviors_targetted_for_reduction_are_decreasing": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/center": { "get": { "operationId": "list_center", "summary": "List center", "description": "Read-only view of `center`.", "tags": [ "center" ], "security": [ { "bearerAuth": [ "read:center" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "center_name", "in": "query", "description": "Exact-match filter on `center_name`.", "schema": { "type": "string" } }, { "name": "Address Line 1", "in": "query", "description": "Exact-match filter on `Address Line 1`.", "schema": { "type": "string" } }, { "name": "Address Line 2", "in": "query", "description": "Exact-match filter on `Address Line 2`.", "schema": { "type": "string" } }, { "name": "City", "in": "query", "description": "Exact-match filter on `City`.", "schema": { "type": "string" } }, { "name": "Zip", "in": "query", "description": "Exact-match filter on `Zip`.", "schema": { "type": "string" } }, { "name": "date_opened", "in": "query", "description": "Exact-match filter on `date_opened`.", "schema": { "type": "string" } }, { "name": "date_closed", "in": "query", "description": "Exact-match filter on `date_closed`.", "schema": { "type": "string" } }, { "name": "phone_number", "in": "query", "description": "Exact-match filter on `phone_number`.", "schema": { "type": "string" } }, { "name": "fax_number", "in": "query", "description": "Exact-match filter on `fax_number`.", "schema": { "type": "string" } }, { "name": "center_status", "in": "query", "description": "Exact-match filter on `center_status`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Exact-match filter on `region`.", "schema": { "type": "string" } }, { "name": "crm_center_value", "in": "query", "description": "Exact-match filter on `crm_center_value`.", "schema": { "type": "string" } }, { "name": "hris_center_value", "in": "query", "description": "Exact-match filter on `hris_center_value`.", "schema": { "type": "string" } }, { "name": "can_be_client", "in": "query", "description": "Exact-match filter on `can_be_client`.", "schema": { "type": "string" } }, { "name": "crm_object_id", "in": "query", "description": "Exact-match filter on `crm_object_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "center_name": { "type": "string", "nullable": true }, "Address Line 1": { "type": "string", "nullable": true }, "Address Line 2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Zip": { "type": "string", "nullable": true }, "date_opened": { "type": "string", "format": "date", "nullable": true }, "date_closed": { "type": "string", "format": "date", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "fax_number": { "type": "string", "nullable": true }, "center_status": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "crm_center_value": { "type": "string", "nullable": true }, "hris_center_value": { "type": "string", "nullable": true }, "can_be_client": { "type": "boolean", "description": "boolean field for whether a center has clients", "nullable": true }, "crm_object_id": { "type": "integer", "format": "int64", "description": "HubSpot custom object record identifier for center", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/center/{id}": { "get": { "operationId": "get_center", "summary": "Get a single center record", "tags": [ "center" ], "security": [ { "bearerAuth": [ "read:center" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "center_name": { "type": "string", "nullable": true }, "Address Line 1": { "type": "string", "nullable": true }, "Address Line 2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Zip": { "type": "string", "nullable": true }, "date_opened": { "type": "string", "format": "date", "nullable": true }, "date_closed": { "type": "string", "format": "date", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "fax_number": { "type": "string", "nullable": true }, "center_status": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "crm_center_value": { "type": "string", "nullable": true }, "hris_center_value": { "type": "string", "nullable": true }, "can_be_client": { "type": "boolean", "description": "boolean field for whether a center has clients", "nullable": true }, "crm_object_id": { "type": "integer", "format": "int64", "description": "HubSpot custom object record identifier for center", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/chart": { "get": { "operationId": "list_chart", "summary": "List chart", "description": "Read-only view of `chart`.", "tags": [ "chart" ], "security": [ { "bearerAuth": [ "read:chart" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "client", "in": "query", "description": "Exact-match filter on `client`.", "schema": { "type": "string" } }, { "name": "domain", "in": "query", "description": "Exact-match filter on `domain`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } }, { "name": "appear_on_data_sheet", "in": "query", "description": "Exact-match filter on `appear_on_data_sheet`.", "schema": { "type": "string" } }, { "name": "treatment_plan_goal_number", "in": "query", "description": "Exact-match filter on `treatment_plan_goal_number`.", "schema": { "type": "string" } }, { "name": "data_collection_option", "in": "query", "description": "Exact-match filter on `data_collection_option`.", "schema": { "type": "string" } }, { "name": "discipline", "in": "query", "description": "Exact-match filter on `discipline`.", "schema": { "type": "string" } }, { "name": "former_system_ID", "in": "query", "description": "Exact-match filter on `former_system_ID`.", "schema": { "type": "string" } }, { "name": "last_binder_check", "in": "query", "description": "Exact-match filter on `last_binder_check`.", "schema": { "type": "string" } }, { "name": "last_change_harder", "in": "query", "description": "Exact-match filter on `last_change_harder`.", "schema": { "type": "string" } }, { "name": "change_harders_last_30_days", "in": "query", "description": "Exact-match filter on `change_harders_last_30_days`.", "schema": { "type": "string" } }, { "name": "trials_last_30_days", "in": "query", "description": "Exact-match filter on `trials_last_30_days`.", "schema": { "type": "string" } }, { "name": "data_points_last_30_days", "in": "query", "description": "Exact-match filter on `data_points_last_30_days`.", "schema": { "type": "string" } }, { "name": "last_data_taken", "in": "query", "description": "Exact-match filter on `last_data_taken`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "client": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "domain": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "appear_on_data_sheet": { "type": "boolean", "nullable": true }, "treatment_plan_goal_number": { "type": "integer", "nullable": true }, "data_collection_option": { "type": "string", "nullable": true }, "discipline": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "former_system_ID": { "type": "integer", "format": "int64", "nullable": true }, "last_binder_check": { "type": "string", "format": "date-time", "nullable": true }, "last_change_harder": { "type": "string", "format": "date-time", "nullable": true }, "change_harders_last_30_days": { "type": "integer", "nullable": true }, "trials_last_30_days": { "type": "integer", "nullable": true }, "data_points_last_30_days": { "type": "integer", "nullable": true }, "last_data_taken": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/chart/{id}": { "get": { "operationId": "get_chart", "summary": "Get a single chart record", "tags": [ "chart" ], "security": [ { "bearerAuth": [ "read:chart" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "client": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "domain": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "appear_on_data_sheet": { "type": "boolean", "nullable": true }, "treatment_plan_goal_number": { "type": "integer", "nullable": true }, "data_collection_option": { "type": "string", "nullable": true }, "discipline": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "former_system_ID": { "type": "integer", "format": "int64", "nullable": true }, "last_binder_check": { "type": "string", "format": "date-time", "nullable": true }, "last_change_harder": { "type": "string", "format": "date-time", "nullable": true }, "change_harders_last_30_days": { "type": "integer", "nullable": true }, "trials_last_30_days": { "type": "integer", "nullable": true }, "data_points_last_30_days": { "type": "integer", "nullable": true }, "last_data_taken": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/chart-flag": { "get": { "operationId": "list_chart_flag", "summary": "List chart-flag", "description": "Read-only view of `chart_flag`.", "tags": [ "chart-flag" ], "security": [ { "bearerAuth": [ "read:chart-flag" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "is_adding", "in": "query", "description": "Exact-match filter on `is_adding`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "is_adding": { "type": "boolean", "nullable": true }, "type": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/chart-flag/{id}": { "get": { "operationId": "get_chart_flag", "summary": "Get a single chart-flag record", "tags": [ "chart-flag" ], "security": [ { "bearerAuth": [ "read:chart-flag" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "is_adding": { "type": "boolean", "nullable": true }, "type": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/chart-flags-count-view": { "get": { "operationId": "list_chart_flags_count_view", "summary": "List chart-flags-count-view", "description": "Read-only view of `chart_flags_count_view`.", "tags": [ "chart-flags-count-view" ], "security": [ { "bearerAuth": [ "read:chart-flags-count-view" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "chart_id" ], "default": "chart_id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "flag_count", "in": "query", "description": "Exact-match filter on `flag_count`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "flag_count": { "type": "integer", "format": "int64", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/chart-flags-count-view/{id}": { "get": { "operationId": "get_chart_flags_count_view", "summary": "Get a single chart-flags-count-view record", "tags": [ "chart-flags-count-view" ], "security": [ { "bearerAuth": [ "read:chart-flags-count-view" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `chart_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "flag_count": { "type": "integer", "format": "int64", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/checked-out-sessions-today": { "get": { "operationId": "list_checked_out_sessions_today", "summary": "List checked-out-sessions-today", "description": "Read-only view of `checked_out_sessions_today`.", "tags": [ "checked-out-sessions-today" ], "security": [ { "bearerAuth": [ "read:checked-out-sessions-today" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "check_in_id" ], "default": "check_in_id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "Exact-match filter on `first_name`.", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Exact-match filter on `last_name`.", "schema": { "type": "string" } }, { "name": "preferred_first_name", "in": "query", "description": "Exact-match filter on `preferred_first_name`.", "schema": { "type": "string" } }, { "name": "check_in_time", "in": "query", "description": "Exact-match filter on `check_in_time`.", "schema": { "type": "string" } }, { "name": "check_out_time", "in": "query", "description": "Exact-match filter on `check_out_time`.", "schema": { "type": "string" } }, { "name": "check_in_id", "in": "query", "description": "Exact-match filter on `check_in_id`.", "schema": { "type": "string" } }, { "name": "check_out_id", "in": "query", "description": "Exact-match filter on `check_out_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "check_in_time": { "type": "string", "format": "date-time", "nullable": true }, "check_out_time": { "type": "string", "format": "date-time", "nullable": true }, "check_in_id": { "type": "integer", "format": "int64", "nullable": true }, "check_out_id": { "type": "integer", "format": "int64", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/checked-out-sessions-today/{id}": { "get": { "operationId": "get_checked_out_sessions_today", "summary": "Get a single checked-out-sessions-today record", "tags": [ "checked-out-sessions-today" ], "security": [ { "bearerAuth": [ "read:checked-out-sessions-today" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `check_in_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "check_in_time": { "type": "string", "format": "date-time", "nullable": true }, "check_out_time": { "type": "string", "format": "date-time", "nullable": true }, "check_in_id": { "type": "integer", "format": "int64", "nullable": true }, "check_out_id": { "type": "integer", "format": "int64", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/checkin": { "get": { "operationId": "list_checkin", "summary": "List checkin", "description": "Read-only view of `checkin`.", "tags": [ "checkin" ], "security": [ { "bearerAuth": [ "read:checkin" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Exact-match filter on `date`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "status": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/checkin/{id}": { "get": { "operationId": "get_checkin", "summary": "Get a single checkin record", "tags": [ "checkin" ], "security": [ { "bearerAuth": [ "read:checkin" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "status": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client": { "get": { "operationId": "list_client", "summary": "List client", "description": "Read-only view of `client`.", "tags": [ "client" ], "security": [ { "bearerAuth": [ "read:client" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "Exact-match filter on `first_name`.", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Exact-match filter on `last_name`.", "schema": { "type": "string" } }, { "name": "date_of_birth", "in": "query", "description": "Exact-match filter on `date_of_birth`.", "schema": { "type": "string" } }, { "name": "preferred_first_name", "in": "query", "description": "Exact-match filter on `preferred_first_name`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "lives_with", "in": "query", "description": "Exact-match filter on `lives_with`.", "schema": { "type": "string" } }, { "name": "middle_name", "in": "query", "description": "Exact-match filter on `middle_name`.", "schema": { "type": "string" } }, { "name": "client_gender", "in": "query", "description": "Exact-match filter on `client_gender`.", "schema": { "type": "string" } }, { "name": "client_status", "in": "query", "description": "Exact-match filter on `client_status`.", "schema": { "type": "string" } }, { "name": "first_date_of_service", "in": "query", "description": "Exact-match filter on `first_date_of_service`.", "schema": { "type": "string" } }, { "name": "recieves_aba", "in": "query", "description": "Exact-match filter on `recieves_aba`.", "schema": { "type": "string" } }, { "name": "recieves_speech", "in": "query", "description": "Exact-match filter on `recieves_speech`.", "schema": { "type": "string" } }, { "name": "recieves_ot", "in": "query", "description": "Exact-match filter on `recieves_ot`.", "schema": { "type": "string" } }, { "name": "last_date_of_service", "in": "query", "description": "Exact-match filter on `last_date_of_service`.", "schema": { "type": "string" } }, { "name": "crm_object_id", "in": "query", "description": "Exact-match filter on `crm_object_id`.", "schema": { "type": "string" } }, { "name": "external_ehr_id", "in": "query", "description": "Exact-match filter on `external_ehr_id`.", "schema": { "type": "string" } }, { "name": "pod", "in": "query", "description": "Exact-match filter on `pod`.", "schema": { "type": "string" } }, { "name": "learner_profile_last_updated", "in": "query", "description": "Exact-match filter on `learner_profile_last_updated`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lives_with": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `connected_contact.id`.", "nullable": true }, "middle_name": { "type": "string", "nullable": true }, "client_gender": { "type": "string", "nullable": true }, "client_status": { "type": "string", "nullable": true }, "first_date_of_service": { "type": "string", "format": "date", "nullable": true }, "disciplines_provided": { "type": "array", "nullable": true }, "recieves_aba": { "type": "boolean", "nullable": true }, "recieves_speech": { "type": "boolean", "nullable": true }, "recieves_ot": { "type": "boolean", "nullable": true }, "last_date_of_service": { "type": "string", "format": "date", "nullable": true }, "crm_object_id": { "type": "integer", "format": "int64", "nullable": true }, "external_ehr_id": { "type": "integer", "format": "int64", "nullable": true }, "pod": { "type": "integer", "nullable": true }, "learner_profile_last_updated": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client/{id}": { "get": { "operationId": "get_client", "summary": "Get a single client record", "tags": [ "client" ], "security": [ { "bearerAuth": [ "read:client" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lives_with": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `connected_contact.id`.", "nullable": true }, "middle_name": { "type": "string", "nullable": true }, "client_gender": { "type": "string", "nullable": true }, "client_status": { "type": "string", "nullable": true }, "first_date_of_service": { "type": "string", "format": "date", "nullable": true }, "disciplines_provided": { "type": "array", "nullable": true }, "recieves_aba": { "type": "boolean", "nullable": true }, "recieves_speech": { "type": "boolean", "nullable": true }, "recieves_ot": { "type": "boolean", "nullable": true }, "last_date_of_service": { "type": "string", "format": "date", "nullable": true }, "crm_object_id": { "type": "integer", "format": "int64", "nullable": true }, "external_ehr_id": { "type": "integer", "format": "int64", "nullable": true }, "pod": { "type": "integer", "nullable": true }, "learner_profile_last_updated": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-allergy": { "get": { "operationId": "list_client_allergy", "summary": "List client-allergy", "description": "Read-only view of `client_allergy`.", "tags": [ "client-allergy" ], "security": [ { "bearerAuth": [ "read:client-allergy" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "allergy_id", "in": "query", "description": "Exact-match filter on `allergy_id`.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Exact-match filter on `severity`.", "schema": { "type": "string" } }, { "name": "known_since", "in": "query", "description": "Exact-match filter on `known_since`.", "schema": { "type": "string" } }, { "name": "protocol", "in": "query", "description": "Exact-match filter on `protocol`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "allergy_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `allergy.id`.", "nullable": true }, "severity": { "type": "string", "nullable": true }, "known_since": { "type": "string", "format": "date", "nullable": true }, "protocol": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-allergy/{id}": { "get": { "operationId": "get_client_allergy", "summary": "Get a single client-allergy record", "tags": [ "client-allergy" ], "security": [ { "bearerAuth": [ "read:client-allergy" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "allergy_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `allergy.id`.", "nullable": true }, "severity": { "type": "string", "nullable": true }, "known_since": { "type": "string", "format": "date", "nullable": true }, "protocol": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-center-history": { "get": { "operationId": "list_client_center_history", "summary": "List client-center-history", "description": "Read-only view of `client_center_history`.", "tags": [ "client-center-history" ], "security": [ { "bearerAuth": [ "read:client-center-history" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "start_date", "end_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-center-history/{id}": { "get": { "operationId": "get_client_center_history", "summary": "Get a single client-center-history record", "tags": [ "client-center-history" ], "security": [ { "bearerAuth": [ "read:client-center-history" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-connected-contact-connection": { "get": { "operationId": "list_client_connected_contact_connection", "summary": "List client-connected-contact-connection", "description": "Read-only view of `client_connected_contact_connection`.", "tags": [ "client-connected-contact-connection" ], "security": [ { "bearerAuth": [ "read:client-connected-contact-connection" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "connected_contact_id", "in": "query", "description": "Exact-match filter on `connected_contact_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "connected_contact_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `connected_contact.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-connected-contact-connection/{id}": { "get": { "operationId": "get_client_connected_contact_connection", "summary": "Get a single client-connected-contact-connection record", "tags": [ "client-connected-contact-connection" ], "security": [ { "bearerAuth": [ "read:client-connected-contact-connection" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "connected_contact_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `connected_contact.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-connected-contact-connection-new": { "get": { "operationId": "list_client_connected_contact_connection_new", "summary": "List client-connected-contact-connection-new", "description": "Read-only view of `client_connected_contact_connection_new`.", "tags": [ "client-connected-contact-connection-new" ], "security": [ { "bearerAuth": [ "read:client-connected-contact-connection-new" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "connected_contact_id", "in": "query", "description": "Exact-match filter on `connected_contact_id`.", "schema": { "type": "string" } }, { "name": "relationship_to_client", "in": "query", "description": "Exact-match filter on `relationship_to_client`.", "schema": { "type": "string" } }, { "name": "is_guarantor", "in": "query", "description": "Exact-match filter on `is_guarantor`.", "schema": { "type": "string" } }, { "name": "can_pickup", "in": "query", "description": "Exact-match filter on `can_pickup`.", "schema": { "type": "string" } }, { "name": "is_emergency_contact", "in": "query", "description": "Exact-match filter on `is_emergency_contact`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "connected_contact_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `connected_contact_new.id`.", "nullable": true }, "relationship_to_client": { "type": "string", "nullable": true }, "is_guarantor": { "type": "boolean", "nullable": true }, "can_pickup": { "type": "boolean", "nullable": true }, "is_emergency_contact": { "type": "boolean", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-connected-contact-connection-new/{id}": { "get": { "operationId": "get_client_connected_contact_connection_new", "summary": "Get a single client-connected-contact-connection-new record", "tags": [ "client-connected-contact-connection-new" ], "security": [ { "bearerAuth": [ "read:client-connected-contact-connection-new" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "connected_contact_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `connected_contact_new.id`.", "nullable": true }, "relationship_to_client": { "type": "string", "nullable": true }, "is_guarantor": { "type": "boolean", "nullable": true }, "can_pickup": { "type": "boolean", "nullable": true }, "is_emergency_contact": { "type": "boolean", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-diagnosis": { "get": { "operationId": "list_client_diagnosis", "summary": "List client-diagnosis", "description": "Read-only view of `client_diagnosis`.", "tags": [ "client-diagnosis" ], "security": [ { "bearerAuth": [ "read:client-diagnosis" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "diagnosis_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "diagnosis_id", "in": "query", "description": "Exact-match filter on `diagnosis_id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "diagnosis_date", "in": "query", "description": "Exact-match filter on `diagnosis_date`.", "schema": { "type": "string" } }, { "name": "diagnosed_by", "in": "query", "description": "Exact-match filter on `diagnosed_by`.", "schema": { "type": "string" } }, { "name": "assessments_utilized", "in": "query", "description": "Exact-match filter on `assessments_utilized`.", "schema": { "type": "string" } }, { "name": "diagnostic_report", "in": "query", "description": "Exact-match filter on `diagnostic_report`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "diagnosis_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `diagnosis.id`.", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "diagnosis_date": { "type": "string", "format": "date", "nullable": true }, "diagnosed_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `connected_contact.id`.", "nullable": true }, "assessments_utilized": { "type": "string", "nullable": true }, "diagnostic_report": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-diagnosis/{id}": { "get": { "operationId": "get_client_diagnosis", "summary": "Get a single client-diagnosis record", "tags": [ "client-diagnosis" ], "security": [ { "bearerAuth": [ "read:client-diagnosis" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "diagnosis_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `diagnosis.id`.", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "diagnosis_date": { "type": "string", "format": "date", "nullable": true }, "diagnosed_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `connected_contact.id`.", "nullable": true }, "assessments_utilized": { "type": "string", "nullable": true }, "diagnostic_report": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-incident-report": { "get": { "operationId": "list_client_incident_report", "summary": "List client-incident-report", "description": "Read-only view of `client_incident_report`.", "tags": [ "client-incident-report" ], "security": [ { "bearerAuth": [ "read:client-incident-report" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "report_at", "incident_at", "therapist_signature_date", "witness_signature_date", "countersign_signature_date", "parent_signature_date", "created_at", "updated_at", "submitted_at", "completed_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "created_by_staff_id", "in": "query", "description": "Exact-match filter on `created_by_staff_id`.", "schema": { "type": "string" } }, { "name": "provider_staff_id", "in": "query", "description": "Exact-match filter on `provider_staff_id`.", "schema": { "type": "string" } }, { "name": "provider_position", "in": "query", "description": "Exact-match filter on `provider_position`.", "schema": { "type": "string" } }, { "name": "witness_staff_id", "in": "query", "description": "Exact-match filter on `witness_staff_id`.", "schema": { "type": "string" } }, { "name": "report_at", "in": "query", "description": "Exact-match filter on `report_at`.", "schema": { "type": "string" } }, { "name": "incident_at", "in": "query", "description": "Exact-match filter on `incident_at`.", "schema": { "type": "string" } }, { "name": "place_of_incident", "in": "query", "description": "Exact-match filter on `place_of_incident`.", "schema": { "type": "string" } }, { "name": "place_of_incident_other", "in": "query", "description": "Exact-match filter on `place_of_incident_other`.", "schema": { "type": "string" } }, { "name": "nature_of_incident", "in": "query", "description": "Exact-match filter on `nature_of_incident`.", "schema": { "type": "string" } }, { "name": "medical_attention_required", "in": "query", "description": "Exact-match filter on `medical_attention_required`.", "schema": { "type": "string" } }, { "name": "method_of_communication", "in": "query", "description": "Exact-match filter on `method_of_communication`.", "schema": { "type": "string" } }, { "name": "incident_description", "in": "query", "description": "Exact-match filter on `incident_description`.", "schema": { "type": "string" } }, { "name": "follow_up_actions", "in": "query", "description": "Exact-match filter on `follow_up_actions`.", "schema": { "type": "string" } }, { "name": "therapist_signature_url", "in": "query", "description": "Exact-match filter on `therapist_signature_url`.", "schema": { "type": "string" } }, { "name": "therapist_signature_date", "in": "query", "description": "Exact-match filter on `therapist_signature_date`.", "schema": { "type": "string" } }, { "name": "witness_signature_url", "in": "query", "description": "Exact-match filter on `witness_signature_url`.", "schema": { "type": "string" } }, { "name": "witness_signature_date", "in": "query", "description": "Exact-match filter on `witness_signature_date`.", "schema": { "type": "string" } }, { "name": "countersign_signature_url", "in": "query", "description": "Exact-match filter on `countersign_signature_url`.", "schema": { "type": "string" } }, { "name": "countersign_signature_date", "in": "query", "description": "Exact-match filter on `countersign_signature_date`.", "schema": { "type": "string" } }, { "name": "parent_signature_url", "in": "query", "description": "Exact-match filter on `parent_signature_url`.", "schema": { "type": "string" } }, { "name": "parent_signature_date", "in": "query", "description": "Exact-match filter on `parent_signature_date`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "pdf_url", "in": "query", "description": "Exact-match filter on `pdf_url`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } }, { "name": "countersigned_by_staff_id", "in": "query", "description": "Exact-match filter on `countersigned_by_staff_id`.", "schema": { "type": "string" } }, { "name": "countersigned_by_role", "in": "query", "description": "Exact-match filter on `countersigned_by_role`.", "schema": { "type": "string" } }, { "name": "submitted_at", "in": "query", "description": "Exact-match filter on `submitted_at`.", "schema": { "type": "string" } }, { "name": "submitted_by_staff_id", "in": "query", "description": "Exact-match filter on `submitted_by_staff_id`.", "schema": { "type": "string" } }, { "name": "completed_at", "in": "query", "description": "Exact-match filter on `completed_at`.", "schema": { "type": "string" } }, { "name": "parent_signature_recorded_by_staff_id", "in": "query", "description": "Exact-match filter on `parent_signature_recorded_by_staff_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "created_by_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "provider_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "provider_position": { "type": "string", "nullable": true }, "witness_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "report_at": { "type": "string", "format": "date-time", "nullable": true }, "incident_at": { "type": "string", "format": "date-time", "nullable": true }, "place_of_incident": { "type": "string", "nullable": true }, "place_of_incident_other": { "type": "string", "nullable": true }, "nature_of_incident": { "type": "string", "nullable": true }, "medical_attention_required": { "type": "boolean", "nullable": true }, "method_of_communication": { "type": "string", "nullable": true }, "incident_description": { "type": "string", "nullable": true }, "follow_up_actions": { "type": "string", "nullable": true }, "therapist_signature_url": { "type": "string", "nullable": true }, "therapist_signature_date": { "type": "string", "format": "date", "nullable": true }, "witness_signature_url": { "type": "string", "nullable": true }, "witness_signature_date": { "type": "string", "format": "date", "nullable": true }, "countersign_signature_url": { "type": "string", "nullable": true }, "countersign_signature_date": { "type": "string", "format": "date", "nullable": true }, "parent_signature_url": { "type": "string", "nullable": true }, "parent_signature_date": { "type": "string", "format": "date", "nullable": true }, "status": { "type": "string", "nullable": true }, "pdf_url": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "countersigned_by_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "countersigned_by_role": { "type": "string", "nullable": true }, "submitted_at": { "type": "string", "format": "date-time", "nullable": true }, "submitted_by_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "parent_signature_recorded_by_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-incident-report/{id}": { "get": { "operationId": "get_client_incident_report", "summary": "Get a single client-incident-report record", "tags": [ "client-incident-report" ], "security": [ { "bearerAuth": [ "read:client-incident-report" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "created_by_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "provider_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "provider_position": { "type": "string", "nullable": true }, "witness_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "report_at": { "type": "string", "format": "date-time", "nullable": true }, "incident_at": { "type": "string", "format": "date-time", "nullable": true }, "place_of_incident": { "type": "string", "nullable": true }, "place_of_incident_other": { "type": "string", "nullable": true }, "nature_of_incident": { "type": "string", "nullable": true }, "medical_attention_required": { "type": "boolean", "nullable": true }, "method_of_communication": { "type": "string", "nullable": true }, "incident_description": { "type": "string", "nullable": true }, "follow_up_actions": { "type": "string", "nullable": true }, "therapist_signature_url": { "type": "string", "nullable": true }, "therapist_signature_date": { "type": "string", "format": "date", "nullable": true }, "witness_signature_url": { "type": "string", "nullable": true }, "witness_signature_date": { "type": "string", "format": "date", "nullable": true }, "countersign_signature_url": { "type": "string", "nullable": true }, "countersign_signature_date": { "type": "string", "format": "date", "nullable": true }, "parent_signature_url": { "type": "string", "nullable": true }, "parent_signature_date": { "type": "string", "format": "date", "nullable": true }, "status": { "type": "string", "nullable": true }, "pdf_url": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "countersigned_by_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "countersigned_by_role": { "type": "string", "nullable": true }, "submitted_at": { "type": "string", "format": "date-time", "nullable": true }, "submitted_by_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "parent_signature_recorded_by_staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-insurance": { "get": { "operationId": "list_client_insurance", "summary": "List client-insurance", "description": "Read-only view of `client_insurance`.", "tags": [ "client-insurance" ], "security": [ { "bearerAuth": [ "read:client-insurance" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "start_date", "end_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "insurance_id", "in": "query", "description": "Exact-match filter on `insurance_id`.", "schema": { "type": "string" } }, { "name": "subscriber_connected_contact_id", "in": "query", "description": "Exact-match filter on `subscriber_connected_contact_id`.", "schema": { "type": "string" } }, { "name": "funded", "in": "query", "description": "Exact-match filter on `funded`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "patient_relationship_to_client", "in": "query", "description": "Exact-match filter on `patient_relationship_to_client`.", "schema": { "type": "string" } }, { "name": "is_sca", "in": "query", "description": "Exact-match filter on `is_sca`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } }, { "name": "covers_aba", "in": "query", "description": "Exact-match filter on `covers_aba`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "policy_group_feca_number", "in": "query", "description": "Exact-match filter on `policy_group_feca_number`.", "schema": { "type": "string" } }, { "name": "subscriber_id", "in": "query", "description": "Exact-match filter on `subscriber_id`.", "schema": { "type": "string" } }, { "name": "covers_speech", "in": "query", "description": "Exact-match filter on `covers_speech`.", "schema": { "type": "string" } }, { "name": "covers_ot", "in": "query", "description": "Exact-match filter on `covers_ot`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "insurance_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `insurance_company.id`.", "nullable": true }, "subscriber_connected_contact_id": { "type": "integer", "format": "int64", "nullable": true }, "funded": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "patient_relationship_to_client": { "type": "string", "nullable": true }, "is_sca": { "type": "boolean", "nullable": true }, "type": { "type": "string", "nullable": true }, "covers_aba": { "type": "boolean", "nullable": true }, "notes": { "type": "string", "nullable": true }, "policy_group_feca_number": { "type": "string", "nullable": true }, "subscriber_id": { "type": "string", "nullable": true }, "covers_speech": { "type": "boolean", "nullable": true }, "covers_ot": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-insurance/{id}": { "get": { "operationId": "get_client_insurance", "summary": "Get a single client-insurance record", "tags": [ "client-insurance" ], "security": [ { "bearerAuth": [ "read:client-insurance" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "insurance_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `insurance_company.id`.", "nullable": true }, "subscriber_connected_contact_id": { "type": "integer", "format": "int64", "nullable": true }, "funded": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "patient_relationship_to_client": { "type": "string", "nullable": true }, "is_sca": { "type": "boolean", "nullable": true }, "type": { "type": "string", "nullable": true }, "covers_aba": { "type": "boolean", "nullable": true }, "notes": { "type": "string", "nullable": true }, "policy_group_feca_number": { "type": "string", "nullable": true }, "subscriber_id": { "type": "string", "nullable": true }, "covers_speech": { "type": "boolean", "nullable": true }, "covers_ot": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-motivator": { "get": { "operationId": "list_client_motivator", "summary": "List client-motivator", "description": "Read-only view of `client_motivator`.", "tags": [ "client-motivator" ], "security": [ { "bearerAuth": [ "read:client-motivator" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "client", "in": "query", "description": "Exact-match filter on `client`.", "schema": { "type": "string" } }, { "name": "is_active", "in": "query", "description": "Exact-match filter on `is_active`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "client": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "is_active": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-motivator/{id}": { "get": { "operationId": "get_client_motivator", "summary": "Get a single client-motivator record", "tags": [ "client-motivator" ], "security": [ { "bearerAuth": [ "read:client-motivator" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "client": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "is_active": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-stats": { "get": { "operationId": "list_client_stats", "summary": "List client-stats", "description": "Read-only view of `client_stats`.", "tags": [ "client-stats" ], "security": [ { "bearerAuth": [ "read:client-stats" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "center_name", "in": "query", "description": "Exact-match filter on `center_name`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Exact-match filter on `region`.", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "Exact-match filter on `first_name`.", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Exact-match filter on `last_name`.", "schema": { "type": "string" } }, { "name": "client_status", "in": "query", "description": "Exact-match filter on `client_status`.", "schema": { "type": "string" } }, { "name": "change_harders_last_30_days", "in": "query", "description": "Exact-match filter on `change_harders_last_30_days`.", "schema": { "type": "string" } }, { "name": "trials_last_30_days", "in": "query", "description": "Exact-match filter on `trials_last_30_days`.", "schema": { "type": "string" } }, { "name": "data_points_last_30_days", "in": "query", "description": "Exact-match filter on `data_points_last_30_days`.", "schema": { "type": "string" } }, { "name": "chart_count", "in": "query", "description": "Exact-match filter on `chart_count`.", "schema": { "type": "string" } }, { "name": "last_data_taken", "in": "query", "description": "Exact-match filter on `last_data_taken`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "nullable": true }, "center_name": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "client_status": { "type": "string", "nullable": true }, "change_harders_last_30_days": { "type": "integer", "format": "int64", "nullable": true }, "trials_last_30_days": { "type": "integer", "format": "int64", "nullable": true }, "data_points_last_30_days": { "type": "integer", "format": "int64", "nullable": true }, "chart_count": { "type": "integer", "format": "int64", "nullable": true }, "last_data_taken": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-stats/{id}": { "get": { "operationId": "get_client_stats", "summary": "Get a single client-stats record", "tags": [ "client-stats" ], "security": [ { "bearerAuth": [ "read:client-stats" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "nullable": true }, "center_name": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "client_status": { "type": "string", "nullable": true }, "change_harders_last_30_days": { "type": "integer", "format": "int64", "nullable": true }, "trials_last_30_days": { "type": "integer", "format": "int64", "nullable": true }, "data_points_last_30_days": { "type": "integer", "format": "int64", "nullable": true }, "chart_count": { "type": "integer", "format": "int64", "nullable": true }, "last_data_taken": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-status-history": { "get": { "operationId": "list_client_status_history", "summary": "List client-status-history", "description": "Read-only view of `client_status_history`.", "tags": [ "client-status-history" ], "security": [ { "bearerAuth": [ "read:client-status-history" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "start_date", "end_date", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "status": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-status-history/{id}": { "get": { "operationId": "get_client_status_history", "summary": "Get a single client-status-history record", "tags": [ "client-status-history" ], "security": [ { "bearerAuth": [ "read:client-status-history" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "status": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-transition-planning": { "get": { "operationId": "list_client_transition_planning", "summary": "List client-transition-planning", "description": "Read-only view of `client_transition_planning`.", "tags": [ "client-transition-planning" ], "security": [ { "bearerAuth": [ "read:client-transition-planning" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "estimated_transition_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "estimated_transition_date", "in": "query", "description": "Exact-match filter on `estimated_transition_date`.", "schema": { "type": "string" } }, { "name": "transition_status", "in": "query", "description": "Exact-match filter on `transition_status`.", "schema": { "type": "string" } }, { "name": "transition_notes", "in": "query", "description": "Exact-match filter on `transition_notes`.", "schema": { "type": "string" } }, { "name": "client_swap_confirmed", "in": "query", "description": "Exact-match filter on `client_swap_confirmed`.", "schema": { "type": "string" } }, { "name": "client_swap_id", "in": "query", "description": "Exact-match filter on `client_swap_id`.", "schema": { "type": "string" } }, { "name": "transition_is_complete", "in": "query", "description": "Exact-match filter on `transition_is_complete`.", "schema": { "type": "string" } }, { "name": "utilization_range", "in": "query", "description": "Exact-match filter on `utilization_range`.", "schema": { "type": "string" } }, { "name": "unexcused_absences", "in": "query", "description": "Exact-match filter on `unexcused_absences`.", "schema": { "type": "string" } }, { "name": "risk_factors", "in": "query", "description": "Exact-match filter on `risk_factors`.", "schema": { "type": "string" } }, { "name": "current_level", "in": "query", "description": "Exact-match filter on `current_level`.", "schema": { "type": "string" } }, { "name": "manager_transitions_meeting", "in": "query", "description": "Exact-match filter on `manager_transitions_meeting`.", "schema": { "type": "string" } }, { "name": "graduation_report", "in": "query", "description": "Exact-match filter on `graduation_report`.", "schema": { "type": "string" } }, { "name": "transition_checklist", "in": "query", "description": "Exact-match filter on `transition_checklist`.", "schema": { "type": "string" } }, { "name": "recommended_transition_timeline", "in": "query", "description": "Exact-match filter on `recommended_transition_timeline`.", "schema": { "type": "string" } }, { "name": "next_grad_report_due", "in": "query", "description": "Exact-match filter on `next_grad_report_due`.", "schema": { "type": "string" } }, { "name": "proposed_next_placement", "in": "query", "description": "Exact-match filter on `proposed_next_placement`.", "schema": { "type": "string" } }, { "name": "peer_review", "in": "query", "description": "Exact-match filter on `peer_review`.", "schema": { "type": "string" } }, { "name": "clinical_decision_is_yes", "in": "query", "description": "Exact-match filter on `clinical_decision_is_yes`.", "schema": { "type": "string" } }, { "name": "parent_decision_is_yes", "in": "query", "description": "Exact-match filter on `parent_decision_is_yes`.", "schema": { "type": "string" } }, { "name": "reason_for_discharge", "in": "query", "description": "Exact-match filter on `reason_for_discharge`.", "schema": { "type": "string" } }, { "name": "next_placement", "in": "query", "description": "Exact-match filter on `next_placement`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "estimated_transition_date": { "type": "string", "format": "date", "nullable": true }, "transition_status": { "type": "string", "nullable": true }, "transition_notes": { "type": "string", "nullable": true }, "client_swap_confirmed": { "type": "boolean", "nullable": true }, "client_swap_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "transition_is_complete": { "type": "boolean", "nullable": true }, "utilization_range": { "type": "string", "nullable": true }, "unexcused_absences": { "type": "string", "nullable": true }, "risk_factors": { "type": "string", "nullable": true }, "current_level": { "type": "string", "nullable": true }, "manager_transitions_meeting": { "type": "string", "nullable": true }, "graduation_report": { "type": "string", "nullable": true }, "transition_checklist": { "type": "string", "nullable": true }, "recommended_transition_timeline": { "type": "string", "nullable": true }, "next_grad_report_due": { "type": "string", "format": "date", "nullable": true }, "proposed_next_placement": { "type": "string", "nullable": true }, "peer_review": { "type": "string", "nullable": true }, "clinical_decision_is_yes": { "type": "boolean", "nullable": true }, "parent_decision_is_yes": { "type": "boolean", "nullable": true }, "reason_for_discharge": { "type": "string", "nullable": true }, "next_placement": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/client-transition-planning/{id}": { "get": { "operationId": "get_client_transition_planning", "summary": "Get a single client-transition-planning record", "tags": [ "client-transition-planning" ], "security": [ { "bearerAuth": [ "read:client-transition-planning" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "estimated_transition_date": { "type": "string", "format": "date", "nullable": true }, "transition_status": { "type": "string", "nullable": true }, "transition_notes": { "type": "string", "nullable": true }, "client_swap_confirmed": { "type": "boolean", "nullable": true }, "client_swap_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "transition_is_complete": { "type": "boolean", "nullable": true }, "utilization_range": { "type": "string", "nullable": true }, "unexcused_absences": { "type": "string", "nullable": true }, "risk_factors": { "type": "string", "nullable": true }, "current_level": { "type": "string", "nullable": true }, "manager_transitions_meeting": { "type": "string", "nullable": true }, "graduation_report": { "type": "string", "nullable": true }, "transition_checklist": { "type": "string", "nullable": true }, "recommended_transition_timeline": { "type": "string", "nullable": true }, "next_grad_report_due": { "type": "string", "format": "date", "nullable": true }, "proposed_next_placement": { "type": "string", "nullable": true }, "peer_review": { "type": "string", "nullable": true }, "clinical_decision_is_yes": { "type": "boolean", "nullable": true }, "parent_decision_is_yes": { "type": "boolean", "nullable": true }, "reason_for_discharge": { "type": "string", "nullable": true }, "next_placement": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/conditions": { "get": { "operationId": "list_conditions", "summary": "List conditions", "description": "Read-only view of `conditions`.", "tags": [ "conditions" ], "security": [ { "bearerAuth": [ "read:conditions" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name", "start_date", "end_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "supervising_bcba", "in": "query", "description": "Exact-match filter on `supervising_bcba`.", "schema": { "type": "string" } }, { "name": "aim_low_accel_timing", "in": "query", "description": "Exact-match filter on `aim_low_accel_timing`.", "schema": { "type": "string" } }, { "name": "aim_high_accel_timing", "in": "query", "description": "Exact-match filter on `aim_high_accel_timing`.", "schema": { "type": "string" } }, { "name": "aim_low_decel_timing", "in": "query", "description": "Exact-match filter on `aim_low_decel_timing`.", "schema": { "type": "string" } }, { "name": "aim_high_decel_timing", "in": "query", "description": "Exact-match filter on `aim_high_decel_timing`.", "schema": { "type": "string" } }, { "name": "aim_low_accel_frequency", "in": "query", "description": "Exact-match filter on `aim_low_accel_frequency`.", "schema": { "type": "string" } }, { "name": "aim_high_accel_frequency", "in": "query", "description": "Exact-match filter on `aim_high_accel_frequency`.", "schema": { "type": "string" } }, { "name": "aim_low_decel_frequency", "in": "query", "description": "Exact-match filter on `aim_low_decel_frequency`.", "schema": { "type": "string" } }, { "name": "aim_high_decel_frequency", "in": "query", "description": "Exact-match filter on `aim_high_decel_frequency`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "type": { "type": "string", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "supervising_bcba": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "aim_low_accel_timing": { "type": "integer", "format": "int64", "nullable": true }, "aim_high_accel_timing": { "type": "integer", "format": "int64", "nullable": true }, "aim_low_decel_timing": { "type": "integer", "format": "int64", "nullable": true }, "aim_high_decel_timing": { "type": "integer", "format": "int64", "nullable": true }, "aim_low_accel_frequency": { "type": "integer", "format": "int64", "nullable": true }, "aim_high_accel_frequency": { "type": "integer", "format": "int64", "nullable": true }, "aim_low_decel_frequency": { "type": "integer", "format": "int64", "nullable": true }, "aim_high_decel_frequency": { "type": "integer", "format": "int64", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/conditions/{id}": { "get": { "operationId": "get_conditions", "summary": "Get a single conditions record", "tags": [ "conditions" ], "security": [ { "bearerAuth": [ "read:conditions" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "type": { "type": "string", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "supervising_bcba": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "aim_low_accel_timing": { "type": "integer", "format": "int64", "nullable": true }, "aim_high_accel_timing": { "type": "integer", "format": "int64", "nullable": true }, "aim_low_decel_timing": { "type": "integer", "format": "int64", "nullable": true }, "aim_high_decel_timing": { "type": "integer", "format": "int64", "nullable": true }, "aim_low_accel_frequency": { "type": "integer", "format": "int64", "nullable": true }, "aim_high_accel_frequency": { "type": "integer", "format": "int64", "nullable": true }, "aim_low_decel_frequency": { "type": "integer", "format": "int64", "nullable": true }, "aim_high_decel_frequency": { "type": "integer", "format": "int64", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/connected-contact": { "get": { "operationId": "list_connected_contact", "summary": "List connected-contact", "description": "Read-only view of `connected_contact`.", "tags": [ "connected-contact" ], "security": [ { "bearerAuth": [ "read:connected-contact" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "Exact-match filter on `first_name`.", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Exact-match filter on `last_name`.", "schema": { "type": "string" } }, { "name": "preferrred_first_name", "in": "query", "description": "Exact-match filter on `preferrred_first_name`.", "schema": { "type": "string" } }, { "name": "street_address_line_1", "in": "query", "description": "Exact-match filter on `street_address_line_1`.", "schema": { "type": "string" } }, { "name": "street_address_line_2", "in": "query", "description": "Exact-match filter on `street_address_line_2`.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact-match filter on `city`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "zip", "in": "query", "description": "Exact-match filter on `zip`.", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Exact-match filter on `email`.", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Exact-match filter on `phone`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Exact-match filter on `gender`.", "schema": { "type": "string" } }, { "name": "preferred_contact_method", "in": "query", "description": "Exact-match filter on `preferred_contact_method`.", "schema": { "type": "string" } }, { "name": "photo", "in": "query", "description": "Exact-match filter on `photo`.", "schema": { "type": "string" } }, { "name": "company_name", "in": "query", "description": "Exact-match filter on `company_name`.", "schema": { "type": "string" } }, { "name": "company_website", "in": "query", "description": "Exact-match filter on `company_website`.", "schema": { "type": "string" } }, { "name": "date_of_birth", "in": "query", "description": "Exact-match filter on `date_of_birth`.", "schema": { "type": "string" } }, { "name": "social_security_number", "in": "query", "description": "Exact-match filter on `social_security_number`.", "schema": { "type": "string" } }, { "name": "type_is_professional", "in": "query", "description": "Exact-match filter on `type_is_professional`.", "schema": { "type": "string" } }, { "name": "is_guarantor", "in": "query", "description": "Exact-match filter on `is_guarantor`.", "schema": { "type": "string" } }, { "name": "can_pickup", "in": "query", "description": "Exact-match filter on `can_pickup`.", "schema": { "type": "string" } }, { "name": "is_emergency_contact", "in": "query", "description": "Exact-match filter on `is_emergency_contact`.", "schema": { "type": "string" } }, { "name": "relationship_to_client", "in": "query", "description": "Exact-match filter on `relationship_to_client`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferrred_first_name": { "type": "string", "nullable": true }, "street_address_line_1": { "type": "string", "nullable": true }, "street_address_line_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "preferred_contact_method": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "company_website": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "social_security_number": { "type": "string", "nullable": true }, "type_is_professional": { "type": "boolean", "nullable": true }, "is_guarantor": { "type": "boolean", "nullable": true }, "can_pickup": { "type": "boolean", "nullable": true }, "is_emergency_contact": { "type": "boolean", "nullable": true }, "relationship_to_client": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/connected-contact/{id}": { "get": { "operationId": "get_connected_contact", "summary": "Get a single connected-contact record", "tags": [ "connected-contact" ], "security": [ { "bearerAuth": [ "read:connected-contact" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferrred_first_name": { "type": "string", "nullable": true }, "street_address_line_1": { "type": "string", "nullable": true }, "street_address_line_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "preferred_contact_method": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "company_website": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "social_security_number": { "type": "string", "nullable": true }, "type_is_professional": { "type": "boolean", "nullable": true }, "is_guarantor": { "type": "boolean", "nullable": true }, "can_pickup": { "type": "boolean", "nullable": true }, "is_emergency_contact": { "type": "boolean", "nullable": true }, "relationship_to_client": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/connected-contact-new": { "get": { "operationId": "list_connected_contact_new", "summary": "List connected-contact-new", "description": "Read-only view of `connected_contact_new`.", "tags": [ "connected-contact-new" ], "security": [ { "bearerAuth": [ "read:connected-contact-new" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "Exact-match filter on `first_name`.", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Exact-match filter on `last_name`.", "schema": { "type": "string" } }, { "name": "preferred_first_name", "in": "query", "description": "Exact-match filter on `preferred_first_name`.", "schema": { "type": "string" } }, { "name": "street_address_line_1", "in": "query", "description": "Exact-match filter on `street_address_line_1`.", "schema": { "type": "string" } }, { "name": "street_address_line_2", "in": "query", "description": "Exact-match filter on `street_address_line_2`.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact-match filter on `city`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "zip", "in": "query", "description": "Exact-match filter on `zip`.", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Exact-match filter on `email`.", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Exact-match filter on `phone`.", "schema": { "type": "string" } }, { "name": "preferred_contact_method", "in": "query", "description": "Exact-match filter on `preferred_contact_method`.", "schema": { "type": "string" } }, { "name": "date_of_birth", "in": "query", "description": "Exact-match filter on `date_of_birth`.", "schema": { "type": "string" } }, { "name": "crm_object_id", "in": "query", "description": "Exact-match filter on `crm_object_id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "street_address_line_1": { "type": "string", "nullable": true }, "street_address_line_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "preferred_contact_method": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "crm_object_id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/connected-contact-new/{id}": { "get": { "operationId": "get_connected_contact_new", "summary": "Get a single connected-contact-new record", "tags": [ "connected-contact-new" ], "security": [ { "bearerAuth": [ "read:connected-contact-new" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "street_address_line_1": { "type": "string", "nullable": true }, "street_address_line_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "preferred_contact_method": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "crm_object_id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/coordination-of-care": { "get": { "operationId": "list_coordination_of_care", "summary": "List coordination-of-care", "description": "Read-only view of `coordination_of_care`.", "tags": [ "coordination-of-care" ], "security": [ { "bearerAuth": [ "read:coordination-of-care" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "st_collaboration_date", "ot_collaboration_date", "pt_collaboration_date", "other_collaboration_date", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "st_collaborated", "in": "query", "description": "Exact-match filter on `st_collaborated`.", "schema": { "type": "string" } }, { "name": "st_collaboration_date", "in": "query", "description": "Exact-match filter on `st_collaboration_date`.", "schema": { "type": "string" } }, { "name": "st_collaboration_notes", "in": "query", "description": "Exact-match filter on `st_collaboration_notes`.", "schema": { "type": "string" } }, { "name": "ot_collaborated", "in": "query", "description": "Exact-match filter on `ot_collaborated`.", "schema": { "type": "string" } }, { "name": "ot_collaboration_date", "in": "query", "description": "Exact-match filter on `ot_collaboration_date`.", "schema": { "type": "string" } }, { "name": "ot_collaboration_notes", "in": "query", "description": "Exact-match filter on `ot_collaboration_notes`.", "schema": { "type": "string" } }, { "name": "pt_collaborated", "in": "query", "description": "Exact-match filter on `pt_collaborated`.", "schema": { "type": "string" } }, { "name": "pt_collaboration_date", "in": "query", "description": "Exact-match filter on `pt_collaboration_date`.", "schema": { "type": "string" } }, { "name": "pt_collaboration_notes", "in": "query", "description": "Exact-match filter on `pt_collaboration_notes`.", "schema": { "type": "string" } }, { "name": "other_collaborated", "in": "query", "description": "Exact-match filter on `other_collaborated`.", "schema": { "type": "string" } }, { "name": "other_collaboration_date", "in": "query", "description": "Exact-match filter on `other_collaboration_date`.", "schema": { "type": "string" } }, { "name": "other_collaboration_notes", "in": "query", "description": "Exact-match filter on `other_collaboration_notes`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "st_collaborated": { "type": "boolean", "nullable": true }, "st_collaboration_date": { "type": "string", "format": "date", "nullable": true }, "st_collaboration_notes": { "type": "string", "nullable": true }, "ot_collaborated": { "type": "boolean", "nullable": true }, "ot_collaboration_date": { "type": "string", "format": "date", "nullable": true }, "ot_collaboration_notes": { "type": "string", "nullable": true }, "pt_collaborated": { "type": "boolean", "nullable": true }, "pt_collaboration_date": { "type": "string", "format": "date", "nullable": true }, "pt_collaboration_notes": { "type": "string", "nullable": true }, "other_collaborated": { "type": "boolean", "nullable": true }, "other_collaboration_date": { "type": "string", "format": "date", "nullable": true }, "other_collaboration_notes": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/coordination-of-care/{id}": { "get": { "operationId": "get_coordination_of_care", "summary": "Get a single coordination-of-care record", "tags": [ "coordination-of-care" ], "security": [ { "bearerAuth": [ "read:coordination-of-care" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "st_collaborated": { "type": "boolean", "nullable": true }, "st_collaboration_date": { "type": "string", "format": "date", "nullable": true }, "st_collaboration_notes": { "type": "string", "nullable": true }, "ot_collaborated": { "type": "boolean", "nullable": true }, "ot_collaboration_date": { "type": "string", "format": "date", "nullable": true }, "ot_collaboration_notes": { "type": "string", "nullable": true }, "pt_collaborated": { "type": "boolean", "nullable": true }, "pt_collaboration_date": { "type": "string", "format": "date", "nullable": true }, "pt_collaboration_notes": { "type": "string", "nullable": true }, "other_collaborated": { "type": "boolean", "nullable": true }, "other_collaboration_date": { "type": "string", "format": "date", "nullable": true }, "other_collaboration_notes": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/current-checked-in": { "get": { "operationId": "list_current_checked_in", "summary": "List current-checked-in", "description": "Read-only view of `current_checked_in`.", "tags": [ "current-checked-in" ], "security": [ { "bearerAuth": [ "read:current-checked-in" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "checkin_id", "date" ], "default": "checkin_id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "checkin_id", "in": "query", "description": "Exact-match filter on `checkin_id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "Exact-match filter on `first_name`.", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Exact-match filter on `last_name`.", "schema": { "type": "string" } }, { "name": "preferred_first_name", "in": "query", "description": "Exact-match filter on `preferred_first_name`.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Exact-match filter on `date`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "checkin_id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/current-checked-in/{id}": { "get": { "operationId": "get_current_checked_in", "summary": "Get a single current-checked-in record", "tags": [ "current-checked-in" ], "security": [ { "bearerAuth": [ "read:current-checked-in" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `checkin_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "checkin_id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/data-point": { "get": { "operationId": "list_data_point", "summary": "List data-point", "description": "Read-only view of `data_point`.", "tags": [ "data-point" ], "security": [ { "bearerAuth": [ "read:data-point" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "accel", "in": "query", "description": "Exact-match filter on `accel`.", "schema": { "type": "string" } }, { "name": "decel", "in": "query", "description": "Exact-match filter on `decel`.", "schema": { "type": "string" } }, { "name": "neutral", "in": "query", "description": "Exact-match filter on `neutral`.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Exact-match filter on `date`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "note", "in": "query", "description": "Exact-match filter on `note`.", "schema": { "type": "string" } }, { "name": "counting_time", "in": "query", "description": "Exact-match filter on `counting_time`.", "schema": { "type": "string" } }, { "name": "supervising_bcba", "in": "query", "description": "Exact-match filter on `supervising_bcba`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "accel": { "type": "integer", "format": "int64", "nullable": true }, "decel": { "type": "integer", "format": "int64", "nullable": true }, "neutral": { "type": "integer", "format": "int64", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "note": { "type": "string", "nullable": true }, "counting_time": { "type": "integer", "format": "int64", "nullable": true }, "supervising_bcba": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/data-point/{id}": { "get": { "operationId": "get_data_point", "summary": "Get a single data-point record", "tags": [ "data-point" ], "security": [ { "bearerAuth": [ "read:data-point" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "accel": { "type": "integer", "format": "int64", "nullable": true }, "decel": { "type": "integer", "format": "int64", "nullable": true }, "neutral": { "type": "integer", "format": "int64", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "note": { "type": "string", "nullable": true }, "counting_time": { "type": "integer", "format": "int64", "nullable": true }, "supervising_bcba": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/diagnosis": { "get": { "operationId": "list_diagnosis", "summary": "List diagnosis", "description": "Read-only view of `diagnosis`.", "tags": [ "diagnosis" ], "security": [ { "bearerAuth": [ "read:diagnosis" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "diagnosis_code", "in": "query", "description": "Exact-match filter on `diagnosis_code`.", "schema": { "type": "string" } }, { "name": "diagnosis_description", "in": "query", "description": "Exact-match filter on `diagnosis_description`.", "schema": { "type": "string" } }, { "name": "diagnosis_notes", "in": "query", "description": "Exact-match filter on `diagnosis_notes`.", "schema": { "type": "string" } }, { "name": "diagnosis_image", "in": "query", "description": "Exact-match filter on `diagnosis_image`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "diagnosis_code": { "type": "string", "nullable": true }, "diagnosis_description": { "type": "string", "nullable": true }, "diagnosis_notes": { "type": "string", "nullable": true }, "diagnosis_image": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/diagnosis/{id}": { "get": { "operationId": "get_diagnosis", "summary": "Get a single diagnosis record", "tags": [ "diagnosis" ], "security": [ { "bearerAuth": [ "read:diagnosis" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "diagnosis_code": { "type": "string", "nullable": true }, "diagnosis_description": { "type": "string", "nullable": true }, "diagnosis_notes": { "type": "string", "nullable": true }, "diagnosis_image": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/dictation-log": { "get": { "operationId": "list_dictation_log", "summary": "List dictation-log", "description": "Read-only view of `dictation_log`.", "tags": [ "dictation-log" ], "security": [ { "bearerAuth": [ "read:dictation-log" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "occurred_at" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "Exact-match filter on `action`.", "schema": { "type": "string" } }, { "name": "transcript_length", "in": "query", "description": "Exact-match filter on `transcript_length`.", "schema": { "type": "string" } }, { "name": "occurred_at", "in": "query", "description": "Exact-match filter on `occurred_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "action": { "type": "string", "nullable": true }, "transcript_length": { "type": "integer", "nullable": true }, "occurred_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/dictation-log/{id}": { "get": { "operationId": "get_dictation_log", "summary": "Get a single dictation-log record", "tags": [ "dictation-log" ], "security": [ { "bearerAuth": [ "read:dictation-log" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "action": { "type": "string", "nullable": true }, "transcript_length": { "type": "integer", "nullable": true }, "occurred_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/discipline": { "get": { "operationId": "list_discipline", "summary": "List discipline", "description": "Read-only view of `discipline`.", "tags": [ "discipline" ], "security": [ { "bearerAuth": [ "read:discipline" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/discipline/{id}": { "get": { "operationId": "get_discipline", "summary": "Get a single discipline record", "tags": [ "discipline" ], "security": [ { "bearerAuth": [ "read:discipline" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/fee-schedule": { "get": { "operationId": "list_fee_schedule", "summary": "List fee-schedule", "description": "Read-only view of `fee_schedule`.", "tags": [ "fee-schedule" ], "security": [ { "bearerAuth": [ "read:fee-schedule" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "start_date", "end_date" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "discipline_id", "in": "query", "description": "Exact-match filter on `discipline_id`.", "schema": { "type": "string" } }, { "name": "service_id", "in": "query", "description": "Exact-match filter on `service_id`.", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Exact-match filter on `code`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "modifiers", "in": "query", "description": "Exact-match filter on `modifiers`.", "schema": { "type": "string" } }, { "name": "rate", "in": "query", "description": "Exact-match filter on `rate`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "discipline_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "service_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "code": { "type": "string", "nullable": true }, "credentials": { "type": "object", "nullable": true }, "locations": { "type": "object", "nullable": true }, "state": { "type": "string", "nullable": true }, "modifiers": { "type": "string", "nullable": true }, "rate": { "type": "number", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "insurances": { "type": "object", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/fee-schedule/{id}": { "get": { "operationId": "get_fee_schedule", "summary": "Get a single fee-schedule record", "tags": [ "fee-schedule" ], "security": [ { "bearerAuth": [ "read:fee-schedule" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "discipline_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "service_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "code": { "type": "string", "nullable": true }, "credentials": { "type": "object", "nullable": true }, "locations": { "type": "object", "nullable": true }, "state": { "type": "string", "nullable": true }, "modifiers": { "type": "string", "nullable": true }, "rate": { "type": "number", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "insurances": { "type": "object", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/fee-schedule-view": { "get": { "operationId": "list_fee_schedule_view", "summary": "List fee-schedule-view", "description": "Read-only view of `fee_schedule_view`.", "tags": [ "fee-schedule-view" ], "security": [ { "bearerAuth": [ "read:fee-schedule-view" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "start_date", "end_date" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Exact-match filter on `code`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "modifiers", "in": "query", "description": "Exact-match filter on `modifiers`.", "schema": { "type": "string" } }, { "name": "rate", "in": "query", "description": "Exact-match filter on `rate`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "insurances": { "type": "object", "nullable": true }, "disciplines": { "type": "object", "nullable": true }, "services": { "type": "object", "nullable": true }, "code": { "type": "string", "nullable": true }, "credentials": { "type": "object", "nullable": true }, "locations": { "type": "object", "nullable": true }, "state": { "type": "string", "nullable": true }, "modifiers": { "type": "string", "nullable": true }, "rate": { "type": "number", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "status": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/fee-schedule-view/{id}": { "get": { "operationId": "get_fee_schedule_view", "summary": "Get a single fee-schedule-view record", "tags": [ "fee-schedule-view" ], "security": [ { "bearerAuth": [ "read:fee-schedule-view" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "insurances": { "type": "object", "nullable": true }, "disciplines": { "type": "object", "nullable": true }, "services": { "type": "object", "nullable": true }, "code": { "type": "string", "nullable": true }, "credentials": { "type": "object", "nullable": true }, "locations": { "type": "object", "nullable": true }, "state": { "type": "string", "nullable": true }, "modifiers": { "type": "string", "nullable": true }, "rate": { "type": "number", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "status": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/fluency-run": { "get": { "operationId": "list_fluency_run", "summary": "List fluency-run", "description": "Read-only view of `fluency_run`.", "tags": [ "fluency-run" ], "security": [ { "bearerAuth": [ "read:fluency-run" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "entered_at", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Exact-match filter on `appointment_id`.", "schema": { "type": "string" } }, { "name": "date_of_service", "in": "query", "description": "Exact-match filter on `date_of_service`.", "schema": { "type": "string" } }, { "name": "c_count", "in": "query", "description": "Exact-match filter on `c_count`.", "schema": { "type": "string" } }, { "name": "ic_count", "in": "query", "description": "Exact-match filter on `ic_count`.", "schema": { "type": "string" } }, { "name": "n_count", "in": "query", "description": "Exact-match filter on `n_count`.", "schema": { "type": "string" } }, { "name": "counting_time_seconds", "in": "query", "description": "Exact-match filter on `counting_time_seconds`.", "schema": { "type": "string" } }, { "name": "entered_at", "in": "query", "description": "Exact-match filter on `entered_at`.", "schema": { "type": "string" } }, { "name": "client_uuid", "in": "query", "description": "Exact-match filter on `client_uuid`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "date_of_service": { "type": "string", "format": "date", "nullable": true }, "c_count": { "type": "integer", "nullable": true }, "ic_count": { "type": "integer", "nullable": true }, "n_count": { "type": "integer", "nullable": true }, "counting_time_seconds": { "type": "integer", "description": "Per-run counting time, set when the timer stops. NULL = run still in progress. Accumulation sums this across a chart's runs for the DOS (fluency counting time is per-run, not the day total).", "nullable": true }, "entered_at": { "type": "string", "format": "date-time", "nullable": true }, "client_uuid": { "type": "string", "format": "uuid", "description": "Client-generated idempotency key: dedupes replayed/in-progress run syncs from the offline queue.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/fluency-run/{id}": { "get": { "operationId": "get_fluency_run", "summary": "Get a single fluency-run record", "tags": [ "fluency-run" ], "security": [ { "bearerAuth": [ "read:fluency-run" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "date_of_service": { "type": "string", "format": "date", "nullable": true }, "c_count": { "type": "integer", "nullable": true }, "ic_count": { "type": "integer", "nullable": true }, "n_count": { "type": "integer", "nullable": true }, "counting_time_seconds": { "type": "integer", "description": "Per-run counting time, set when the timer stops. NULL = run still in progress. Accumulation sums this across a chart's runs for the DOS (fluency counting time is per-run, not the day total).", "nullable": true }, "entered_at": { "type": "string", "format": "date-time", "nullable": true }, "client_uuid": { "type": "string", "format": "uuid", "description": "Client-generated idempotency key: dedupes replayed/in-progress run syncs from the offline queue.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/global-annotation": { "get": { "operationId": "list_global_annotation", "summary": "List global-annotation", "description": "Read-only view of `global_annotation`.", "tags": [ "global-annotation" ], "security": [ { "bearerAuth": [ "read:global-annotation" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name", "start_date", "end_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "supervising_bcba", "in": "query", "description": "Exact-match filter on `supervising_bcba`.", "schema": { "type": "string" } }, { "name": "apply_to", "in": "query", "description": "Exact-match filter on `apply_to`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "supervising_bcba": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "apply_to": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/global-annotation/{id}": { "get": { "operationId": "get_global_annotation", "summary": "Get a single global-annotation record", "tags": [ "global-annotation" ], "security": [ { "bearerAuth": [ "read:global-annotation" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "supervising_bcba": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "apply_to": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/global-config": { "get": { "operationId": "list_global_config", "summary": "List global-config", "description": "Read-only view of `global_config`.", "tags": [ "global-config" ], "security": [ { "bearerAuth": [ "read:global-config" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "config_key", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "config_key", "in": "query", "description": "Exact-match filter on `config_key`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "config_key": { "type": "string", "nullable": true }, "config_value": { "type": "object", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/global-config/{id}": { "get": { "operationId": "get_global_config", "summary": "Get a single global-config record", "tags": [ "global-config" ], "security": [ { "bearerAuth": [ "read:global-config" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `config_key`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "config_key": { "type": "string", "nullable": true }, "config_value": { "type": "object", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/handwashing-log": { "get": { "operationId": "list_handwashing_log", "summary": "List handwashing-log", "description": "Read-only view of `handwashing_log`.", "tags": [ "handwashing-log" ], "security": [ { "bearerAuth": [ "read:handwashing-log" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "log_date", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "log_date", "in": "query", "description": "Exact-match filter on `log_date`.", "schema": { "type": "string" } }, { "name": "log_time", "in": "query", "description": "Exact-match filter on `log_time`.", "schema": { "type": "string" } }, { "name": "client_before_id", "in": "query", "description": "Exact-match filter on `client_before_id`.", "schema": { "type": "string" } }, { "name": "client_after_id", "in": "query", "description": "Exact-match filter on `client_after_id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "log_date": { "type": "string", "format": "date", "nullable": true }, "log_time": { "type": "string", "format": "date-time", "nullable": true }, "client_before_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "client_after_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/handwashing-log/{id}": { "get": { "operationId": "get_handwashing_log", "summary": "Get a single handwashing-log record", "tags": [ "handwashing-log" ], "security": [ { "bearerAuth": [ "read:handwashing-log" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "log_date": { "type": "string", "format": "date", "nullable": true }, "log_time": { "type": "string", "format": "date-time", "nullable": true }, "client_before_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "client_after_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/holidays": { "get": { "operationId": "list_holidays", "summary": "List holidays", "description": "Read-only view of `holidays`.", "tags": [ "holidays" ], "security": [ { "bearerAuth": [ "read:holidays" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "holiday_date", "name" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "holiday_date", "in": "query", "description": "Exact-match filter on `holiday_date`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "holiday_date": { "type": "string", "format": "date", "nullable": true }, "name": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/holidays/{id}": { "get": { "operationId": "get_holidays", "summary": "Get a single holidays record", "tags": [ "holidays" ], "security": [ { "bearerAuth": [ "read:holidays" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "holiday_date": { "type": "string", "format": "date", "nullable": true }, "name": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/insurance-company": { "get": { "operationId": "list_insurance_company", "summary": "List insurance-company", "description": "Read-only view of `insurance_company`.", "tags": [ "insurance-company" ], "security": [ { "bearerAuth": [ "read:insurance-company" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "referred_to_as", "in": "query", "description": "Exact-match filter on `referred_to_as`.", "schema": { "type": "string" } }, { "name": "clearing_house_id", "in": "query", "description": "Exact-match filter on `clearing_house_id`.", "schema": { "type": "string" } }, { "name": "address_line_1", "in": "query", "description": "Exact-match filter on `address_line_1`.", "schema": { "type": "string" } }, { "name": "address_line2", "in": "query", "description": "Exact-match filter on `address_line2`.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact-match filter on `city`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "zip", "in": "query", "description": "Exact-match filter on `zip`.", "schema": { "type": "string" } }, { "name": "logo", "in": "query", "description": "Exact-match filter on `logo`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "manager", "in": "query", "description": "Exact-match filter on `manager`.", "schema": { "type": "string" } }, { "name": "billing", "in": "query", "description": "Exact-match filter on `billing`.", "schema": { "type": "string" } }, { "name": "provider_supplier", "in": "query", "description": "Exact-match filter on `provider_supplier`.", "schema": { "type": "string" } }, { "name": "facility", "in": "query", "description": "Exact-match filter on `facility`.", "schema": { "type": "string" } }, { "name": "is_medicaid", "in": "query", "description": "Exact-match filter on `is_medicaid`.", "schema": { "type": "string" } }, { "name": "requires_rbt", "in": "query", "description": "Exact-match filter on `requires_rbt`.", "schema": { "type": "string" } }, { "name": "in_network", "in": "query", "description": "Exact-match filter on `in_network`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "referred_to_as": { "type": "string", "nullable": true }, "clearing_house_id": { "type": "string", "nullable": true }, "address_line_1": { "type": "string", "nullable": true }, "address_line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "manager": { "type": "string", "nullable": true }, "billing": { "type": "string", "nullable": true }, "provider_supplier": { "type": "string", "nullable": true }, "facility": { "type": "string", "nullable": true }, "is_medicaid": { "type": "boolean", "nullable": true }, "requires_rbt": { "type": "boolean", "nullable": true }, "in_network": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/insurance-company/{id}": { "get": { "operationId": "get_insurance_company", "summary": "Get a single insurance-company record", "tags": [ "insurance-company" ], "security": [ { "bearerAuth": [ "read:insurance-company" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "referred_to_as": { "type": "string", "nullable": true }, "clearing_house_id": { "type": "string", "nullable": true }, "address_line_1": { "type": "string", "nullable": true }, "address_line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "manager": { "type": "string", "nullable": true }, "billing": { "type": "string", "nullable": true }, "provider_supplier": { "type": "string", "nullable": true }, "facility": { "type": "string", "nullable": true }, "is_medicaid": { "type": "boolean", "nullable": true }, "requires_rbt": { "type": "boolean", "nullable": true }, "in_network": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/job-title": { "get": { "operationId": "list_job_title", "summary": "List job-title", "description": "Read-only view of `job_title`.", "tags": [ "job-title" ], "security": [ { "bearerAuth": [ "read:job-title" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "Name", "in": "query", "description": "Exact-match filter on `Name`.", "schema": { "type": "string" } }, { "name": "Notes", "in": "query", "description": "Exact-match filter on `Notes`.", "schema": { "type": "string" } }, { "name": "job_title_acronym", "in": "query", "description": "Exact-match filter on `job_title_acronym`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "is_direct", "in": "query", "description": "Exact-match filter on `is_direct`.", "schema": { "type": "string" } }, { "name": "hris_position_code", "in": "query", "description": "Exact-match filter on `hris_position_code`.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Exact-match filter on `role`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "job_title_acronym": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "is_direct": { "type": "boolean", "nullable": true }, "hris_position_code": { "type": "string", "nullable": true }, "role": { "type": "string", "description": "app role type", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/job-title/{id}": { "get": { "operationId": "get_job_title", "summary": "Get a single job-title record", "tags": [ "job-title" ], "security": [ { "bearerAuth": [ "read:job-title" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "job_title_acronym": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "is_direct": { "type": "boolean", "nullable": true }, "hris_position_code": { "type": "string", "nullable": true }, "role": { "type": "string", "description": "app role type", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/job-title-discipline": { "get": { "operationId": "list_job_title_discipline", "summary": "List job-title-discipline", "description": "Read-only view of `job_title_discipline`.", "tags": [ "job-title-discipline" ], "security": [ { "bearerAuth": [ "read:job-title-discipline" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "job_title_id", "in": "query", "description": "Exact-match filter on `job_title_id`.", "schema": { "type": "string" } }, { "name": "discipline_id", "in": "query", "description": "Exact-match filter on `discipline_id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "job_title_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `job_title.id`.", "nullable": true }, "discipline_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/job-title-discipline/{id}": { "get": { "operationId": "get_job_title_discipline", "summary": "Get a single job-title-discipline record", "tags": [ "job-title-discipline" ], "security": [ { "bearerAuth": [ "read:job-title-discipline" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "job_title_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `job_title.id`.", "nullable": true }, "discipline_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/job-title-mapping": { "get": { "operationId": "list_job_title_mapping", "summary": "List job-title-mapping", "description": "Read-only view of `job_title_mapping`.", "tags": [ "job-title-mapping" ], "security": [ { "bearerAuth": [ "read:job-title-mapping" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "hris_position_code", "in": "query", "description": "Exact-match filter on `hris_position_code`.", "schema": { "type": "string" } }, { "name": "job_title_id", "in": "query", "description": "Exact-match filter on `job_title_id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "hris_position_code": { "type": "string", "nullable": true }, "job_title_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `job_title.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/job-title-mapping/{id}": { "get": { "operationId": "get_job_title_mapping", "summary": "Get a single job-title-mapping record", "tags": [ "job-title-mapping" ], "security": [ { "bearerAuth": [ "read:job-title-mapping" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "hris_position_code": { "type": "string", "nullable": true }, "job_title_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `job_title.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-level": { "get": { "operationId": "list_learner_level", "summary": "List learner-level", "description": "Read-only view of `learner_level`.", "tags": [ "learner-level" ], "security": [ { "bearerAuth": [ "read:learner-level" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Exact-match filter on `date`.", "schema": { "type": "string" } }, { "name": "learner_level", "in": "query", "description": "Exact-match filter on `learner_level`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "date": { "type": "string", "format": "date", "nullable": true }, "learner_level": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-level/{id}": { "get": { "operationId": "get_learner_level", "summary": "Get a single learner-level record", "tags": [ "learner-level" ], "security": [ { "bearerAuth": [ "read:learner-level" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "date": { "type": "string", "format": "date", "nullable": true }, "learner_level": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-profile-category": { "get": { "operationId": "list_learner_profile_category", "summary": "List learner-profile-category", "description": "Read-only view of `learner_profile_category`.", "tags": [ "learner-profile-category" ], "security": [ { "bearerAuth": [ "read:learner-profile-category" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-profile-category/{id}": { "get": { "operationId": "get_learner_profile_category", "summary": "Get a single learner-profile-category record", "tags": [ "learner-profile-category" ], "security": [ { "bearerAuth": [ "read:learner-profile-category" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-profile-input": { "get": { "operationId": "list_learner_profile_input", "summary": "List learner-profile-input", "description": "Read-only view of `learner_profile_input`.", "tags": [ "learner-profile-input" ], "security": [ { "bearerAuth": [ "read:learner-profile-input" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Exact-match filter on `text`.", "schema": { "type": "string" } }, { "name": "input_type", "in": "query", "description": "Exact-match filter on `input_type`.", "schema": { "type": "string" } }, { "name": "learner_profile_category_id", "in": "query", "description": "Exact-match filter on `learner_profile_category_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "text": { "type": "string", "nullable": true }, "input_type": { "type": "string", "nullable": true }, "learner_profile_category_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `learner_profile_category.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-profile-input/{id}": { "get": { "operationId": "get_learner_profile_input", "summary": "Get a single learner-profile-input record", "tags": [ "learner-profile-input" ], "security": [ { "bearerAuth": [ "read:learner-profile-input" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "text": { "type": "string", "nullable": true }, "input_type": { "type": "string", "nullable": true }, "learner_profile_category_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `learner_profile_category.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-profile-save": { "get": { "operationId": "list_learner_profile_save", "summary": "List learner-profile-save", "description": "Read-only view of `learner_profile_save`.", "tags": [ "learner-profile-save" ], "security": [ { "bearerAuth": [ "read:learner-profile-save" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Exact-match filter on `value`.", "schema": { "type": "string" } }, { "name": "category_id", "in": "query", "description": "Exact-match filter on `category_id`.", "schema": { "type": "string" } }, { "name": "input_id", "in": "query", "description": "Exact-match filter on `input_id`.", "schema": { "type": "string" } }, { "name": "year", "in": "query", "description": "Exact-match filter on `year`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "value": { "type": "string", "nullable": true }, "category_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `learner_profile_category.id`.", "nullable": true }, "input_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `learner_profile_input.id`.", "nullable": true }, "year": { "type": "integer", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-profile-save/{id}": { "get": { "operationId": "get_learner_profile_save", "summary": "Get a single learner-profile-save record", "tags": [ "learner-profile-save" ], "security": [ { "bearerAuth": [ "read:learner-profile-save" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "value": { "type": "string", "nullable": true }, "category_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `learner_profile_category.id`.", "nullable": true }, "input_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `learner_profile_input.id`.", "nullable": true }, "year": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-update": { "get": { "operationId": "list_learner_update", "summary": "List learner-update", "description": "Read-only view of `learner_update`.", "tags": [ "learner-update" ], "security": [ { "bearerAuth": [ "read:learner-update" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "expires_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "length", "in": "query", "description": "Exact-match filter on `length`.", "schema": { "type": "string" } }, { "name": "expires_at", "in": "query", "description": "Exact-match filter on `expires_at`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "is_deleted", "in": "query", "description": "Exact-match filter on `is_deleted`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "length": { "type": "integer", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "is_deleted": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/learner-update/{id}": { "get": { "operationId": "get_learner_update", "summary": "Get a single learner-update record", "tags": [ "learner-update" ], "security": [ { "bearerAuth": [ "read:learner-update" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "length": { "type": "integer", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "is_deleted": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/license-certification": { "get": { "operationId": "list_license_certification", "summary": "List license-certification", "description": "Read-only view of `license_certification`.", "tags": [ "license-certification" ], "security": [ { "bearerAuth": [ "read:license-certification" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "orginization_credentialing_body", "in": "query", "description": "Exact-match filter on `orginization_credentialing_body`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "credentials", "in": "query", "description": "Exact-match filter on `credentials`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "orginization_credentialing_body": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `license_certification_credentialing_body.id`.", "nullable": true }, "name": { "type": "string", "nullable": true }, "credentials": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/license-certification/{id}": { "get": { "operationId": "get_license_certification", "summary": "Get a single license-certification record", "tags": [ "license-certification" ], "security": [ { "bearerAuth": [ "read:license-certification" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "orginization_credentialing_body": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `license_certification_credentialing_body.id`.", "nullable": true }, "name": { "type": "string", "nullable": true }, "credentials": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/license-certification-credentialing-body": { "get": { "operationId": "list_license_certification_credentialing_body", "summary": "List license-certification-credentialing-body", "description": "Read-only view of `license_certification_credentialing_body`.", "tags": [ "license-certification-credentialing-body" ], "security": [ { "bearerAuth": [ "read:license-certification-credentialing-body" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "portal_url", "in": "query", "description": "Exact-match filter on `portal_url`.", "schema": { "type": "string" } }, { "name": "logo", "in": "query", "description": "Exact-match filter on `logo`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "portal_url": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/license-certification-credentialing-body/{id}": { "get": { "operationId": "get_license_certification_credentialing_body", "summary": "Get a single license-certification-credentialing-body record", "tags": [ "license-certification-credentialing-body" ], "security": [ { "bearerAuth": [ "read:license-certification-credentialing-body" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "portal_url": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/location": { "get": { "operationId": "list_location", "summary": "List location", "description": "Read-only view of `location`.", "tags": [ "location" ], "security": [ { "bearerAuth": [ "read:location" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "location_name", "in": "query", "description": "Exact-match filter on `location_name`.", "schema": { "type": "string" } }, { "name": "location_code", "in": "query", "description": "Exact-match filter on `location_code`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "preposition", "in": "query", "description": "Exact-match filter on `preposition`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "location_name": { "type": "string", "nullable": true }, "location_code": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "preposition": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/location/{id}": { "get": { "operationId": "get_location", "summary": "Get a single location record", "tags": [ "location" ], "security": [ { "bearerAuth": [ "read:location" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "location_name": { "type": "string", "nullable": true }, "location_code": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "preposition": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/mastered-target": { "get": { "operationId": "list_mastered_target", "summary": "List mastered-target", "description": "Read-only view of `mastered_target`.", "tags": [ "mastered-target" ], "security": [ { "bearerAuth": [ "read:mastered-target" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "name", "mastered_date", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "mastered_date", "in": "query", "description": "Exact-match filter on `mastered_date`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "name": { "type": "string", "nullable": true }, "mastered_date": { "type": "string", "format": "date", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/mastered-target/{id}": { "get": { "operationId": "get_mastered_target", "summary": "Get a single mastered-target record", "tags": [ "mastered-target" ], "security": [ { "bearerAuth": [ "read:mastered-target" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "name": { "type": "string", "nullable": true }, "mastered_date": { "type": "string", "format": "date", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-banned-text": { "get": { "operationId": "list_note_banned_text", "summary": "List note-banned-text", "description": "Read-only view of `note_banned_text`.", "tags": [ "note-banned-text" ], "security": [ { "bearerAuth": [ "read:note-banned-text" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "banned_text", "in": "query", "description": "Exact-match filter on `banned_text`.", "schema": { "type": "string" } }, { "name": "substitute_text", "in": "query", "description": "Exact-match filter on `substitute_text`.", "schema": { "type": "string" } }, { "name": "allow_warning", "in": "query", "description": "Exact-match filter on `allow_warning`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "banned_text": { "type": "string", "nullable": true }, "substitute_text": { "type": "string", "nullable": true }, "allow_warning": { "type": "boolean", "nullable": true }, "type": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-banned-text/{id}": { "get": { "operationId": "get_note_banned_text", "summary": "Get a single note-banned-text record", "tags": [ "note-banned-text" ], "security": [ { "bearerAuth": [ "read:note-banned-text" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "banned_text": { "type": "string", "nullable": true }, "substitute_text": { "type": "string", "nullable": true }, "allow_warning": { "type": "boolean", "nullable": true }, "type": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-generation-log": { "get": { "operationId": "list_note_generation_log", "summary": "List note-generation-log", "description": "Read-only view of `note_generation_log`.", "tags": [ "note-generation-log" ], "security": [ { "bearerAuth": [ "read:note-generation-log" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "generated_at" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Exact-match filter on `appointment_id`.", "schema": { "type": "string" } }, { "name": "generated_by", "in": "query", "description": "Exact-match filter on `generated_by`.", "schema": { "type": "string" } }, { "name": "generated_at", "in": "query", "description": "Exact-match filter on `generated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "generated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "generated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-generation-log/{id}": { "get": { "operationId": "get_note_generation_log", "summary": "Get a single note-generation-log record", "tags": [ "note-generation-log" ], "security": [ { "bearerAuth": [ "read:note-generation-log" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "generated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "generated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question": { "get": { "operationId": "list_note_question", "summary": "List note-question", "description": "Read-only view of `note_question`.", "tags": [ "note-question" ], "security": [ { "bearerAuth": [ "read:note-question" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "note_question_name", "in": "query", "description": "Exact-match filter on `note_question_name`.", "schema": { "type": "string" } }, { "name": "note_question_type_id", "in": "query", "description": "Exact-match filter on `note_question_type_id`.", "schema": { "type": "string" } }, { "name": "note_question_text_for_staff", "in": "query", "description": "Exact-match filter on `note_question_text_for_staff`.", "schema": { "type": "string" } }, { "name": "note_question_text_on_final_note", "in": "query", "description": "Exact-match filter on `note_question_text_on_final_note`.", "schema": { "type": "string" } }, { "name": "note_question_guiding_text", "in": "query", "description": "Exact-match filter on `note_question_guiding_text`.", "schema": { "type": "string" } }, { "name": "is_required", "in": "query", "description": "Exact-match filter on `is_required`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "note_question_name": { "type": "string", "nullable": true }, "note_question_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question_type.id`.", "nullable": true }, "note_question_text_for_staff": { "type": "string", "nullable": true }, "note_question_text_on_final_note": { "type": "string", "nullable": true }, "note_question_guiding_text": { "type": "string", "nullable": true }, "is_required": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question/{id}": { "get": { "operationId": "get_note_question", "summary": "Get a single note-question record", "tags": [ "note-question" ], "security": [ { "bearerAuth": [ "read:note-question" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "note_question_name": { "type": "string", "nullable": true }, "note_question_type_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question_type.id`.", "nullable": true }, "note_question_text_for_staff": { "type": "string", "nullable": true }, "note_question_text_on_final_note": { "type": "string", "nullable": true }, "note_question_guiding_text": { "type": "string", "nullable": true }, "is_required": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-ai-review-prompt": { "get": { "operationId": "list_note_question_ai_review_prompt", "summary": "List note-question-ai-review-prompt", "description": "Read-only view of `note_question_ai_review_prompt`.", "tags": [ "note-question-ai-review-prompt" ], "security": [ { "bearerAuth": [ "read:note-question-ai-review-prompt" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "note_question_id", "in": "query", "description": "Exact-match filter on `note_question_id`.", "schema": { "type": "string" } }, { "name": "overall_prompt", "in": "query", "description": "Exact-match filter on `overall_prompt`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "copying_prompt", "in": "query", "description": "Exact-match filter on `copying_prompt`.", "schema": { "type": "string" } }, { "name": "quality_prompt", "in": "query", "description": "Exact-match filter on `quality_prompt`.", "schema": { "type": "string" } }, { "name": "length_prompt", "in": "query", "description": "Exact-match filter on `length_prompt`.", "schema": { "type": "string" } }, { "name": "service_match_prompt", "in": "query", "description": "Exact-match filter on `service_match_prompt`.", "schema": { "type": "string" } }, { "name": "location_match_prompt", "in": "query", "description": "Exact-match filter on `location_match_prompt`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "overall_prompt": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "copying_prompt": { "type": "string", "nullable": true }, "quality_prompt": { "type": "string", "nullable": true }, "length_prompt": { "type": "string", "nullable": true }, "service_match_prompt": { "type": "string", "nullable": true }, "location_match_prompt": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-ai-review-prompt/{id}": { "get": { "operationId": "get_note_question_ai_review_prompt", "summary": "Get a single note-question-ai-review-prompt record", "tags": [ "note-question-ai-review-prompt" ], "security": [ { "bearerAuth": [ "read:note-question-ai-review-prompt" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "overall_prompt": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "copying_prompt": { "type": "string", "nullable": true }, "quality_prompt": { "type": "string", "nullable": true }, "length_prompt": { "type": "string", "nullable": true }, "service_match_prompt": { "type": "string", "nullable": true }, "location_match_prompt": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-answer": { "get": { "operationId": "list_note_question_answer", "summary": "List note-question-answer", "description": "Read-only view of `note_question_answer`.", "tags": [ "note-question-answer" ], "security": [ { "bearerAuth": [ "read:note-question-answer" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Exact-match filter on `value`.", "schema": { "type": "string" } }, { "name": "note_question_id", "in": "query", "description": "Exact-match filter on `note_question_id`.", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Exact-match filter on `appointment_id`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "value": { "type": "string", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-answer/{id}": { "get": { "operationId": "get_note_question_answer", "summary": "Get a single note-question-answer record", "tags": [ "note-question-answer" ], "security": [ { "bearerAuth": [ "read:note-question-answer" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "value": { "type": "string", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-choice": { "get": { "operationId": "list_note_question_choice", "summary": "List note-question-choice", "description": "Read-only view of `note_question_choice`.", "tags": [ "note-question-choice" ], "security": [ { "bearerAuth": [ "read:note-question-choice" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "note_question_id", "in": "query", "description": "Exact-match filter on `note_question_id`.", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Exact-match filter on `value`.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Exact-match filter on `order`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "value": { "type": "string", "nullable": true }, "order": { "type": "integer", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-choice/{id}": { "get": { "operationId": "get_note_question_choice", "summary": "Get a single note-question-choice record", "tags": [ "note-question-choice" ], "security": [ { "bearerAuth": [ "read:note-question-choice" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "value": { "type": "string", "nullable": true }, "order": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-sentence": { "get": { "operationId": "list_note_question_sentence", "summary": "List note-question-sentence", "description": "Read-only view of `note_question_sentence`.", "tags": [ "note-question-sentence" ], "security": [ { "bearerAuth": [ "read:note-question-sentence" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "sentence_structure", "in": "query", "description": "Exact-match filter on `sentence_structure`.", "schema": { "type": "string" } }, { "name": "note_question_id", "in": "query", "description": "Exact-match filter on `note_question_id`.", "schema": { "type": "string" } }, { "name": "note_question_choice_id", "in": "query", "description": "Exact-match filter on `note_question_choice_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "sentence_structure": { "type": "string", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "note_question_choice_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question_choice.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-sentence/{id}": { "get": { "operationId": "get_note_question_sentence", "summary": "Get a single note-question-sentence record", "tags": [ "note-question-sentence" ], "security": [ { "bearerAuth": [ "read:note-question-sentence" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "sentence_structure": { "type": "string", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "note_question_choice_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question_choice.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-two-tiered-choice-primary": { "get": { "operationId": "list_note_question_two_tiered_choice_primary", "summary": "List note-question-two-tiered-choice-primary", "description": "Read-only view of `note_question_two_tiered_choice_primary`.", "tags": [ "note-question-two-tiered-choice-primary" ], "security": [ { "bearerAuth": [ "read:note-question-two-tiered-choice-primary" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "is_active", "in": "query", "description": "Exact-match filter on `is_active`.", "schema": { "type": "string" } }, { "name": "question_id", "in": "query", "description": "Exact-match filter on `question_id`.", "schema": { "type": "string" } }, { "name": "requires_note", "in": "query", "description": "Exact-match filter on `requires_note`.", "schema": { "type": "string" } }, { "name": "note_sentence", "in": "query", "description": "Exact-match filter on `note_sentence`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "requires_note": { "type": "boolean", "nullable": true }, "note_sentence": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-two-tiered-choice-primary/{id}": { "get": { "operationId": "get_note_question_two_tiered_choice_primary", "summary": "Get a single note-question-two-tiered-choice-primary record", "tags": [ "note-question-two-tiered-choice-primary" ], "security": [ { "bearerAuth": [ "read:note-question-two-tiered-choice-primary" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "requires_note": { "type": "boolean", "nullable": true }, "note_sentence": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-two-tiered-choice-secondary": { "get": { "operationId": "list_note_question_two_tiered_choice_secondary", "summary": "List note-question-two-tiered-choice-secondary", "description": "Read-only view of `note_question_two_tiered_choice_secondary`.", "tags": [ "note-question-two-tiered-choice-secondary" ], "security": [ { "bearerAuth": [ "read:note-question-two-tiered-choice-secondary" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "is_active", "in": "query", "description": "Exact-match filter on `is_active`.", "schema": { "type": "string" } }, { "name": "primary_choice_linked_to", "in": "query", "description": "Exact-match filter on `primary_choice_linked_to`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "primary_choice_linked_to": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question_two_tiered_choice_primary.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-two-tiered-choice-secondary/{id}": { "get": { "operationId": "get_note_question_two_tiered_choice_secondary", "summary": "Get a single note-question-two-tiered-choice-secondary record", "tags": [ "note-question-two-tiered-choice-secondary" ], "security": [ { "bearerAuth": [ "read:note-question-two-tiered-choice-secondary" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "primary_choice_linked_to": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question_two_tiered_choice_primary.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-type": { "get": { "operationId": "list_note_question_type", "summary": "List note-question-type", "description": "Read-only view of `note_question_type`.", "tags": [ "note-question-type" ], "security": [ { "bearerAuth": [ "read:note-question-type" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "question_type_name", "in": "query", "description": "Exact-match filter on `question_type_name`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "question_type_name": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-question-type/{id}": { "get": { "operationId": "get_note_question_type", "summary": "Get a single note-question-type record", "tags": [ "note-question-type" ], "security": [ { "bearerAuth": [ "read:note-question-type" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "question_type_name": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-template": { "get": { "operationId": "list_note_template", "summary": "List note-template", "description": "Read-only view of `note_template`.", "tags": [ "note-template" ], "security": [ { "bearerAuth": [ "read:note-template" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "service_id", "in": "query", "description": "Exact-match filter on `service_id`.", "schema": { "type": "string" } }, { "name": "template_name", "in": "query", "description": "Exact-match filter on `template_name`.", "schema": { "type": "string" } }, { "name": "template_notes", "in": "query", "description": "Exact-match filter on `template_notes`.", "schema": { "type": "string" } }, { "name": "is_telehealth", "in": "query", "description": "Exact-match filter on `is_telehealth`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "service_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "template_name": { "type": "string", "nullable": true }, "template_notes": { "type": "string", "nullable": true }, "is_telehealth": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-template/{id}": { "get": { "operationId": "get_note_template", "summary": "Get a single note-template record", "tags": [ "note-template" ], "security": [ { "bearerAuth": [ "read:note-template" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "service_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "template_name": { "type": "string", "nullable": true }, "template_notes": { "type": "string", "nullable": true }, "is_telehealth": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-template-question-bridge": { "get": { "operationId": "list_note_template_question_bridge", "summary": "List note-template-question-bridge", "description": "Read-only view of `note_template_question_bridge`.", "tags": [ "note-template-question-bridge" ], "security": [ { "bearerAuth": [ "read:note-template-question-bridge" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "note_question_id", "in": "query", "description": "Exact-match filter on `note_question_id`.", "schema": { "type": "string" } }, { "name": "note_template_id", "in": "query", "description": "Exact-match filter on `note_template_id`.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Exact-match filter on `order`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "note_template_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_template.id`.", "nullable": true }, "order": { "type": "integer", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/note-template-question-bridge/{id}": { "get": { "operationId": "get_note_template_question_bridge", "summary": "Get a single note-template-question-bridge record", "tags": [ "note-template-question-bridge" ], "security": [ { "bearerAuth": [ "read:note-template-question-bridge" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "note_question_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_question.id`.", "nullable": true }, "note_template_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `note_template.id`.", "nullable": true }, "order": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/notifications": { "get": { "operationId": "list_notifications", "summary": "List notifications", "description": "Read-only view of `notifications`.", "tags": [ "notifications" ], "security": [ { "bearerAuth": [ "read:notifications" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "read_at", "expires_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Exact-match filter on `category`.", "schema": { "type": "string" } }, { "name": "recipient_id", "in": "query", "description": "Exact-match filter on `recipient_id`.", "schema": { "type": "string" } }, { "name": "actor_id", "in": "query", "description": "Exact-match filter on `actor_id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Exact-match filter on `title`.", "schema": { "type": "string" } }, { "name": "body", "in": "query", "description": "Exact-match filter on `body`.", "schema": { "type": "string" } }, { "name": "read_at", "in": "query", "description": "Exact-match filter on `read_at`.", "schema": { "type": "string" } }, { "name": "expires_at", "in": "query", "description": "Exact-match filter on `expires_at`.", "schema": { "type": "string" } }, { "name": "dedupe_key", "in": "query", "description": "Exact-match filter on `dedupe_key`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "category": { "type": "string", "nullable": true }, "recipient_id": { "type": "string", "format": "uuid", "description": "Recipient's AUTH user id (staff.auth_id, NOT staff.id). Must equal auth.uid() so the broadcast topic (user:) and the realtime.messages policy line up.", "nullable": true }, "actor_id": { "type": "string", "format": "uuid", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "title": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "payload": { "type": "object", "nullable": true }, "read_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "dedupe_key": { "type": "string", "description": "Idempotency key for cron/event producers, e.g. report_due:client123:2026-07. Unique PER RECIPIENT", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/notifications/{id}": { "get": { "operationId": "get_notifications", "summary": "Get a single notifications record", "tags": [ "notifications" ], "security": [ { "bearerAuth": [ "read:notifications" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "category": { "type": "string", "nullable": true }, "recipient_id": { "type": "string", "format": "uuid", "description": "Recipient's AUTH user id (staff.auth_id, NOT staff.id). Must equal auth.uid() so the broadcast topic (user:) and the realtime.messages policy line up.", "nullable": true }, "actor_id": { "type": "string", "format": "uuid", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "center_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "title": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "payload": { "type": "object", "nullable": true }, "read_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "dedupe_key": { "type": "string", "description": "Idempotency key for cron/event producers, e.g. report_due:client123:2026-07. Unique PER RECIPIENT", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-contact-log": { "get": { "operationId": "list_parent_contact_log", "summary": "List parent-contact-log", "description": "Read-only view of `parent_contact_log`.", "tags": [ "parent-contact-log" ], "security": [ { "bearerAuth": [ "read:parent-contact-log" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "contact_date", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "contact_date", "in": "query", "description": "Exact-match filter on `contact_date`.", "schema": { "type": "string" } }, { "name": "meeting_barrier_option_id", "in": "query", "description": "Exact-match filter on `meeting_barrier_option_id`.", "schema": { "type": "string" } }, { "name": "parent_reported_reason_option_id", "in": "query", "description": "Exact-match filter on `parent_reported_reason_option_id`.", "schema": { "type": "string" } }, { "name": "parent_reported_reason_other_text", "in": "query", "description": "Exact-match filter on `parent_reported_reason_other_text`.", "schema": { "type": "string" } }, { "name": "communication_summary", "in": "query", "description": "Exact-match filter on `communication_summary`.", "schema": { "type": "string" } }, { "name": "caregivers_communicated_with", "in": "query", "description": "Exact-match filter on `caregivers_communicated_with`.", "schema": { "type": "string" } }, { "name": "caregiver_response", "in": "query", "description": "Exact-match filter on `caregiver_response`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "contact_date": { "type": "string", "format": "date", "nullable": true }, "meeting_barrier_option_id": { "type": "integer", "description": "This is a Foreign Key to `parent_contact_meeting_barrier_option.id`.", "nullable": true }, "parent_reported_reason_option_id": { "type": "integer", "description": "This is a Foreign Key to `parent_contact_parent_reported_reason_option.id`.", "nullable": true }, "parent_reported_reason_other_text": { "type": "string", "nullable": true }, "communication_summary": { "type": "string", "nullable": true }, "caregivers_communicated_with": { "type": "string", "nullable": true }, "caregiver_response": { "type": "string", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-contact-log/{id}": { "get": { "operationId": "get_parent_contact_log", "summary": "Get a single parent-contact-log record", "tags": [ "parent-contact-log" ], "security": [ { "bearerAuth": [ "read:parent-contact-log" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "contact_date": { "type": "string", "format": "date", "nullable": true }, "meeting_barrier_option_id": { "type": "integer", "description": "This is a Foreign Key to `parent_contact_meeting_barrier_option.id`.", "nullable": true }, "parent_reported_reason_option_id": { "type": "integer", "description": "This is a Foreign Key to `parent_contact_parent_reported_reason_option.id`.", "nullable": true }, "parent_reported_reason_other_text": { "type": "string", "nullable": true }, "communication_summary": { "type": "string", "nullable": true }, "caregivers_communicated_with": { "type": "string", "nullable": true }, "caregiver_response": { "type": "string", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-contact-meeting-barrier-option": { "get": { "operationId": "list_parent_contact_meeting_barrier_option", "summary": "List parent-contact-meeting-barrier-option", "description": "Read-only view of `parent_contact_meeting_barrier_option`.", "tags": [ "parent-contact-meeting-barrier-option" ], "security": [ { "bearerAuth": [ "read:parent-contact-meeting-barrier-option" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Exact-match filter on `code`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "code": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-contact-meeting-barrier-option/{id}": { "get": { "operationId": "get_parent_contact_meeting_barrier_option", "summary": "Get a single parent-contact-meeting-barrier-option record", "tags": [ "parent-contact-meeting-barrier-option" ], "security": [ { "bearerAuth": [ "read:parent-contact-meeting-barrier-option" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-contact-parent-reported-reason-option": { "get": { "operationId": "list_parent_contact_parent_reported_reason_option", "summary": "List parent-contact-parent-reported-reason-option", "description": "Read-only view of `parent_contact_parent_reported_reason_option`.", "tags": [ "parent-contact-parent-reported-reason-option" ], "security": [ { "bearerAuth": [ "read:parent-contact-parent-reported-reason-option" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Exact-match filter on `code`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "code": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-contact-parent-reported-reason-option/{id}": { "get": { "operationId": "get_parent_contact_parent_reported_reason_option", "summary": "Get a single parent-contact-parent-reported-reason-option record", "tags": [ "parent-contact-parent-reported-reason-option" ], "security": [ { "bearerAuth": [ "read:parent-contact-parent-reported-reason-option" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-training-goal": { "get": { "operationId": "list_parent_training_goal", "summary": "List parent-training-goal", "description": "Read-only view of `parent_training_goal`.", "tags": [ "parent-training-goal" ], "security": [ { "bearerAuth": [ "read:parent-training-goal" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "objective", "in": "query", "description": "Exact-match filter on `objective`.", "schema": { "type": "string" } }, { "name": "mastery_criteria", "in": "query", "description": "Exact-match filter on `mastery_criteria`.", "schema": { "type": "string" } }, { "name": "baseline_data", "in": "query", "description": "Exact-match filter on `baseline_data`.", "schema": { "type": "string" } }, { "name": "current_level", "in": "query", "description": "Exact-match filter on `current_level`.", "schema": { "type": "string" } }, { "name": "date_goal_added", "in": "query", "description": "Exact-match filter on `date_goal_added`.", "schema": { "type": "string" } }, { "name": "status_option_id", "in": "query", "description": "Exact-match filter on `status_option_id`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "objective": { "type": "string", "nullable": true }, "mastery_criteria": { "type": "string", "nullable": true }, "baseline_data": { "type": "string", "nullable": true }, "current_level": { "type": "string", "nullable": true }, "date_goal_added": { "type": "string", "format": "date", "nullable": true }, "status_option_id": { "type": "integer", "description": "This is a Foreign Key to `parent_training_goal_status_option.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-training-goal/{id}": { "get": { "operationId": "get_parent_training_goal", "summary": "Get a single parent-training-goal record", "tags": [ "parent-training-goal" ], "security": [ { "bearerAuth": [ "read:parent-training-goal" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "objective": { "type": "string", "nullable": true }, "mastery_criteria": { "type": "string", "nullable": true }, "baseline_data": { "type": "string", "nullable": true }, "current_level": { "type": "string", "nullable": true }, "date_goal_added": { "type": "string", "format": "date", "nullable": true }, "status_option_id": { "type": "integer", "description": "This is a Foreign Key to `parent_training_goal_status_option.id`.", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-training-goal-status-option": { "get": { "operationId": "list_parent_training_goal_status_option", "summary": "List parent-training-goal-status-option", "description": "Read-only view of `parent_training_goal_status_option`.", "tags": [ "parent-training-goal-status-option" ], "security": [ { "bearerAuth": [ "read:parent-training-goal-status-option" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "rationale", "in": "query", "description": "Exact-match filter on `rationale`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "status": { "type": "string", "nullable": true }, "rationale": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-training-goal-status-option/{id}": { "get": { "operationId": "get_parent_training_goal_status_option", "summary": "Get a single parent-training-goal-status-option record", "tags": [ "parent-training-goal-status-option" ], "security": [ { "bearerAuth": [ "read:parent-training-goal-status-option" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "status": { "type": "string", "nullable": true }, "rationale": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-training-log": { "get": { "operationId": "list_parent_training_log", "summary": "List parent-training-log", "description": "Read-only view of `parent_training_log`.", "tags": [ "parent-training-log" ], "security": [ { "bearerAuth": [ "read:parent-training-log" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "training_date", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "training_date", "in": "query", "description": "Exact-match filter on `training_date`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "training_date": { "type": "string", "format": "date", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-training-log/{id}": { "get": { "operationId": "get_parent_training_log", "summary": "Get a single parent-training-log record", "tags": [ "parent-training-log" ], "security": [ { "bearerAuth": [ "read:parent-training-log" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "training_date": { "type": "string", "format": "date", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-training-log-goal-entry": { "get": { "operationId": "list_parent_training_log_goal_entry", "summary": "List parent-training-log-goal-entry", "description": "Read-only view of `parent_training_log_goal_entry`.", "tags": [ "parent-training-log-goal-entry" ], "security": [ { "bearerAuth": [ "read:parent-training-log-goal-entry" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "parent_training_log_id", "in": "query", "description": "Exact-match filter on `parent_training_log_id`.", "schema": { "type": "string" } }, { "name": "parent_training_goal_id", "in": "query", "description": "Exact-match filter on `parent_training_goal_id`.", "schema": { "type": "string" } }, { "name": "training_session_data", "in": "query", "description": "Exact-match filter on `training_session_data`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "parent_training_log_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `parent_training_log.id`.", "nullable": true }, "parent_training_goal_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `parent_training_goal.id`.", "nullable": true }, "training_session_data": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/parent-training-log-goal-entry/{id}": { "get": { "operationId": "get_parent_training_log_goal_entry", "summary": "Get a single parent-training-log-goal-entry record", "tags": [ "parent-training-log-goal-entry" ], "security": [ { "bearerAuth": [ "read:parent-training-log-goal-entry" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "parent_training_log_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `parent_training_log.id`.", "nullable": true }, "parent_training_goal_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `parent_training_goal.id`.", "nullable": true }, "training_session_data": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/reports": { "get": { "operationId": "list_reports", "summary": "List reports", "description": "Read-only view of `reports`.", "tags": [ "reports" ], "security": [ { "bearerAuth": [ "read:reports" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "image", "in": "query", "description": "Exact-match filter on `image`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "short_description", "in": "query", "description": "Exact-match filter on `short_description`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "app_path", "in": "query", "description": "Exact-match filter on `app_path`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "image": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "short_description": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "app_path": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/reports/{id}": { "get": { "operationId": "get_reports", "summary": "Get a single reports record", "tags": [ "reports" ], "security": [ { "bearerAuth": [ "read:reports" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "image": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "short_description": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "app_path": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/rules-engine-logs": { "get": { "operationId": "list_rules_engine_logs", "summary": "List rules-engine-logs", "description": "Read-only view of `rules_engine_logs`.", "tags": [ "rules-engine-logs" ], "security": [ { "bearerAuth": [ "read:rules-engine-logs" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "user_email", "in": "query", "description": "Exact-match filter on `user_email`.", "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "Exact-match filter on `action`.", "schema": { "type": "string" } }, { "name": "result", "in": "query", "description": "Exact-match filter on `result`.", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Exact-match filter on `appointment_id`.", "schema": { "type": "string" } }, { "name": "service_id", "in": "query", "description": "Exact-match filter on `service_id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "user_email": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "result": { "type": "string", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "nullable": true }, "service_id": { "type": "integer", "format": "int64", "nullable": true }, "ids_of_conflicted_appointments": { "type": "object", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/rules-engine-logs/{id}": { "get": { "operationId": "get_rules_engine_logs", "summary": "Get a single rules-engine-logs record", "tags": [ "rules-engine-logs" ], "security": [ { "bearerAuth": [ "read:rules-engine-logs" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "user_email": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "result": { "type": "string", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "nullable": true }, "service_id": { "type": "integer", "format": "int64", "nullable": true }, "ids_of_conflicted_appointments": { "type": "object", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/scheduler-centers": { "get": { "operationId": "list_scheduler_centers", "summary": "List scheduler-centers", "description": "Read-only view of `scheduler_centers`.", "tags": [ "scheduler-centers" ], "security": [ { "bearerAuth": [ "read:scheduler-centers" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "center_id", "updated_at" ], "default": "center_id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "center_id", "in": "query", "description": "Exact-match filter on `center_id`.", "schema": { "type": "string" } }, { "name": "json_data", "in": "query", "description": "Exact-match filter on `json_data`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } }, { "name": "updated_by_staff_id", "in": "query", "description": "Exact-match filter on `updated_by_staff_id`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "timezone", "in": "query", "description": "Exact-match filter on `timezone`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "center_id": { "type": "integer", "format": "int64", "nullable": true }, "json_data": { "type": "string", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_by_staff_id": { "type": "string", "nullable": true }, "updated_by": { "type": "string", "description": "Display name or auth UUID of the user who last saved the roster", "nullable": true }, "timezone": { "type": "string", "description": "IANA timezone identifier (validated via Python zoneinfo) used for center-local day-boundary calculations. Set once at center creation; never edited.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/scheduler-centers/{id}": { "get": { "operationId": "get_scheduler_centers", "summary": "Get a single scheduler-centers record", "tags": [ "scheduler-centers" ], "security": [ { "bearerAuth": [ "read:scheduler-centers" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `center_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "center_id": { "type": "integer", "format": "int64", "nullable": true }, "json_data": { "type": "string", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_by_staff_id": { "type": "string", "nullable": true }, "updated_by": { "type": "string", "description": "Display name or auth UUID of the user who last saved the roster", "nullable": true }, "timezone": { "type": "string", "description": "IANA timezone identifier (validated via Python zoneinfo) used for center-local day-boundary calculations. Set once at center creation; never edited.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/school": { "get": { "operationId": "list_school", "summary": "List school", "description": "Read-only view of `school`.", "tags": [ "school" ], "security": [ { "bearerAuth": [ "read:school" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Exact-match filter on `type`.", "schema": { "type": "string" } }, { "name": "website", "in": "query", "description": "Exact-match filter on `website`.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Exact-match filter on `state`.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact-match filter on `city`.", "schema": { "type": "string" } }, { "name": "logo", "in": "query", "description": "Exact-match filter on `logo`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/school/{id}": { "get": { "operationId": "get_school", "summary": "Get a single school record", "tags": [ "school" ], "security": [ { "bearerAuth": [ "read:school" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/service": { "get": { "operationId": "list_service", "summary": "List service", "description": "Read-only view of `service`.", "tags": [ "service" ], "security": [ { "bearerAuth": [ "read:service" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "discipline", "in": "query", "description": "Exact-match filter on `discipline`.", "schema": { "type": "string" } }, { "name": "spot_goal_applies_to", "in": "query", "description": "Exact-match filter on `spot_goal_applies_to`.", "schema": { "type": "string" } }, { "name": "is_active", "in": "query", "description": "Exact-match filter on `is_active`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "discipline": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "can_overlap_client_with_multiple_staff": { "type": "array", "nullable": true }, "can_overlap_staff_with_multiple_clients": { "type": "array", "nullable": true }, "spot_goal_applies_to": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/service/{id}": { "get": { "operationId": "get_service", "summary": "Get a single service record", "tags": [ "service" ], "security": [ { "bearerAuth": [ "read:service" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "discipline": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "can_overlap_client_with_multiple_staff": { "type": "array", "nullable": true }, "can_overlap_staff_with_multiple_clients": { "type": "array", "nullable": true }, "spot_goal_applies_to": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/signature": { "get": { "operationId": "list_signature", "summary": "List signature", "description": "Read-only view of `signature`.", "tags": [ "signature" ], "security": [ { "bearerAuth": [ "read:signature" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "last_update", "in": "query", "description": "Exact-match filter on `last_update`.", "schema": { "type": "string" } }, { "name": "approved_by", "in": "query", "description": "Exact-match filter on `approved_by`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "signature_url", "in": "query", "description": "Exact-match filter on `signature_url`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "staff_id": { "type": "integer", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "last_update": { "type": "string", "format": "date", "nullable": true }, "approved_by": { "type": "integer", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "status": { "type": "string", "nullable": true }, "signature_url": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/signature/{id}": { "get": { "operationId": "get_signature", "summary": "Get a single signature record", "tags": [ "signature" ], "security": [ { "bearerAuth": [ "read:signature" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "nullable": true }, "staff_id": { "type": "integer", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "last_update": { "type": "string", "format": "date", "nullable": true }, "approved_by": { "type": "integer", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "status": { "type": "string", "nullable": true }, "signature_url": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/spot-goal": { "get": { "operationId": "list_spot_goal", "summary": "List spot-goal", "description": "Read-only view of `spot_goal`.", "tags": [ "spot-goal" ], "security": [ { "bearerAuth": [ "read:spot-goal" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "name" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Exact-match filter on `name`.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Exact-match filter on `description`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "date_initiated", "in": "query", "description": "Exact-match filter on `date_initiated`.", "schema": { "type": "string" } }, { "name": "date_mastered", "in": "query", "description": "Exact-match filter on `date_mastered`.", "schema": { "type": "string" } }, { "name": "discipline_id", "in": "query", "description": "Exact-match filter on `discipline_id`.", "schema": { "type": "string" } }, { "name": "applies_to", "in": "query", "description": "Exact-match filter on `applies_to`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "date_initiated": { "type": "string", "format": "date", "nullable": true }, "date_mastered": { "type": "string", "format": "date", "nullable": true }, "discipline_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "applies_to": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/spot-goal/{id}": { "get": { "operationId": "get_spot_goal", "summary": "Get a single spot-goal record", "tags": [ "spot-goal" ], "security": [ { "bearerAuth": [ "read:spot-goal" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "date_initiated": { "type": "string", "format": "date", "nullable": true }, "date_mastered": { "type": "string", "format": "date", "nullable": true }, "discipline_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `discipline.id`.", "nullable": true }, "applies_to": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff": { "get": { "operationId": "list_staff", "summary": "List staff", "description": "Read-only view of `staff`.", "tags": [ "staff" ], "security": [ { "bearerAuth": [ "read:staff" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "hire_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "Exact-match filter on `first_name`.", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Exact-match filter on `last_name`.", "schema": { "type": "string" } }, { "name": "preferred_first_name", "in": "query", "description": "Exact-match filter on `preferred_first_name`.", "schema": { "type": "string" } }, { "name": "former_last_name", "in": "query", "description": "Exact-match filter on `former_last_name`.", "schema": { "type": "string" } }, { "name": "center", "in": "query", "description": "Exact-match filter on `center`.", "schema": { "type": "string" } }, { "name": "middle_name", "in": "query", "description": "Exact-match filter on `middle_name`.", "schema": { "type": "string" } }, { "name": "job_title", "in": "query", "description": "Exact-match filter on `job_title`.", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Exact-match filter on `email`.", "schema": { "type": "string" } }, { "name": "hire_date", "in": "query", "description": "Exact-match filter on `hire_date`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "npi_number", "in": "query", "description": "Exact-match filter on `npi_number`.", "schema": { "type": "string" } }, { "name": "caqh_number", "in": "query", "description": "Exact-match filter on `caqh_number`.", "schema": { "type": "string" } }, { "name": "phone_number", "in": "query", "description": "Exact-match filter on `phone_number`.", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Exact-match filter on `gender`.", "schema": { "type": "string" } }, { "name": "staff_status", "in": "query", "description": "Exact-match filter on `staff_status`.", "schema": { "type": "string" } }, { "name": "last_day", "in": "query", "description": "Exact-match filter on `last_day`.", "schema": { "type": "string" } }, { "name": "auth_id", "in": "query", "description": "Exact-match filter on `auth_id`.", "schema": { "type": "string" } }, { "name": "connected_to", "in": "query", "description": "Exact-match filter on `connected_to`.", "schema": { "type": "string" } }, { "name": "HRIS_ID", "in": "query", "description": "Exact-match filter on `HRIS_ID`.", "schema": { "type": "string" } }, { "name": "credentials", "in": "query", "description": "Exact-match filter on `credentials`.", "schema": { "type": "string" } }, { "name": "external_ehr_id", "in": "query", "description": "Exact-match filter on `external_ehr_id`.", "schema": { "type": "string" } }, { "name": "crm_object_id", "in": "query", "description": "Exact-match filter on `crm_object_id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "former_last_name": { "type": "string", "nullable": true }, "center": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "middle_name": { "type": "string", "nullable": true }, "job_title": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `job_title.id`.", "nullable": true }, "email": { "type": "string", "nullable": true }, "hire_date": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "npi_number": { "type": "string", "nullable": true }, "caqh_number": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "staff_status": { "type": "string", "nullable": true }, "last_day": { "type": "string", "format": "date", "nullable": true }, "auth_id": { "type": "string", "format": "uuid", "nullable": true }, "connected_to": { "type": "string", "nullable": true }, "HRIS_ID": { "type": "string", "nullable": true }, "credentials": { "type": "string", "nullable": true }, "external_ehr_id": { "type": "integer", "format": "int64", "description": "Central reach system identifier for staff member", "nullable": true }, "crm_object_id": { "type": "integer", "format": "int64", "description": "HubSpot contact record identifier for staff member", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff/{id}": { "get": { "operationId": "get_staff", "summary": "Get a single staff record", "tags": [ "staff" ], "security": [ { "bearerAuth": [ "read:staff" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "preferred_first_name": { "type": "string", "nullable": true }, "former_last_name": { "type": "string", "nullable": true }, "center": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `center.id`.", "nullable": true }, "middle_name": { "type": "string", "nullable": true }, "job_title": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `job_title.id`.", "nullable": true }, "email": { "type": "string", "nullable": true }, "hire_date": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "npi_number": { "type": "string", "nullable": true }, "caqh_number": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "staff_status": { "type": "string", "nullable": true }, "last_day": { "type": "string", "format": "date", "nullable": true }, "auth_id": { "type": "string", "format": "uuid", "nullable": true }, "connected_to": { "type": "string", "nullable": true }, "HRIS_ID": { "type": "string", "nullable": true }, "credentials": { "type": "string", "nullable": true }, "external_ehr_id": { "type": "integer", "format": "int64", "description": "Central reach system identifier for staff member", "nullable": true }, "crm_object_id": { "type": "integer", "format": "int64", "description": "HubSpot contact record identifier for staff member", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff-certification-licensure": { "get": { "operationId": "list_staff_certification_licensure", "summary": "List staff-certification-licensure", "description": "Read-only view of `staff_certification_licensure`.", "tags": [ "staff-certification-licensure" ], "security": [ { "bearerAuth": [ "read:staff-certification-licensure" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "original_issue_date", "current_issue_date", "expiration_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "license_certification", "in": "query", "description": "Exact-match filter on `license_certification`.", "schema": { "type": "string" } }, { "name": "original_issue_date", "in": "query", "description": "Exact-match filter on `original_issue_date`.", "schema": { "type": "string" } }, { "name": "current_issue_date", "in": "query", "description": "Exact-match filter on `current_issue_date`.", "schema": { "type": "string" } }, { "name": "expiration_date", "in": "query", "description": "Exact-match filter on `expiration_date`.", "schema": { "type": "string" } }, { "name": "license_certification_number", "in": "query", "description": "Exact-match filter on `license_certification_number`.", "schema": { "type": "string" } }, { "name": "documentation", "in": "query", "description": "Exact-match filter on `documentation`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "license_certification": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `license_certification.id`.", "nullable": true }, "original_issue_date": { "type": "string", "format": "date", "nullable": true }, "current_issue_date": { "type": "string", "format": "date", "nullable": true }, "expiration_date": { "type": "string", "format": "date", "nullable": true }, "license_certification_number": { "type": "string", "nullable": true }, "documentation": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff-certification-licensure/{id}": { "get": { "operationId": "get_staff_certification_licensure", "summary": "Get a single staff-certification-licensure record", "tags": [ "staff-certification-licensure" ], "security": [ { "bearerAuth": [ "read:staff-certification-licensure" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "license_certification": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `license_certification.id`.", "nullable": true }, "original_issue_date": { "type": "string", "format": "date", "nullable": true }, "current_issue_date": { "type": "string", "format": "date", "nullable": true }, "expiration_date": { "type": "string", "format": "date", "nullable": true }, "license_certification_number": { "type": "string", "nullable": true }, "documentation": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff-education": { "get": { "operationId": "list_staff_education", "summary": "List staff-education", "description": "Read-only view of `staff_education`.", "tags": [ "staff-education" ], "security": [ { "bearerAuth": [ "read:staff-education" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "school_id", "in": "query", "description": "Exact-match filter on `school_id`.", "schema": { "type": "string" } }, { "name": "date_graduated", "in": "query", "description": "Exact-match filter on `date_graduated`.", "schema": { "type": "string" } }, { "name": "degree", "in": "query", "description": "Exact-match filter on `degree`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "school_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `school.id`.", "nullable": true }, "date_graduated": { "type": "string", "format": "date", "nullable": true }, "degree": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff-education/{id}": { "get": { "operationId": "get_staff_education", "summary": "Get a single staff-education record", "tags": [ "staff-education" ], "security": [ { "bearerAuth": [ "read:staff-education" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "school_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `school.id`.", "nullable": true }, "date_graduated": { "type": "string", "format": "date", "nullable": true }, "degree": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff-insurance-credentialing": { "get": { "operationId": "list_staff_insurance_credentialing", "summary": "List staff-insurance-credentialing", "description": "Read-only view of `staff_insurance_credentialing`.", "tags": [ "staff-insurance-credentialing" ], "security": [ { "bearerAuth": [ "read:staff-insurance-credentialing" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "credentialed_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "staff", "in": "query", "description": "Exact-match filter on `staff`.", "schema": { "type": "string" } }, { "name": "insurance_company", "in": "query", "description": "Exact-match filter on `insurance_company`.", "schema": { "type": "string" } }, { "name": "date_submitted", "in": "query", "description": "Exact-match filter on `date_submitted`.", "schema": { "type": "string" } }, { "name": "credentialed_date", "in": "query", "description": "Exact-match filter on `credentialed_date`.", "schema": { "type": "string" } }, { "name": "date_approved", "in": "query", "description": "Exact-match filter on `date_approved`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "is_approved_due_to_group", "in": "query", "description": "Exact-match filter on `is_approved_due_to_group`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "staff_credentialing_status", "in": "query", "description": "Exact-match filter on `staff_credentialing_status`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "staff": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "insurance_company": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `insurance_company.id`.", "nullable": true }, "date_submitted": { "type": "string", "format": "date", "nullable": true }, "credentialed_date": { "type": "string", "format": "date", "nullable": true }, "date_approved": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "is_approved_due_to_group": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "staff_credentialing_status": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff-insurance-credentialing/{id}": { "get": { "operationId": "get_staff_insurance_credentialing", "summary": "Get a single staff-insurance-credentialing record", "tags": [ "staff-insurance-credentialing" ], "security": [ { "bearerAuth": [ "read:staff-insurance-credentialing" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "staff": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "insurance_company": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `insurance_company.id`.", "nullable": true }, "date_submitted": { "type": "string", "format": "date", "nullable": true }, "credentialed_date": { "type": "string", "format": "date", "nullable": true }, "date_approved": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "is_approved_due_to_group": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "staff_credentialing_status": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff-leave": { "get": { "operationId": "list_staff_leave", "summary": "List staff-leave", "description": "Read-only view of `staff_leave`.", "tags": [ "staff-leave" ], "security": [ { "bearerAuth": [ "read:staff-leave" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "leave_start_date", "leave_end_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "leave_start_date", "in": "query", "description": "Exact-match filter on `leave_start_date`.", "schema": { "type": "string" } }, { "name": "leave_end_date", "in": "query", "description": "Exact-match filter on `leave_end_date`.", "schema": { "type": "string" } }, { "name": "leave_notes", "in": "query", "description": "Exact-match filter on `leave_notes`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "leave_start_date": { "type": "string", "format": "date", "nullable": true }, "leave_end_date": { "type": "string", "format": "date", "nullable": true }, "leave_notes": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/staff-leave/{id}": { "get": { "operationId": "get_staff_leave", "summary": "Get a single staff-leave record", "tags": [ "staff-leave" ], "security": [ { "bearerAuth": [ "read:staff-leave" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "leave_start_date": { "type": "string", "format": "date", "nullable": true }, "leave_end_date": { "type": "string", "format": "date", "nullable": true }, "leave_notes": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/standard-rate": { "get": { "operationId": "list_standard_rate", "summary": "List standard-rate", "description": "Read-only view of `standard_rate`.", "tags": [ "standard-rate" ], "security": [ { "bearerAuth": [ "read:standard-rate" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Exact-match filter on `service`.", "schema": { "type": "string" } }, { "name": "rate_per_unit", "in": "query", "description": "Exact-match filter on `rate_per_unit`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "service": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "rate_per_unit": { "type": "number", "nullable": true }, "notes": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/standard-rate/{id}": { "get": { "operationId": "get_standard_rate", "summary": "Get a single standard-rate record", "tags": [ "standard-rate" ], "security": [ { "bearerAuth": [ "read:standard-rate" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "service": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "rate_per_unit": { "type": "number", "nullable": true }, "notes": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/suggested-edit": { "get": { "operationId": "list_suggested_edit", "summary": "List suggested-edit", "description": "Read-only view of `suggested_edit`.", "tags": [ "suggested-edit" ], "security": [ { "bearerAuth": [ "read:suggested-edit" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "suggested_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Exact-match filter on `appointment_id`.", "schema": { "type": "string" } }, { "name": "suggested_by", "in": "query", "description": "Exact-match filter on `suggested_by`.", "schema": { "type": "string" } }, { "name": "suggested_client", "in": "query", "description": "Exact-match filter on `suggested_client`.", "schema": { "type": "string" } }, { "name": "suggested_service", "in": "query", "description": "Exact-match filter on `suggested_service`.", "schema": { "type": "string" } }, { "name": "suggested_location", "in": "query", "description": "Exact-match filter on `suggested_location`.", "schema": { "type": "string" } }, { "name": "suggested_date", "in": "query", "description": "Exact-match filter on `suggested_date`.", "schema": { "type": "string" } }, { "name": "suggested_start_time", "in": "query", "description": "Exact-match filter on `suggested_start_time`.", "schema": { "type": "string" } }, { "name": "suggested_end_time", "in": "query", "description": "Exact-match filter on `suggested_end_time`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } }, { "name": "signature", "in": "query", "description": "Exact-match filter on `signature`.", "schema": { "type": "string" } }, { "name": "suggested_start_time_new", "in": "query", "description": "Exact-match filter on `suggested_start_time_new`.", "schema": { "type": "string" } }, { "name": "suggested_end_time_new", "in": "query", "description": "Exact-match filter on `suggested_end_time_new`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "suggested_by": { "type": "string", "nullable": true }, "suggested_client": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "suggested_service": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "suggested_location": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `location.id`.", "nullable": true }, "suggested_date": { "type": "string", "format": "date", "nullable": true }, "suggested_start_time": { "type": "string", "nullable": true }, "suggested_end_time": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true }, "suggested_start_time_new": { "type": "string", "format": "date-time", "nullable": true }, "suggested_end_time_new": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/suggested-edit/{id}": { "get": { "operationId": "get_suggested_edit", "summary": "Get a single suggested-edit record", "tags": [ "suggested-edit" ], "security": [ { "bearerAuth": [ "read:suggested-edit" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "suggested_by": { "type": "string", "nullable": true }, "suggested_client": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "suggested_service": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `service.id`.", "nullable": true }, "suggested_location": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `location.id`.", "nullable": true }, "suggested_date": { "type": "string", "format": "date", "nullable": true }, "suggested_start_time": { "type": "string", "nullable": true }, "suggested_end_time": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true }, "suggested_start_time_new": { "type": "string", "format": "date-time", "nullable": true }, "suggested_end_time_new": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/supervising-bcba-connection": { "get": { "operationId": "list_supervising_bcba_connection", "summary": "List supervising-bcba-connection", "description": "Read-only view of `supervising_bcba_connection`.", "tags": [ "supervising-bcba-connection" ], "security": [ { "bearerAuth": [ "read:supervising-bcba-connection" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "start_date", "end_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "bcba_id", "in": "query", "description": "Exact-match filter on `bcba_id`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "bcba_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/supervising-bcba-connection/{id}": { "get": { "operationId": "get_supervising_bcba_connection", "summary": "Get a single supervising-bcba-connection record", "tags": [ "supervising-bcba-connection" ], "security": [ { "bearerAuth": [ "read:supervising-bcba-connection" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "bcba_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/supervising-staff-connection": { "get": { "operationId": "list_supervising_staff_connection", "summary": "List supervising-staff-connection", "description": "Read-only view of `supervising_staff_connection`.", "tags": [ "supervising-staff-connection" ], "security": [ { "bearerAuth": [ "read:supervising-staff-connection" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "start_date", "end_date" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "discipline", "in": "query", "description": "Exact-match filter on `discipline`.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Exact-match filter on `start_date`.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Exact-match filter on `end_date`.", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Exact-match filter on `notes`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "discipline": { "type": "string", "description": "The type of supervision provided: BCBA (Board Certified Behavior Analyst), OT (Occupational Therapist), or SLP (Speech-Language Pathologist)", "nullable": true }, "start_date": { "type": "string", "format": "date", "description": "First day of supervision (inclusive)", "nullable": true }, "end_date": { "type": "string", "format": "date", "description": "Last day of supervision (inclusive). NULL indicates no scheduled end date. A current supervisor may have an end_date set when an upcoming supervisor is scheduled.", "nullable": true }, "notes": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/supervising-staff-connection/{id}": { "get": { "operationId": "get_supervising_staff_connection", "summary": "Get a single supervising-staff-connection record", "tags": [ "supervising-staff-connection" ], "security": [ { "bearerAuth": [ "read:supervising-staff-connection" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "discipline": { "type": "string", "description": "The type of supervision provided: BCBA (Board Certified Behavior Analyst), OT (Occupational Therapist), or SLP (Speech-Language Pathologist)", "nullable": true }, "start_date": { "type": "string", "format": "date", "description": "First day of supervision (inclusive)", "nullable": true }, "end_date": { "type": "string", "format": "date", "description": "Last day of supervision (inclusive). NULL indicates no scheduled end date. A current supervisor may have an end_date set when an upcoming supervisor is scheduled.", "nullable": true }, "notes": { "type": "string", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/treatment-plan": { "get": { "operationId": "list_treatment_plan", "summary": "List treatment-plan", "description": "Read-only view of `treatment_plan`.", "tags": [ "treatment-plan" ], "security": [ { "bearerAuth": [ "read:treatment-plan" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "variant", "in": "query", "description": "Exact-match filter on `variant`.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Exact-match filter on `status`.", "schema": { "type": "string" } }, { "name": "payer", "in": "query", "description": "Exact-match filter on `payer`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "variant": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "payer": { "type": "string", "nullable": true }, "content": { "type": "object", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/treatment-plan/{id}": { "get": { "operationId": "get_treatment_plan", "summary": "Get a single treatment-plan record", "tags": [ "treatment-plan" ], "security": [ { "bearerAuth": [ "read:treatment-plan" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "variant": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "payer": { "type": "string", "nullable": true }, "content": { "type": "object", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/treatment-plan-ai-review-audit": { "get": { "operationId": "list_treatment_plan_ai_review_audit", "summary": "List treatment-plan-ai-review-audit", "description": "Read-only view of `treatment_plan_ai_review_audit`.", "tags": [ "treatment-plan-ai-review-audit" ], "security": [ { "bearerAuth": [ "read:treatment-plan-ai-review-audit" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "correlation_id", "in": "query", "description": "Exact-match filter on `correlation_id`.", "schema": { "type": "string" } }, { "name": "treatment_plan_id", "in": "query", "description": "Exact-match filter on `treatment_plan_id`.", "schema": { "type": "string" } }, { "name": "staff_id", "in": "query", "description": "Exact-match filter on `staff_id`.", "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Exact-match filter on `event`.", "schema": { "type": "string" } }, { "name": "model", "in": "query", "description": "Exact-match filter on `model`.", "schema": { "type": "string" } }, { "name": "endpoint", "in": "query", "description": "Exact-match filter on `endpoint`.", "schema": { "type": "string" } }, { "name": "finding_count", "in": "query", "description": "Exact-match filter on `finding_count`.", "schema": { "type": "string" } }, { "name": "error_name", "in": "query", "description": "Exact-match filter on `error_name`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "correlation_id": { "type": "string", "format": "uuid", "nullable": true }, "treatment_plan_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `treatment_plan.id`.", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "event": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "endpoint": { "type": "string", "nullable": true }, "finding_count": { "type": "integer", "nullable": true }, "error_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/treatment-plan-ai-review-audit/{id}": { "get": { "operationId": "get_treatment_plan_ai_review_audit", "summary": "Get a single treatment-plan-ai-review-audit record", "tags": [ "treatment-plan-ai-review-audit" ], "security": [ { "bearerAuth": [ "read:treatment-plan-ai-review-audit" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "correlation_id": { "type": "string", "format": "uuid", "nullable": true }, "treatment_plan_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `treatment_plan.id`.", "nullable": true }, "staff_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "event": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "endpoint": { "type": "string", "nullable": true }, "finding_count": { "type": "integer", "nullable": true }, "error_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/treatment-plan-payer-rule": { "get": { "operationId": "list_treatment_plan_payer_rule", "summary": "List treatment-plan-payer-rule", "description": "Read-only view of `treatment_plan_payer_rule`.", "tags": [ "treatment-plan-payer-rule" ], "security": [ { "bearerAuth": [ "read:treatment-plan-payer-rule" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "payer_key", "in": "query", "description": "Exact-match filter on `payer_key`.", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Exact-match filter on `display_name`.", "schema": { "type": "string" } }, { "name": "alias_pattern", "in": "query", "description": "Exact-match filter on `alias_pattern`.", "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "description": "Exact-match filter on `sort_order`.", "schema": { "type": "string" } }, { "name": "is_active", "in": "query", "description": "Exact-match filter on `is_active`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "payer_key": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "alias_pattern": { "type": "string", "nullable": true }, "requirements": { "type": "object", "nullable": true }, "sort_order": { "type": "integer", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/treatment-plan-payer-rule/{id}": { "get": { "operationId": "get_treatment_plan_payer_rule", "summary": "Get a single treatment-plan-payer-rule record", "tags": [ "treatment-plan-payer-rule" ], "security": [ { "bearerAuth": [ "read:treatment-plan-payer-rule" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "payer_key": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "alias_pattern": { "type": "string", "nullable": true }, "requirements": { "type": "object", "nullable": true }, "sort_order": { "type": "integer", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/treatment-plan-revision": { "get": { "operationId": "list_treatment_plan_revision", "summary": "List treatment-plan-revision", "description": "Read-only view of `treatment_plan_revision`.", "tags": [ "treatment-plan-revision" ], "security": [ { "bearerAuth": [ "read:treatment-plan-revision" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "created_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "treatment_plan_id", "in": "query", "description": "Exact-match filter on `treatment_plan_id`.", "schema": { "type": "string" } }, { "name": "revision", "in": "query", "description": "Exact-match filter on `revision`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "treatment_plan_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `treatment_plan.id`.", "nullable": true }, "revision": { "type": "integer", "nullable": true }, "content": { "type": "object", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/treatment-plan-revision/{id}": { "get": { "operationId": "get_treatment_plan_revision", "summary": "Get a single treatment-plan-revision record", "tags": [ "treatment-plan-revision" ], "security": [ { "bearerAuth": [ "read:treatment-plan-revision" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "treatment_plan_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `treatment_plan.id`.", "nullable": true }, "revision": { "type": "integer", "nullable": true }, "content": { "type": "object", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/trial-entry": { "get": { "operationId": "list_trial_entry", "summary": "List trial-entry", "description": "Read-only view of `trial_entry`.", "tags": [ "trial-entry" ], "security": [ { "bearerAuth": [ "read:trial-entry" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "entered_at", "created_at", "updated_at" ], "default": "created_at" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Exact-match filter on `client_id`.", "schema": { "type": "string" } }, { "name": "chart_id", "in": "query", "description": "Exact-match filter on `chart_id`.", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Exact-match filter on `appointment_id`.", "schema": { "type": "string" } }, { "name": "date_of_service", "in": "query", "description": "Exact-match filter on `date_of_service`.", "schema": { "type": "string" } }, { "name": "response_code", "in": "query", "description": "Exact-match filter on `response_code`.", "schema": { "type": "string" } }, { "name": "duration_seconds", "in": "query", "description": "Exact-match filter on `duration_seconds`.", "schema": { "type": "string" } }, { "name": "entered_at", "in": "query", "description": "Exact-match filter on `entered_at`.", "schema": { "type": "string" } }, { "name": "client_uuid", "in": "query", "description": "Exact-match filter on `client_uuid`.", "schema": { "type": "string" } }, { "name": "created_by", "in": "query", "description": "Exact-match filter on `created_by`.", "schema": { "type": "string" } }, { "name": "updated_by", "in": "query", "description": "Exact-match filter on `updated_by`.", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Exact-match filter on `created_at`.", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Exact-match filter on `updated_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "date_of_service": { "type": "string", "format": "date", "nullable": true }, "response_code": { "type": "string", "nullable": true }, "duration_seconds": { "type": "integer", "nullable": true }, "entered_at": { "type": "string", "format": "date-time", "description": "Tap time on the client clock (distinct from created_at, the server insert time).", "nullable": true }, "client_uuid": { "type": "string", "format": "uuid", "description": "Client-generated idempotency key: dedupes replayed inserts from the offline sync queue (trials have no natural unique key).", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/trial-entry/{id}": { "get": { "operationId": "get_trial_entry", "summary": "Get a single trial-entry record", "tags": [ "trial-entry" ], "security": [ { "bearerAuth": [ "read:trial-entry" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "client_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `client.id`.", "nullable": true }, "chart_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `chart.id`.", "nullable": true }, "appointment_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `appointment.id`.", "nullable": true }, "date_of_service": { "type": "string", "format": "date", "nullable": true }, "response_code": { "type": "string", "nullable": true }, "duration_seconds": { "type": "integer", "nullable": true }, "entered_at": { "type": "string", "format": "date-time", "description": "Tap time on the client clock (distinct from created_at, the server insert time).", "nullable": true }, "client_uuid": { "type": "string", "format": "uuid", "description": "Client-generated idempotency key: dedupes replayed inserts from the offline sync queue (trials have no natural unique key).", "nullable": true }, "created_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "updated_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/trial-entry-edit": { "get": { "operationId": "list_trial_entry_edit", "summary": "List trial-entry-edit", "description": "Read-only view of `trial_entry_edit`.", "tags": [ "trial-entry-edit" ], "security": [ { "bearerAuth": [ "read:trial-entry-edit" ] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Page size (1-100). Defaults to 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Number of records to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Column to sort by.", "schema": { "type": "string", "enum": [ "id", "edited_at" ], "default": "id" } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "id", "in": "query", "description": "Exact-match filter on `id`.", "schema": { "type": "string" } }, { "name": "trial_entry_id", "in": "query", "description": "Exact-match filter on `trial_entry_id`.", "schema": { "type": "string" } }, { "name": "fluency_run_id", "in": "query", "description": "Exact-match filter on `fluency_run_id`.", "schema": { "type": "string" } }, { "name": "reason_for_edit", "in": "query", "description": "Exact-match filter on `reason_for_edit`.", "schema": { "type": "string" } }, { "name": "client_uuid", "in": "query", "description": "Exact-match filter on `client_uuid`.", "schema": { "type": "string" } }, { "name": "edited_by", "in": "query", "description": "Exact-match filter on `edited_by`.", "schema": { "type": "string" } }, { "name": "edited_at", "in": "query", "description": "Exact-match filter on `edited_at`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "trial_entry_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `trial_entry.id`.", "nullable": true }, "fluency_run_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `fluency_run.id`.", "nullable": true }, "old_value": { "type": "object", "nullable": true }, "new_value": { "type": "object", "nullable": true }, "reason_for_edit": { "type": "string", "nullable": true }, "client_uuid": { "type": "string", "format": "uuid", "description": "Client-generated idempotency key: edits can be made offline and have no natural dedup key, so this dedupes replayed edit-syncs.", "nullable": true }, "edited_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "edited_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/api/public/v1/trial-entry-edit/{id}": { "get": { "operationId": "get_trial_entry_edit", "summary": "Get a single trial-entry-edit record", "tags": [ "trial-entry-edit" ], "security": [ { "bearerAuth": [ "read:trial-entry-edit" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Value of `id`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "trial_entry_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `trial_entry.id`.", "nullable": true }, "fluency_run_id": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `fluency_run.id`.", "nullable": true }, "old_value": { "type": "object", "nullable": true }, "new_value": { "type": "object", "nullable": true }, "reason_for_edit": { "type": "string", "nullable": true }, "client_uuid": { "type": "string", "format": "uuid", "description": "Client-generated idempotency key: edits can be made offline and have no natural dedup key, so this dedupes replayed edit-syncs.", "nullable": true }, "edited_by": { "type": "integer", "format": "int64", "description": "This is a Foreign Key to `staff.id`.", "nullable": true }, "edited_at": { "type": "string", "format": "date-time", "nullable": true } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "responses": { "BadRequest": { "description": "Malformed request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "Unauthorized": { "description": "Missing, invalid or expired credentials.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "Forbidden": { "description": "The token lacks the required scope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "NotFound": { "description": "No such resource or record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "RateLimited": { "description": "Too many requests in the current window.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "security": [ { "bearerAuth": [] } ] }