openapi-to-graphql-lxwang2

{ "openapi": "3.0.0", "servers": [ { "url": "/government/socialwork" } ], "info": { "version": "2.6.0", "title": "Government Social Work apis", "description": "This version is a collection of the Government product app 'Case Advice' apis which enable a social case worker to work on specific case visits and perform\nUpdate in 2.6.0: 1. added a PATCH api for FILE 2. Re-worked assessment types/factors/questions apis\n - Added new data definitions for a) AssessmentTypeMaster b) AssessmentFactorsTemplate and c) AssessmentFactorQuestionsTemplate: these will serve up as the initial lookup tables\n - Amended the api: GET /assessment_types to get data from the AssessmentTypeFactor entity \n - Dropped the GET /assessment_type/{assessmentTypeId}/assessment_factors' api and GET '/assessment_type/{assessmentTypeId}/assessment_factor/{factorId}/assessment_factor_questions' apis \n - Amended the data definitions for AssessmentFactors and AssessmentFactorQuestions entities\nname: Murali Natarajan email: mnataraj@us.ibm.com\n" }, "security": [ { "mf_auth": ["default"] } ], "paths": { "/assessment_types": { "get": { "x-since-version": "1.0.0", "tags": ["Case Assessment"], "summary": "Get assessment types", "description": "Gets all `Assessment` types", "operationId": "getAssessmentTypes", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTypeMaster" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/case/{caseId}": { "get": { "x-since-version": "1.0.0", "tags": ["Case"], "summary": "Get case details", "description": "Gets case details for a given case id", "operationId": "getCase", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/path-case-id" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Case" } } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/social_worker/{userName}": { "get": { "x-since-version": "1.0.0", "tags": ["Social worker profile"], "summary": "Gets the given worker's profile", "description": "Gets profile date for the case worker", "operationId": "getWorkersProfile", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-worker-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SocialWorker" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/social_worker/{userName}/cases": { "get": { "x-since-version": "1.0.0", "tags": ["Social worker"], "summary": "Gets assigned cases for the given worker", "description": "Gets All `Case` objects for a social worker", "operationId": "getWorkersCases", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-worker-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Case" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/social_worker/{userName}/families": { "get": { "x-since-version": "1.0.0", "tags": ["Social worker"], "summary": "Gets assigned families for the given worker", "description": "Gets the assigned `Family` objects for a social worker", "operationId": "getWorkersFamilies", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-worker-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Family" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/case/{caseId}/case_visit": { "post": { "x-since-version": "1.0.0", "tags": ["CaseVisit"], "summary": "Add visit", "description": "Adds a new case visit to the given case", "operationId": "addVisit", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/path-case-id" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "$ref": "#/components/schemas/CaseVisit" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CaseVisit" } } } }, "description": "Visit data", "required": true } } }, "/case/{caseId}/case_visit/{visitId}": { "get": { "x-since-version": "1.0.0", "tags": ["CaseVisit"], "summary": "Gets a specific case visit's data for a specific case", "description": "Gets a specific case visit data for a given case id/case visit id combination", "operationId": "getCaseVisit", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-case-id" }, { "$ref": "#/components/parameters/path-visit-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CaseVisit" } } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/family/{familyId}": { "get": { "x-since-version": "1.0.0", "tags": ["Family"], "summary": "Gets client family data", "description": "Gets a specific family's data", "operationId": "getFamily", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-family-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Family" } } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/client/{clientId}": { "get": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Gets client data", "description": "Gets a specific client data", "operationId": "getClient", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-client-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/persons": { "get": { "x-since-version": "1.0.0", "tags": ["Person"], "summary": "Gets a list of persons", "description": "Gets all persons", "operationId": "getPersons", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/person": { "post": { "x-since-version": 2, "tags": ["Person"], "summary": "Add a new client particpant's person profile data", "description": "Add a new client record to store the person details of a client participant", "operationId": "addPerson", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "$ref": "#/components/schemas/Person" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Person" } } } }, "description": "Participant data", "required": true } } }, "/person/{personId}": { "patch": { "x-since-version": "1.0.0", "tags": ["Person"], "summary": "Update person data", "description": "Update person data", "operationId": "updatePerson", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/path-person-id" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "boolean", "description": "Success" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Person" } } } }, "description": "Person data", "required": true } } }, "/client": { "patch": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Updates client data", "description": "Updates a specific client data", "operationId": "updateClient", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "boolean", "description": "Update Success" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Client" } } } }, "description": "Client data", "required": true } } }, "/client_relationship/{clientId}": { "post": { "x-since-version": 2, "tags": ["ClientRelationship"], "summary": "Add a new client relationship", "description": "Add a new client relationship with relationshipId=clientId", "operationId": "addClientRelationship", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/path-client-id" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "$ref": "#/components/schemas/ClientRelationship" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ClientRelationship" } } } }, "description": "Relationship data", "required": true } } }, "/client_relationship": { "patch": { "x-since-version": "1.0.0", "tags": ["ClientRelationship"], "summary": "Mark a client relationship with status=\"Deleted\" or do other updates", "description": "Sets a specific client relationship as \"deleted\" or do other updates", "operationId": "deleteClientRelationship", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "boolean", "description": "Delete Success" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ClientRelationship" } } } }, "description": "Client Relationship data", "required": true } } }, "/client/{clientId}/client_contacts": { "get": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Gets client's contacts", "description": "Gets client's contacts - not marked as \"Deleted\" - with their email/phone information", "operationId": "getClientContacts", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-client-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClientContact" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/client_contact": { "post": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Add a new client contact", "description": "Add a new client contact with phone/email for a client id", "operationId": "addClientContact", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "$ref": "#/components/schemas/ClientContact" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ClientContact" } } } }, "description": "Physician data", "required": true } } }, "/client_contact/{contactId}": { "patch": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Update/delete client contact", "description": "Update/delete client contact for a client id", "operationId": "updateClientContact", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-contact-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "boolean", "description": "Client contact update successful" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ClientContact" } } } }, "description": "Contact data", "required": true } } }, "/client/{clientId}/client_schools": { "get": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Gets client's schools - not marked as \"Deleted\"", "description": "Gets client's schools information", "operationId": "getClientSchools", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-client-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClientSchool" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/client_school": { "post": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Add a new client school", "description": "Add a new client school detail for a client id", "operationId": "addClientSchool", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "$ref": "#/components/schemas/ClientSchool" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ClientSchool" } } } }, "description": "Physician data", "required": true } } }, "/client_school/{schoolId}": { "patch": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Update/delete client school", "description": "Update/delete client school", "operationId": "updateClientSchool", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-school-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "boolean", "description": "Client school update successful" } } } } } }, "default": { "description": "unexpected error(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ClientSchool" } } } }, "description": "Client school data", "required": true } } }, "/client/{clientId}/client_physicians": { "get": { "x-since-version": "1.0.0", "tags": ["Client"], "summary": "Gets client's physicians - not marked as \"Deleted\"", "description": "Gets client's physicians information - not marked as \"Deleted\"", "operationId": "getClientPhysicians", "security": [ { "mf_auth": ["default"] } ], "parameters": [ { "$ref": "#/components/parameters/path-client-id" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/Device-Model" }, { "$ref": "#/components/parameters/Api-Version" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" } ], "responses": { "200": { "description": "no technical errors", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "description": "may return NO_RESULTS_FOUND for this user and search query", "items": { "$ref": "#/components/schemas/Error" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClientPhysician" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "default": {