openapi: 3.0.3 info: title: Laravel-Restful-API description: '' version: 1.0.0 servers: - url: 'https://api.getdentalray.com' paths: /api/auth/mfa/settings: get: summary: 'Get MFA Settings' operationId: getMFASettings description: 'This endpoint lets you get mfa settings' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Auth Multi-Factor Management' security: [] /api/auth/mfa/sms: get: summary: 'Send OTP' operationId: sendOTP description: 'This API will send OTP to the User currently in Session' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Auth Multi-Factor Management' /api/auth/mfa/verify: post: summary: 'Verify OTP' operationId: verifyOTP description: 'This endpoint lets you verify the OTP from Twilio' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Auth Multi-Factor Management' requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: '' example: dolor required: - code /api/category: get: summary: 'Get all Categories' operationId: getAllCategories description: 'This endpoint lets you get all the Categories' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Category Management' post: summary: 'Store a Category' operationId: storeACategory description: 'This endpoint lets you store a new Category' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Category Management' '/api/category/{slug}': get: summary: 'Show a Category' operationId: showACategory description: 'This endpoint lets you get a Category' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Category Management' put: summary: 'Update a Category' operationId: updateACategory description: 'This endpoint lets you update a single Category' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Category Management' delete: summary: 'Delete a Category' operationId: deleteACategory description: 'This endpoint lets you delete a single Category' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Category Management' parameters: - in: path name: slug description: 'The slug of the category.' example: magnam-error-saepe-temporibus-id-fugiat required: true schema: type: string /api/dicom: post: summary: 'Store Dicom' operationId: storeDicom description: 'Create worklists, media, and patient according to the parameters.' parameters: - in: header name: Authorization description: '' example: 'bearer: {token}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Dicom Management' requestBody: required: true content: application/json: schema: type: object properties: path: type: string description: '' example: null link: type: string description: '' example: null studyInstanceUID: type: string description: '' example: occaecati sopInstanceUID: type: string description: '' example: atque studyDate: type: string description: 'Must be a valid date.' example: '2023-03-27T09:56:54' manufacturer: type: string description: '' example: suscipit manufacturerModelName: type: string description: '' example: saepe manufacturerModelVersion: type: string description: '' example: adipisci patientId: type: string description: '' example: minima patientName: type: string description: '' example: architecto patientBirthDate: type: string description: 'Must be a valid date.' example: '2023-03-27T09:56:54' patientSex: type: string description: '' example: nihil acquisitionDateTime: type: string description: 'Must be a valid date.' example: '2023-03-27T09:56:54' modality: type: string description: '' example: non institutionName: type: string description: '' example: cumque institutionAddress: type: string description: '' example: adipisci referringPhysicianName: type: string description: '' example: maxime required: - studyInstanceUID - sopInstanceUID - manufacturer - patientId - patientName - modality '/api/dicom/{worklist_id}': put: summary: 'Update Dicom' operationId: updateDicom description: 'Update worklist, media and patient according to the paramters where id matches worklist.' parameters: - in: header name: Authorization description: '' example: 'bearer: {token}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Dicom Management' requestBody: required: false content: application/json: schema: type: object properties: path: type: string description: '' example: null link: type: string description: '' example: null studyDate: type: string description: 'Must be a valid date.' example: '2023-03-27T09:56:54' patientId: type: string description: '' example: maxime patientName: type: string description: '' example: sed patientBirthDate: type: string description: 'Must be a valid date.' example: '2023-03-27T09:56:54' patientSex: type: string description: '' example: molestiae status: type: string description: '' example: corrupti scan_status: type: string description: '' example: assumenda parameters: - in: path name: worklist_id description: 'The ID of the worklist.' example: 74 required: true schema: type: integer /api/broadcasting/auth: get: summary: 'Authenticate the request for channel access.' operationId: authenticateTheRequestForChannelAccess description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints security: [] /api/heartbeat: post: summary: 'Store User Heartbeat' operationId: storeUserHeartbeat description: 'This endpoint lets you store the last sync details from the user' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: version: type: string description: '' example: accusamus required: - version /api/form: get: summary: 'All Forms' operationId: allForms description: 'Display a listing of the resource.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Form Management' security: [] post: summary: 'Store Form' operationId: storeForm description: 'Store a newly created resource in storage.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Form Management' security: [] '/api/form/{id}': get: summary: 'Show Form' operationId: showForm description: 'Display the specified resource matching the given id.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Form Management' security: [] parameters: - in: path name: id description: 'The ID of the form.' example: 1 required: true schema: type: integer /api/media: get: summary: 'Get all Media' operationId: getAllMedia description: 'This endpoint lets you get all the Media' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Media Management' post: summary: 'Store a Media' operationId: storeAMedia description: 'This endpoint lets you store a new Media' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: multipart/form-data schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Media Management' requestBody: required: false content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: 'Must be a file.' s3_object: type: string description: '' example: voluptatum s3_objects: type: object description: 'Must have at least 1 items.' example: null properties: [] status: type: string description: '' example: assumenda description: type: string description: '' example: 'Quia quis ab incidunt aut accusantium officia nisi.' meta: type: object description: '' example: null properties: is_dicom: type: boolean description: '' example: true patient_id: type: string description: '' example: null patient_name: type: string description: '' example: null patient_dob: type: string description: '' example: null patient_gender: type: string description: '' example: null '/api/media/{media_id}': get: summary: 'Show a Media' operationId: showAMedia description: 'This endpoint lets you get a Media' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Media Management' put: summary: 'Update a Media' operationId: updateAMedia description: 'This endpoint lets you update a Media File matching the provided ID.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Media Management' delete: summary: 'Delete a Media' operationId: deleteAMedia description: 'This endpoint lets you delete a single Role' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Media Management' parameters: - in: path name: media_id description: 'The ID of the media.' example: 401 required: true schema: type: integer '/api/media/{media_id}/download': get: summary: 'Download Media' operationId: downloadMedia description: 'This endpoint lets you download a single Media file that matches the ID Request Query.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Media Management' parameters: - in: path name: media_id description: 'The ID of the media.' example: 401 required: true schema: type: integer /api/office: get: summary: 'Get all Offices' operationId: getAllOffices description: 'This endpoint lets you get all Offices' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Office Management' post: summary: 'Store Office' operationId: storeOffice description: 'This endpoint lets you add a new Office' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Office Management' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: necessitatibus address_line_1: type: string description: '' example: ea city: type: string description: '' example: sed state: type: string description: '' example: voluptatem zipcode: type: string description: '' example: aut primary_contact_name: type: string description: '' example: repudiandae primary_contact_email: type: string description: 'Must be a valid email address.' example: chyna.botsford@example.org practice_management_software: type: string description: '' example: maxime cbct_make_and_model: type: string description: '' example: quae image_viewing_software: type: string description: '' example: recusandae required: - name - address_line_1 - city - state - zipcode - primary_contact_name - primary_contact_email /api/office/form-office: get: summary: '' operationId: getApiOfficeFormOffice description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Office Management' security: [] /api/office/form-dentists: get: summary: '' operationId: getApiOfficeFormDentists description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Office Management' security: [] '/api/office/{id}': get: summary: 'Show Office' operationId: showOffice description: 'This endpoit lets you get a single Office that matched with the id.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Office Management' put: summary: 'Update Office' operationId: updateOffice description: 'This endpoint lets you get a single Office that matches with the id.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Office Management' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: similique address_line_1: type: string description: '' example: itaque address_line_2: type: string description: '' example: rerum city: type: string description: '' example: cum state: type: string description: '' example: ipsum zipcode: type: string description: '' example: dolorem primary_contact_name: type: string description: '' example: consequatur primary_contact_email: type: string description: 'Must be a valid email address.' example: weissnat.maritza@example.net practice_management_software: type: string description: '' example: architecto cbct_make_and_model: type: string description: '' example: a image_viewing_software: type: string description: '' example: deserunt required: - name - address_line_1 - city - state - zipcode - primary_contact_name - primary_contact_email delete: summary: 'Destroy Office' operationId: destroyOffice description: 'This endpoint lets you destroy a single Office resource that matches with the id' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Office Management' parameters: - in: path name: id description: 'The ID of the office.' example: 14 required: true schema: type: integer /api/option: get: summary: 'Get All Options' operationId: getAllOptions description: 'This endpoint lets you get all autoloaded options' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Options Management' post: summary: 'Store Option' operationId: storeOption description: 'This endpoint lets you add a new option' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Options Management' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: et value: type: string description: '' example: sit required: - name - value '/api/option/{name}': get: summary: 'Show Option' operationId: showOption description: 'This endpoint lets you get a single option that matches the name.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Options Management' put: summary: 'Update Option' operationId: updateOption description: 'This endpoint lets you update a single option that matches the neme.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Options Management' requestBody: required: true content: application/json: schema: type: object properties: value: type: string description: '' example: aut required: - value delete: summary: 'Destroy Option' operationId: destroyOption description: 'This endpoint lets you delete a single option that matches the name.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Options Management' parameters: - in: path name: name description: '' example: non required: true schema: type: string /api/organization: get: summary: 'Get all Organizations' operationId: getAllOrganizations description: 'This endpoint lets you get all Organizations' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Organization Management' post: summary: 'Store Organization' operationId: storeOrganization description: 'This endpoint lets you add a new Organization' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Organization Management' requestBody: required: true content: application/json: schema: type: object properties: organization_administrator_id: type: number description: '' example: 809074388.83513 slug: type: string description: '' example: itaque name: type: string description: '' example: facilis description: type: string description: '' example: 'Vero ab nisi cum aut nemo molestias rem.' required: - organization_administrator_id - slug - name '/api/organization/{office}': get: summary: 'Show Organization' operationId: showOrganization description: 'This endpoit lets you get a single Organization that matched with the id.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Organization Management' put: summary: 'Update Organization' operationId: updateOrganization description: 'This endpoint lets you get a single Organization that matches with the id.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Organization Management' requestBody: required: true content: application/json: schema: type: object properties: organization_administrator_id: type: number description: '' example: 21.695096 slug: type: string description: '' example: neque name: type: string description: '' example: aliquam description: type: string description: '' example: 'Et dolores qui ut et assumenda quidem.' required: - organization_administrator_id - slug - name delete: summary: 'Destroy Organization' operationId: destroyOrganization description: 'This endpoint lets you destroy a single Organization resource that matches with the id' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Organization Management' parameters: - in: path name: office description: '' example: 4 required: true schema: type: integer /api/patient: get: summary: 'All Patients' operationId: allPatients description: 'Display a listing of the resource.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Patient Management' security: [] post: summary: 'Store Patient' operationId: storePatient description: 'Store a newly created resource in storage.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Patient Management' security: [] /api/patient/form-patient-list: get: summary: 'Display Patient' operationId: displayPatient description: 'Display only patients not existing on reports table' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Patient Management' security: [] /api/patient/patient-list: get: summary: 'Get Patient List' operationId: getPatientList description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Patient Management' security: [] /api/patient/patient-live: get: summary: 'Live Search' operationId: liveSearch description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Patient Management' security: [] '/api/patient/{id}': get: summary: 'Show Patient' operationId: showPatient description: 'Display the specified resource matching the given resource id.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Patient Management' security: [] put: summary: "Update Patient\nUpdate the specified resource in storage." operationId: updatePatientUpdateTheSpecifiedResourceInStorage description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Patient Management' security: [] delete: summary: 'Delete Patient' operationId: deletePatient description: 'Remove the specified resource from storage.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Patient Management' security: [] parameters: - in: path name: id description: 'The ID of the patient.' example: 1 required: true schema: type: integer /api/permission: get: summary: 'Get all Permissions' operationId: getAllPermissions description: 'This endpoint returns all the permissions available in the system.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Permission Management' /api/oauth/personal-access-token: get: summary: 'User Tokens' operationId: userTokens description: 'Get all of the personal access tokens for the authenticated user.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Personal Access Token Management' security: [] post: summary: 'Create Token' operationId: createToken description: 'Create a new personal access token for the user.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Personal Access Token Management' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 191 characters.' example: bprsxulvntiznxpj scopes: type: object description: 'Must be one of user.index, user.store, user.show, user.update, user.destroy, role.index, role.show, role.store, role.update, role.destroy, user.role.show, user.role.store, user.role.update, user.role.destroy, user.permission.store, user.permission.show, user.permission.destroy, user.meta.index, user.meta.store, user.meta.show, user.meta.update, user.meta.destroy, user.heartbeat.store, category.index, category.store, category.show, category.update, category.destroy, option.index, option.store, option.show, option.update, option.destroy, media.index, media.store, media.show, media.update, media.destroy, media.download, report.index, report.store, report.show, report.update, report.destroy, report.preview, office.index, office.store, office.show, office.update, office.destroy, worklist.index, worklist.store, worklist.show, worklist.update, worklist.destroy, organization.index, organization.store, organization.show, organization.update, organization.destroy, radiologist.index, radiologist.store, radiologist.show, radiologist.update, radiologist.destroy, dicom.index, dicom.store, dicom.show, dicom.update, or dicom.destroy.' example: null properties: [] required: - name security: [] '/api/oauth/personal-access-token/{token_id}': delete: summary: 'Delete Token' operationId: deleteToken description: 'Delete the given token.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Personal Access Token Management' security: [] parameters: - in: path name: token_id description: 'The ID of the token.' example: sunt required: true schema: type: string /api/radiologist: get: summary: 'All Radiologist' operationId: allRadiologist description: 'This endpoint lets you get all Radiologist Resources.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Radiologist Management' /api/report: get: summary: "All Report\n\nThis endpoint lets you get all reports" operationId: allReportThisEndpointLetsYouGetAllReports description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Report Management' post: summary: 'Store Report' operationId: storeReport description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Report Management' requestBody: required: true content: application/json: schema: type: object properties: form_id: type: number description: '' example: 662.486845 office_id: type: number description: '' example: 50.0 worklist_id: type: number description: '' example: 21.2531359 patient_first_name: type: string description: 'Must not be greater than 255 characters.' example: smvedklwtsvej patient_last_name: type: string description: 'Must not be greater than 255 characters.' example: tdhnyttfaz patient_dob: type: string description: '' example: ex body: type: string description: '' example: omnis exam: type: string description: '' example: laborum indication: type: string description: '' example: voluptatem technique: type: string description: '' example: quo comparison: type: string description: '' example: quis osseous_structures: type: string description: '' example: qui paranasal_sinuses: type: string description: '' example: sint salivary_glands: type: string description: '' example: veritatis oral_cavity_pharynx: type: string description: '' example: animi other_areas: type: string description: '' example: dolores additional_notes: type: string description: '' example: exercitationem impression: type: string description: '' example: corrupti required: - form_id - office_id /api/report/preview: post: summary: 'Preview Report' operationId: previewReport description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Report Management' '/api/report/{id}': get: summary: 'Show Report' operationId: showReport description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Report Management' put: summary: 'Update Report' operationId: updateReport description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Report Management' delete: summary: 'Destroy Report' operationId: destroyReport description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Report Management' parameters: - in: path name: id description: 'The ID of the report.' example: 42 required: true schema: type: integer /api/role: get: summary: 'Get all Roles' operationId: getAllRoles description: 'This endpoint lets you get all the Roles' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Role Management' post: summary: 'Store a Role' operationId: storeARole description: 'This endpoint lets you store a new Role' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Role Management' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: in slug: type: string description: '' example: ut permissions: type: object description: '' example: [] properties: [] required: - name - slug - permissions '/api/role/{slug}': get: summary: 'Show a Role' operationId: showARole description: 'This endpoint lets you get a Role' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Role Management' put: summary: 'Update a Role' operationId: updateARole description: 'This endpoint lets you update a single Role' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Role Management' delete: summary: 'Delete a Role' operationId: deleteARole description: 'This endpoint lets you delete a single Role' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Role Management' parameters: - in: path name: slug description: 'The slug of the role.' example: administrator required: true schema: type: string /api/auth/login: post: summary: 'Login API' operationId: loginAPI description: 'This endpoint allows you to login users.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: username: type: string description: 'Must be at least 5 characters. Must not be greater than 255 characters.' example: sbul password: type: string description: 'Must be at least 5 characters. Must not be greater than 255 characters.' example: '}cVG=LiVy54j4;exa' timezone: type: string description: '' example: America/Chihuahua required: - username - password security: [] /api/auth/register: post: summary: 'Register API' operationId: registerAPI description: 'This endpoint allows you to register a new user.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: username: type: string description: 'Must be at least 5 characters. Must not be greater than 255 characters.' example: z email: type: string description: 'Must be a valid email address. Must be at least 10 characters. Must not be greater than 255 characters.' example: nienow.vincenzo@example.net password: type: string description: 'Must be at least 8 characters. Must not be greater than 255 characters.' example: 'r?7-V&e]MCc[BrC' first_name: type: string description: 'Must be at least 3 characters. Must not be greater than 255 characters.' example: csv middle_name: type: string description: '' example: excepturi last_name: type: string description: 'Must be at least 3 characters. Must not be greater than 255 characters.' example: yputfxfavr role: type: string description: '' example: sapiente permissions: type: object description: '' example: null properties: [] activate: type: boolean description: '' example: true phone_number: type: number description: '' example: 85.7 office_name: type: string description: 'This field is required when role is dentist. Must be at least 5 characters. Must not be greater than 255 characters.' example: oc office_address_line_1: type: string description: 'This field is required when role is dentist. Must be at least 5 characters. Must not be greater than 255 characters.' example: adtlsstgcrlvgjferhmo office_address_line_2: type: string description: 'This field is required when role is dentist. Must be at least 5 characters. Must not be greater than 255 characters.' example: avcz office_city: type: string description: 'This field is required when role is dentist. Must be at least 2 characters. Must not be greater than 255 characters.' example: bxxigrlpjylt office_state: type: string description: 'This field is required when role is dentist. Must be at least 2 characters. Must not be greater than 255 characters.' example: xrtccdlcgwhm office_zipcode: type: string description: 'This field is required when role is dentist. Must be at least 5 characters. Must not be greater than 255 characters.' example: btanhzltdtwarryhday birth_date: type: string description: 'This field is required when role is radiologist.' example: null school_diploma_id: type: integer description: 'This field is required when role is radiologist.' example: 4 residency_diploma_id: type: integer description: 'This field is required when role is radiologist.' example: 1 state_license_id: type: integer description: 'This field is required when role is radiologist.' example: 10 abr_file_id: type: integer description: 'This field is required when role is radiologist.' example: 6 medical_school_diploma_id: type: integer description: 'This field is required when role is radiologist.' example: 11 required: - username - email - password - first_name - last_name security: [] /api/auth/activate: post: summary: 'Activate a User' operationId: activateAUser description: 'This endpoint lets you activate a User.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: 'The activation code.' example: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx required: - code /api/auth/password/forgot: post: summary: 'Forgot Password' operationId: forgotPassword description: 'This endpoint will send an authorized email reset password' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'Must be a valid email address.' example: halvorson.thalia@example.net required: - email security: [] /api/auth/password/reset: put: summary: 'Reset Password' operationId: resetPassword description: 'This endpoint lets you reset and update password' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: '' example: 'n"C$(ll+.:~=0kaiJ;' confirm_password: type: string description: '' example: libero token: type: string description: '' example: assumenda required: - password - confirm_password - token security: [] /api/auth/me: get: summary: 'Me API' operationId: meAPI description: 'This endpoint will return the currently logged-in user.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Management' /api/auth/logout: post: summary: 'Logout API' operationId: logoutAPI description: 'This endpoint allows you to logout user.' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' security: [] /api/user: get: summary: 'Get all Users' operationId: getAllUsers description: 'This endpoint lets you get all Users.' parameters: - in: query name: search description: 'string used to search from email, username, first_name, and last_name' example: illum required: false schema: type: string description: 'string used to search from email, username, first_name, and last_name' example: illum - in: query name: role description: 'used to filter results based on a specific role.' example: molestiae required: false schema: type: string description: 'used to filter results based on a specific role.' example: molestiae - in: query name: includes description: 'an array of available data to include.' example: - quibusdam required: false schema: type: array description: 'an array of available data to include.' example: - quibusdam items: type: string - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Management' requestBody: required: false content: application/json: schema: type: object properties: includes: type: object description: '' example: null properties: [] post: summary: 'Store User' operationId: storeUser description: 'This endpoint lets you create a new User.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: username: type: string description: 'Must be at least 2 characters. Must not be greater than 255 characters.' example: lysgoeulraesciarjymovmu email: type: string description: 'Must be a valid email address.' example: miguel47@example.com password: type: string description: '' example: 'R/ub*E4l&Wa' first_name: type: string description: '' example: veritatis last_name: type: string description: '' example: eos role: type: string description: '' example: quia permissions: type: object description: '' example: null properties: [] activate: type: boolean description: '' example: false phone_number: type: number description: '' example: 3293.6102143 country_code: type: number description: '' example: 6.1 office: type: object description: '' example: null properties: [] required: - username - email - password - first_name - last_name /api/user/mfa: put: summary: '' operationId: putApiUserMfa description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: default_factor: type: string description: 'Must be one of sms, authenticator, call, or push.' example: sms required: - default_factor security: [] /api/user/change: post: summary: 'Change Password' operationId: changePassword description: 'This endpoint lets users change their own passwords' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: password_current: type: string description: '' example: animi password: type: string description: 'This field is required when password_confirmation is present. The value and password_confirmation must match. Must be at least 6 characters. Must not be greater than 15 characters.' example: '9.mfrvw&{' password_confirmation: type: string description: 'Must be at least 6 characters. Must not be greater than 15 characters.' example: cknwahyldeh required: - password_current - password_confirmation '/api/user/{user_id}/offices': get: summary: '' operationId: getApiUserUser_idOffices description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Management' security: [] post: summary: '' operationId: postApiUserUser_idOffices description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' security: [] parameters: - in: path name: user_id description: 'The ID of the user.' example: 1 required: true schema: type: integer '/api/user/{id}': get: summary: 'Get a User' operationId: getAUser description: 'This endpoint lets you get a User.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Management' put: summary: 'Update a User' operationId: updateAUser description: "This endpoint lets you update a User's data." parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' requestBody: required: true content: application/json: schema: type: object properties: username: type: string description: 'Must be at least 5 characters. Must not be greater than 255 characters.' example: vkdtuylfs email: type: string description: 'Must be a valid email address. Must not be greater than 255 characters.' example: francis51@example.org first_name: type: string description: 'Must be at least 2 characters. Must not be greater than 100 characters.' example: ddlisshbwnlphjsntxowv last_name: type: string description: 'Must be at least 2 characters. Must not be greater than 100 characters.' example: qqjfudqdzlrbmjrq phone_number: type: string description: '' example: null role: type: string description: '' example: null required: - username - email delete: summary: 'Destroy a User' operationId: destroyAUser description: 'This endpoint lets you update a User.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' parameters: - in: path name: id description: 'The ID of the user.' example: 1 required: true schema: type: integer '/api/user/{user_id}/mfa': post: summary: '' operationId: postApiUserUser_idMfa description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' security: [] delete: summary: '' operationId: deleteApiUserUser_idMfa description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Management' security: [] parameters: - in: path name: user_id description: 'The ID of the user.' example: 1 required: true schema: type: integer '/api/user/{user_id}/qr': get: summary: '' operationId: getApiUserUser_idQr description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Management' security: [] parameters: - in: path name: user_id description: 'The ID of the user.' example: 1 required: true schema: type: integer '/api/user/{user_id}/meta': get: summary: 'Get all User Meta Data' operationId: getAllUserMetaData description: 'This endpoint lets you get all User Meta' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Meta Management' post: summary: 'Store User Meta' operationId: storeUserMeta description: 'This endpoint lets you store User Meta' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Meta Management' requestBody: required: true content: application/json: schema: type: object properties: user_id: type: string description: '' example: corporis meta_value: type: object description: 'Must have at least 1 items. Must not have more than 10 items.' example: null properties: [] autoload: type: boolean description: '' example: false required: - user_id parameters: - in: path name: user_id description: 'The ID of the user.' example: 1 required: true schema: type: integer '/api/user/{user_id}/meta/{key}': get: summary: 'Show User Meta' operationId: showUserMeta description: 'This endpoint will return a single User Meta' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Meta Management' put: summary: 'Update User Meta' operationId: updateUserMeta description: 'This endpoint will update a single User Meta' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Meta Management' requestBody: required: false content: application/json: schema: type: object properties: meta_value: type: object description: 'Must have at least 1 items. Must not have more than 10 items.' example: null properties: [] autoload: type: boolean description: '' example: false delete: summary: 'Destroy User Meta' operationId: destroyUserMeta description: 'This endpoint will destroy a single User Meta' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Meta Management' parameters: - in: path name: user_id description: 'The ID of the user.' example: 1 required: true schema: type: integer - in: path name: key description: '' example: nulla required: true schema: type: string '/api/user/{user_id}/permission': get: summary: 'Get User Permission' operationId: getUserPermission description: "This endpoint lets you get a User's Permissions" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Permission Management' put: summary: 'Update User Permission' operationId: updateUserPermission description: 'This endpoint lets you update a Permission from a User' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Permission Management' post: summary: 'Store User Permission' operationId: storeUserPermission description: 'This endpoint lets you add a Permission to a User' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Permission Management' delete: summary: 'Destroy User Permission' operationId: destroyUserPermission description: 'This endpoint lets you delete a Permission from a User' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Permission Management' parameters: - in: path name: user_id description: 'The ID of the user.' example: 1 required: true schema: type: integer '/api/user/{user_id}/role': get: summary: 'Get User Roles' operationId: getUserRoles description: "This endpoint lets you get a User's Roles" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Role Management' post: summary: 'Add Role to User' operationId: addRoleToUser description: 'This endpoint lets you add a Role to a User.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Role Management' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string description: 'Must be at least 2 characters. Must not be greater than 100 characters.' example: gdyuptatkqjjeymmaa put: summary: 'Update Role to User' operationId: updateRoleToUser description: 'The endpoint lets you update a Role to a User' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Role Management' requestBody: required: true content: application/json: schema: type: object properties: slug: type: string description: 'Must be at least 2 characters. Must not be greater than 20 characters.' example: kuzdmsilsitrlpwfn required: - slug delete: summary: "Delete a User's Role" operationId: deleteAUsersRole description: "This endpoint lets you delete a User's Role" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'User Role Management' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string description: 'Must be at least 2 characters. Must not be greater than 100 characters.' example: bbb parameters: - in: path name: user_id description: 'The ID of the user.' example: 1 required: true schema: type: integer /api/worklist: get: summary: 'Get all Worklists' operationId: getAllWorklists description: 'Display a listing of the resource.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Worklist Controller' post: summary: 'Store Worklist' operationId: storeWorklist description: 'Store a newly created resource in storage.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Worklist Controller' requestBody: required: true content: application/json: schema: type: object properties: office_id: type: number description: '' example: 5255.7 dentist_id: type: number description: '' example: 160.0 radiologist_id: type: number description: '' example: 1.0 media_id: type: number description: '' example: 27578.2664 patient_id: type: number description: '' example: 605181848.0 study_type: type: string description: 'Must be one of safety_overread or comprehensive_read.' example: comprehensive_read study_instance_uid: type: string description: '' example: perferendis link: type: string description: '' example: dignissimos status: type: string description: '' example: sapiente required: - office_id - patient_id - study_type - status /api/worklist/search-suggestions: get: summary: '' operationId: getApiWorklistSearchSuggestions description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Worklist Controller' security: [] '/api/worklist/{id}': get: summary: 'Show Worklist' operationId: showWorklist description: 'Display the specified resource.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Worklist Controller' put: summary: 'Update Worklist' operationId: updateWorklist description: 'Update the specified resource in storage.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Worklist Controller' requestBody: required: true content: application/json: schema: type: object properties: office_id: type: number description: '' example: 3.0 radiologist_id: type: number description: '' example: 457.7707 dentist_id: type: number description: '' example: 3803208.028 patient_id: type: number description: '' example: 45444060.1 study_type: type: string description: 'Must be one of safety_overread or comprehensive_read.' example: comprehensive_read link: type: string description: '' example: commodi status: type: string description: 'Must be one of pending or complete.' example: pending required: - office_id - patient_id - study_type delete: summary: 'Destroy Worklist' operationId: destroyWorklist description: 'Remove the specified resource from storage.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Worklist Controller' parameters: - in: path name: id description: 'The ID of the worklist.' example: 74 required: true schema: type: integer tags: - name: 'Auth Multi-Factor Management' description: "\nAPIs for doing two factor authentication with Twilio" - name: 'Category Management' description: "\nAPIs for managing Categories" - name: 'Dicom Management' description: "\nAPI for managing dicom (worklists, media, patient) information." - name: Endpoints description: '' - name: 'Form Management' description: '' - name: 'Media Management' description: "\nAPIs for managing Media" - name: 'Office Management' description: "\nAPIs for managing Offices" - name: 'Options Management' description: "\nAPIs for managing Options" - name: 'Organization Management' description: "\nAPIs for managing Organizations" - name: 'Patient Management' description: '' - name: 'Permission Management' description: '' - name: 'Personal Access Token Management' description: '' - name: 'Radiologist Management' description: "\nAPIs for managing Radiologist Resources" - name: 'Report Management' description: 'This endpoint lets you store a new report' - name: 'Role Management' description: "\nAPIs for managing Roles" - name: 'User Management' description: "\nAPIs for managnign Users" - name: 'User Meta Management' description: "\nAPIs for User Meta Management" - name: 'User Permission Management' description: "\nAPIs for managing a User's Permissions" - name: 'User Role Management' description: "\nAPIs for managing a User's Role" - name: 'Worklist Controller' description: "\nAPIs for managing Worklists" components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []