**Updated 2026-06-11 10:05:00 (**UTC/GMT -3)
\nWelcome to the 224Scan documentation. You can generate integration codes automatically using the right sidebar menu in Postman.
\nPrivacy policy
Cookie policy
Regional complian
Terms of use
Regional laws governing the location of information can be managed by selecting the regions when handling data.
\nFor new locations, please contact our sales team.
\nThe 224Scan platform features a scalable and secure technological infrastructure. All requests have end-to-end security with a Let’s Encrypt Authority X3 2048-bit security certificate. Vulnerability scanners are occasionally used to detect potential security flaws.
\nThe infrastructure is also certified by SSAE16 / ISAE 3402 Type II, ISO 27001, ISO 27017, ISO 27018, FedRAMP ATO, PCI DSS v3.2, and HIPAA.
\nThe tokens used follow OAUTH2 authentication standards. The use of a Refresh Token replaces the need to share usernames and passwords with applications. The Access Token, used in requests to the platform, is valid for 15 minutes.
\nThe 224Scan development platform authentication uses two tokens: the Refresh Token and the Access Token. The Refresh Token is used solely to obtain new Access Tokens. This token has no expiration and must be stored with maximum security. The Access Token, on the other hand, is used in all request headers. This token is valid for 15 minutes and acts similarly to a user session.
\nThe 224Scan platform also supports two-factor authentication (2FA) to enhance account security. When enabled, users are required to provide a secondary authentication code generated through a QR code-compatible app, in addition to their standard login credentials.
\n\n\nDefault URL: https://api.224scan.com/
\n
Upload URL: https://upload.224scan.com/
We use the ISO 8601 format for dates.
\n\n\nDates follow the format: YYYY-MM-DDTHH:MM:SS.ssssss±HH:MM
\n
Always use UTC-0. Always.
Time zone control should be managed within the application. Some directories in this documentation include requests that list all available time zones in the application.
\nUp to 100 requests per minute are allowed. If the limit is reached, a 5-minute lockout period will be applied. This limit does not apply to upload endpoints.
\nThe response header of requests may contain statuses other than 200. See the list of statuses below:
\nWe use some variables in Postman to enhance the integration experience with the 224Scan platform.
\nThis API and its associated documentation are the intellectual property of 224SCAN LAUDOS EM EXAMES MEDICOS LTDA. All rights reserved.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"224Scan API v1","slug":"224scan-api-v1"}],"owner":"55918310","collectionId":"465e025f-0e95-43a2-bc4f-a473139eb42d","publishedId":"2sBXwtoUN6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-06-15T10:57:03.000Z"},"item":[{"name":"AUTHENTICATION","item":[{"name":"TOKEN LIST","id":"85618f2d-99b3-48ab-abbb-9198ce61927f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/token/list","description":"The /token/list route allows listing all valid OAuth (Open-Authorization) tokens.
The /auth/2fa/qrcode route allows obtaining a new two-factor authentication QR code (Quick Response Codes).
The image has dimensions of 555x555 pixels.
\n| HTTP code | \nContent-type | \nBody | \n
|---|---|---|
| 200 | \nimage/png | \n|
| 401 | \napplication/json | \n{ \"error\": [ { \"message\": \"Invalid token!\", \"status_code\": 401 } ] } | \n
| 429 | \napplication/json | \n{ \"error\": [{ \"message\": \"Too many requests!\", \"status_code\": 429 }] } | \n
The /oauth/authorize route allows obtaining a new refresh token through OAuth (Open-Authorization) authentication. A web page is rendered in the user's web browser.
Integrations with mobile and desktop applications can use custom protocols (Example: client224scan://...). Web applications will use HTTPS (Hyper Text Transfer Protocol Secure).
\n| HTTP code | \nContent-type | \nBody | \n
|---|---|---|
| 200 | \ntext/html | \n|
| 401 | \napplication/json | \n{ \"error\": \"Invalid token!\" } | \n
| 429 | \napplication/json | \n{ \"error\": [{ \"message\": \"Too many requests!\", \"status_code\": 429 }] } | \n
Authorize token.
\n","type":"text/plain"},"key":"authorization","value":"bearer {{token_authorize}}"},{"description":{"content":"Redirect URL (Uniform Resource Locator). HTTPS (Hyper Text Transfer Protocol Secure) and other protocols can be used.
\n","type":"text/plain"},"key":"redirect_uri","value":"{{redirect_uri}}"},{"description":{"content":"Grant information. Example: {\"name\":\"224Scan+Client\",\"redirectUri\":\"client224scan://\"}
\n","type":"text/plain"},"key":"grant","value":"{{grant}}"},{"description":{"content":"Redirect.
\n","type":"text/plain"},"key":"redirect","value":"true"}],"variable":[]}},"response":[],"_postman_id":"dd55257a-0d6d-4308-869e-19cfefaf5d00"},{"name":"OAUTH TOKEN","id":"65cf5e7d-8b21-4a67-a34a-1734e8bf7ee7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"refresh_token","value":"{{refresh_token}}","type":"text"}]},"url":"https://api.224scan.com/oauth/token","description":"The /oauth/token route allows obtaining a new access token through OAuth (Open-Authorization) authentication.
Access tokens expire in 15 minutes.
\nThe /oauth/revoke route allows immediately revoking the user's OAuth (Open-Authorization) authentication.
The /password/recovery route allows sending an email to the user with their password recovery code. The password recovery code expires in 15 minutes.
The password recovery code will be used in the /password/reset route along with a new password.
The /password/reset route allows replacing the user's password using the recovery code obtained from the /password/recovery route.
The password recovery code expires in 15 minutes.
\nThe /auth/2fa route allows immediately revoking the user's two-factor authentication. Authentication will revert to username and password mode.
We describe in this directory how to authenticate and manage authentication tokens.
\n","_postman_id":"1ff4070b-2dc5-4ddf-b278-51c5ee6cc4bf"},{"name":"BRANCH","item":[{"name":"LIST","id":"9802bf83-6fe1-4b71-a845-93b4f9e68eea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/branch/list","description":"The /branch/list route allows listing all branches.
Filters branches by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters branches by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters branches by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters branches by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters branches by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of branches to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"9802bf83-6fe1-4b71-a845-93b4f9e68eea"},{"name":"OPEN","id":"761780cc-d268-4b4c-8135-faed71517607","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/branch/{{branch}}","description":"The /branch/{{branch}} route allows retrieving a specific branch.
The /branch/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /branch/timezone route allows listing all time zones available in 224Scan. This route does not require authentication.
The /branch route allows inserting a branch.
The required properties are description, region, timezone, and active.
\nThe /branch/{{branch}} route allows updating a branch.
The /branch/{{branch}} route allows permanently deleting a branch.
We describe in this directory how to list and manage branches.
\nA branch is understood as any department within a large institution, units of a network of clinics or hospitals, or service units of a municipality or government.
Regional laws governing the location of information can be managed by selecting the regions when handling a branch.
The /equipment/list route allows listing all equipments.
Filters equipments by equipment description and branch description.
\n","type":"text/plain"},"key":"searchText","value":""},{"disabled":true,"description":{"content":"Filters equipments by their branch.
\n","type":"text/plain"},"key":"branch[]","value":""},{"disabled":true,"description":{"content":"Filters equipment by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters equipment by their type.
\n","type":"text/plain"},"key":"type[]","value":""},{"disabled":true,"description":{"content":"Filters equipment by their model.
\n","type":"text/plain"},"key":"model[]","value":""},{"disabled":true,"description":{"content":"Filters equipment by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters equipment by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters equipment by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters equipment by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of equipment to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"9d5e9c2c-688d-4f61-96e3-0d7b6c45018f"},{"name":"OPEN","id":"537ca353-c3f7-4e57-bda9-9f2cf10ba249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/equipment/{{equipment}}","description":"The /equipment/{{equipment}} route allows retrieving a specific equipment.
The /equipment/statistics route allows listing equipment statistics, including the number of exams.
Filters equipments by server description and branch description.
\n","type":"text/plain"},"key":"searchText","value":""},{"disabled":true,"description":{"content":"Filters equipments by their branch.
\n","type":"text/plain"},"key":"branch[]","value":""},{"disabled":true,"description":{"content":"Filters equipments by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters equipments by their type.
\n","type":"text/plain"},"key":"type[]","value":""},{"disabled":true,"description":{"content":"Filters equipments by their model.
\n","type":"text/plain"},"key":"model[]","value":""},{"disabled":true,"description":{"content":"Filters equipments by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters equipments by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""}],"variable":[]}},"response":[],"_postman_id":"f07fcf28-9123-4718-a969-c68706c6441f"},{"name":"TYPE STATISTICS","id":"f2f8eb95-86d9-4b61-ad21-0822e752ac5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/equipment/type/statistics","description":"The /equipment/type/statistics route allows listing equipment type statistics grouped by type, including the number of equipment and exams performed.
Filters equipment by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters equipment by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""}],"variable":[]}},"response":[],"_postman_id":"f2f8eb95-86d9-4b61-ad21-0822e752ac5d"},{"name":"TYPE","id":"2481c27e-4457-4471-b4ee-38363bffc4f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.224scan.com/equipment/type","description":"The /equipment/typeroute allows listing all equipment types available in 224Scan. This route does not require authentication.
The /equipment/regionroute allows listing all regions available in 224Scan. This route does not require authentication.
The /equipment route allows inserting an equipment.
The required properties are branch, description, status, deviceSerialNumber, and active.
\nThe /equipment/{{equipment}} route allows updating an equipment.
The /equipment/{{equipment}} route allows permanently deleting an equipment.
We describe in this directory how to list and manage equipment.
Equipment refers to any X-ray, magnetic resonance imaging (MRI), computed tomography (CT), or ultrasound device.
Regional laws governing the location of information can be managed by selecting the regions when handling an equipment.
The /equipmentMaintenance/list route allows listing all equipment maintenance.
Filters equipment maintenance by their equipment.
\n","type":"text/plain"},"key":"equipment[]","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their type.
\n","type":"text/plain"},"key":"type[]","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their start from a starting date.
\n","type":"text/plain"},"key":"initialStart","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their start up to an ending date.
\n","type":"text/plain"},"key":"finalStart","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their end from a starting date.
\n","type":"text/plain"},"key":"initialEnd","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their end up to an ending date.
\n","type":"text/plain"},"key":"finalEnd","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of equipment maintenance to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"fb2dd829-2c7c-470c-a456-01e39d14b141"},{"name":"OPEN","id":"906e696a-373c-44ba-8dd8-5c9263760b6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/equipmentMaintenance/{{equipmentMaintenance}}","description":"The /equipmentMaintenance/{{equipmentMaintenance}} route allows retrieving a specific equipment maintenance.
The /equipmentMaintenance/equipment/{{equipment}} route allows retrieving an active equipment maintenance.
The /equipmentMaintenance/statistics route allows listing equipment maintenance statistics, including the average duration and number of equipment maintenance, compared to competitors.
Filters equipment maintenance by their type.
\n","type":"text/plain"},"key":"type[]","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their start from a starting date.
\n","type":"text/plain"},"key":"initialStart","value":""},{"disabled":true,"description":{"content":"Filters equipment maintenance by their start up to an ending date.
\n","type":"text/plain"},"key":"finalStart","value":""},{"disabled":true,"description":{"content":"Aggregation. Use 0 for hours (default) and 1 for days.
\n","type":"text/plain"},"key":"averageType","value":""}],"variable":[]}},"response":[],"_postman_id":"ae42d60e-f9ff-4878-ac69-5e5f3051d8c6"},{"name":"TYPE","id":"9efe2ead-5133-4615-8d04-bb2dc6659692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.224scan.com/equipmentMaintenance/type","description":"The /equipmentMaintenance/type route allows listing all equipment maintenance types available in 224Scan. This route does not require authentication.
The /equipmentMaintenance/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /equipmentMaintenance route allows inserting an equipment maintenance.
The required properties are equipment, type, and start.
\nThe /equipmentMaintenance/{{equipmentMaintenance}} route allows updating an equipment maintenance.
The /equipmentMaintenance/{{equipmentMaintenance}} route allows permanently deleting an equipment maintenance.
We describe in this directory how to list and manage EquipmentMaintenance.
Maintenance is essential to assess the downtime of equipment and the reasons behind it.
\nMaintenance also plays a key role in evaluating operational performance.
\nRegional laws governing the location of information can be managed by selecting the regions when handling an EquipmentMaintenance.
The /exam/list route allows listing all exams.
Filters exams by exam description, branch description, equipment description, and patient name.
\n","type":"text/plain"},"key":"searchText","value":""},{"disabled":true,"description":{"content":"Filters exams by their branch.
\n","type":"text/plain"},"key":"branch[]","value":""},{"disabled":true,"description":{"content":"Filters exams by their equipment.
\n","type":"text/plain"},"key":"equipment[]","value":""},{"disabled":true,"description":{"content":"Filters exams by their patient.
\n","type":"text/plain"},"key":"patient[]","value":""},{"disabled":true,"description":{"content":"Filters exams by their status.
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"Filters exams by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters exams by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters exams by their DICOM (Digital Imaging and Communications in Medicine) ID.
\n","type":"text/plain"},"key":"dicomId","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of exams to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"f709aa92-8e79-493c-8bb1-ff9c8158957f"},{"name":"OPEN","id":"d9719caa-e709-4f36-be75-36dfb59fd51a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/exam/{{exam}}","description":"The /exam/{{exam}} route allows retrieving a specific exam.
The /exam/branch/statistics route allows listing exams statistics by branch, including the growth percentage, number of exams, and total of exams.
Filters exams by their branch.
\n","type":"text/plain"},"key":"branch[]","value":""},{"disabled":true,"description":{"content":"Filters exams by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters exams by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters exams by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""}],"variable":[]}},"response":[],"_postman_id":"fc5799b3-dc15-4cbf-afa7-fa54cee825e9"},{"name":"REGION STATISTICS","id":"4a16af92-eb88-4d66-9a25-f5522478663a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/exam/region/statistics","description":"The /exam/region/statistics route allows listing exams statistics by region, including the number of exams.
The /exam/{{exam}}/view route allows returning images of a specific exam.
The /exam/{{exam}}/compare route allows comparing exam results.
The /exam/{{exam}}/download route allows retrieving a specific exam PDF (Portable Document Format).
The /exam/{{exam}}/share route allows sharing a specific exam.
The /exam/status route allows listing all exam status available in 224Scan. This route does not require authentication.
The /exam/status/bulk route allows listing the status of exams in bulk.
Filters exams by their _id.
\n","type":"text/plain"},"key":"exam[]","value":""}],"variable":[]}},"response":[],"_postman_id":"95b6552c-8eb4-441b-9f4b-681249d08975"},{"name":"REGION","id":"5712d791-99fc-4b42-9dbe-44124cd4e164","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.224scan.com/exam/region","description":"The /exam/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /exam route allows inserting an exam.
The required properties are patient, status, region, studyId, and dicomId.
\nThe /exam/{{exam}} route allows updating an exam.
The /exam/{{exam}} route allows permanently deleting an exam.
We describe in this directory how to list and manage exam.
An exam refers to any image generated by equipment.
Exams are automatically populated by the 224Scan Client software, which must be installed in the institution.
\nFor internal controls within the institution, such as storing indexes, use the metadata property (e.g., key=ERPID, value=123).
Regional laws governing the location of information can be managed by selecting the regions when handling an exam.
The /examResult/list route allows listing all exam results.
Filters exam results by their branch.
\n","type":"text/plain"},"key":"branch[]","value":""},{"disabled":true,"description":{"content":"Filters exam results by their exam.
\n","type":"text/plain"},"key":"exam[]","value":""},{"disabled":true,"description":{"content":"Filters exam results by their model.
\n","type":"text/plain"},"key":"model[]","value":""},{"disabled":true,"description":{"content":"Filters exam results by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters exam results by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters exam results by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of exam results to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"96c2b61d-46aa-4fad-9e3c-1432efce0a5f"},{"name":"OPEN","id":"a91fa153-9b81-481a-9924-70e72cfeeb76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/examResult/{{examResult}}","description":"The /examResult/{{examResult}} route allows retrieving a specific exam result.
The /examResult/statistics route allows listing exam results statistics, including average duration, competitors' average duration, radiologist's average duration, median duration, competitors' median duration, and time period.
The durations are in seconds.
\nFilters exam results by their model.
\n","type":"text/plain"},"key":"model[]","value":""},{"disabled":true,"description":{"content":"Filters exam results by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters exam results by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters exam results by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""}],"variable":[]}},"response":[],"_postman_id":"19d6d7d7-9af7-41f4-bf8a-6334e442c2f6"},{"name":"MODEL STATISTICS","id":"cac06922-367b-46e8-8e9c-9020be0d3461","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/examResult/model/statistics?extended=true","description":"The /examResult/model/statistics route allows listing exam results statistics by model, including the number of exam results, gender groups, and age groups.
Filters exam results by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters exam results by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters exam results by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"description":{"content":"Includes extended statistics.
\n","type":"text/plain"},"key":"extended","value":"true"}],"variable":[]}},"response":[],"_postman_id":"cac06922-367b-46e8-8e9c-9020be0d3461"},{"name":"MODEL","id":"b531805c-ed7e-4030-834c-eb62a29b1a5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.224scan.com/examResult/model","description":"The /examResult/model route allows listing all models available in 224Scan. This route does not require authentication.
The /examResult/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /examResult/{{examResult}}/text route allows retrieving a specific exam result text.
The /examResult/{{examResult}}/html route allows retrieving a specific exam result HTML (Hypertext Markup Language).
The /examResult/{{examResult}}/pdf route allows retrieving a specific exam result PDF (Portable Document Format).
A hypodense mass is identified in the head of the pancreas, measuring approximately {X}.{y} cm in its largest dimension.
The lesion shows irregular margins and appears to encase the superior mesenteric artery, suggesting vascular involvement.
\",\r\n \"model\": [\"pancreatic_cancer\"],\r\n \"image\": [\r\n {\r\n \"fileName\": \"image-1.jpg\"\r\n },\r\n {\r\n \"fileName\": \"image-2.jpg\"\r\n }\r\n ],\r\n \"segmentation\": [\r\n {\r\n \"fileName\": \"segmentation-1.jpg\"\r\n },\r\n {\r\n \"fileName\": \"segmentation-2.jpg\"\r\n }\r\n ],\r\n \"print3d\": [\r\n {\r\n \"fileName\": \"3d-print-1.jpg\"\r\n },\r\n {\r\n \"fileName\": \"3d-print-2.jpg\"\r\n }\r\n ],\r\n \"metadata\": [\r\n {\r\n \"key\": \"ERPID\",\r\n \"value\": \"224224224\"\r\n },\r\n {\r\n \"key\": \"EPIC_PATIENT_ID\",\r\n \"value\": \"224224224\"\r\n }\r\n ],\r\n \"region\": \"us-central1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.224scan.com/examResult","description":"The /examResult route allows inserting an exam result.
The required properties are exam, contentText, and contentHtml.
\nA hypodense mass is identified in the head of the pancreas, measuring approximately {X}.{y} cm in its largest dimension.
The lesion shows irregular margins and appears to encase the superior mesenteric artery, suggesting vascular involvement.
\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.224scan.com/examResult/{{examResult}}","description":"The /examResult/{{examResult}} route allows updating an exam result.
The /examResult/{{examResult}} route allows permanently deleting an exam result.
We describe in this directory how to list and manage examResult.
An examResult refers to any result, analysis, segmentation, or 3D printing derived from an exam. Results are based on models. For example, each type of cancer corresponds to a specific model.
examResult are automatically populated by the 224Scan Client software, which must be installed in the institution.
For internal controls within the institution, such as storing indexes, use the metadata property (e.g., key=ERPID, value=123).
Regional laws governing the location of information can be managed by selecting the regions when handling an examResult.
The /examTemplate/list route allows listing all exam templates.
Filters exam templates by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters exam templates by their model.
\n","type":"text/plain"},"key":"model[]","value":""},{"disabled":true,"description":{"content":"Filters exam templates by their language.
\n","type":"text/plain"},"key":"language[]","value":""},{"disabled":true,"description":{"content":"Filters exam templates by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters exam templates by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":null},{"disabled":true,"description":{"content":"Filters exam templates by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":null},{"disabled":true,"description":{"content":"Filters exam templates by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of exam templates to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"33cc2f36-2d2b-492f-ac80-7a2f545dbef6"},{"name":"OPEN","id":"316f571c-3853-4a28-8450-899bb1be3d5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/examTemplate/{{examTemplate}}","description":"The /examTemplate/{{examTemplate}} route allows retrieving a specific exam exam template.
The /examTemplate/model route allows listing all models available in 224Scan. This route does not require authentication.
The /examTemplate/language route allows listing all languages available in 224Scan. This route does not require authentication.
The /examTemplate/region route allows listing all regions available in 224Scan. This route does not require authentication.
A hypodense mass is identified in the head of the pancreas, measuring approximately {X}.{y} cm in its largest dimension.
The lesion shows irregular margins and appears to encase the superior mesenteric artery, suggesting vascular involvement.
\",\r\n \"model\": \"pancreatic_cancer\",\r\n \"language\": \"en\",\r\n \"region\": \"us-central1\",\r\n \"active\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.224scan.com/examTemplate","description":"The /examTemplate route allows inserting an exam template.
The required properties are description, model, language, region, and active.
\nA hypodense mass is identified in the head of the pancreas, measuring approximately {X}.{y} cm in its largest dimension.
The lesion shows irregular margins and appears to encase the superior mesenteric artery, suggesting vascular involvement.
\",\r\n \"model\": \"pancreatic_cancer\",\r\n \"language\": \"en\",\r\n \"region\": \"us-central1\",\r\n \"active\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.224scan.com/examTemplate/{{examTemplate}}","description":"The /examTemplate/{{examTemplate}} route allows updating an exam template.
The /examTemplate/{{examTemplate}} route allows permanently deleting an exam template.
We describe in this directory how to list and manage examTemplate.
An examTemplate refers to any text or HTML (Hypertext Markup Language) template used in an examResult. examTemplates are based on models. For example, each type of cancer corresponds to a specific model.
Use languages to customize the experience for your clients; otherwise, a default printTemplate model will be listed.
Regional laws governing the location of information can be managed by selecting the regions when handling an examTemplate.
The /patient/list route allows listing all patients.
Filters patients by name.
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"Filters patients by family name.
\n","type":"text/plain"},"key":"nameFamily","value":""},{"disabled":true,"description":{"content":"Filters patients by second name.
\n","type":"text/plain"},"key":"nameSecond","value":""},{"disabled":true,"description":{"content":"Filters patients by given name.
\n","type":"text/plain"},"key":"nameGiven","value":""},{"disabled":true,"description":{"content":"Filters patients by called by name.
\n","type":"text/plain"},"key":"nameCalledBy","value":""},{"disabled":true,"description":{"content":"Filters patients by gender.
\n","type":"text/plain"},"key":"gender[]","value":""},{"disabled":true,"description":{"content":"Filters patients by phone.
\n","type":"text/plain"},"key":"contactPhone","value":""},{"disabled":true,"description":{"content":"Filters patients by email.
\n","type":"text/plain"},"key":"contactEmail","value":""},{"disabled":true,"description":{"content":"Filters patients by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters patients by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters patients by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of patients to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"ec847f67-3255-427b-a717-9f8e075c5ee3"},{"name":"OPEN","id":"db4b9a22-14a5-448d-9779-2ef58279e016","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/patient/{{patient}}","description":"The /patient/{{patient}} route allows retrieving a specific patient.
The /patient/statistics route allows listing patient statistics, including the number of patients and the growth of new patients in both number and percentage.
Filters patients by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":null},{"disabled":true,"description":{"content":"Filters patients by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":null}],"variable":[]}},"response":[],"_postman_id":"11f13b91-3fbc-4162-a43a-40e47b553e4f"},{"name":"GENDER STATISTICS","id":"ad554e85-de25-4435-8f20-b4b32a75c900","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/patient/gender/statistics","description":"The /patient/gender/statistics route allows listing all patient statistics grouped by gender, including the number of patients and age range.
The /patient/gender route allows listing all genders available in 224Scan. This route does not require authentication.
We follow the HL7 (Health Level Seven) standards.
\nThe /patient/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /patient/contact/system route allows listing all contact system available in 224Scan. This route does not require authentication.
We follow the HL7 (Health Level Seven) standards.
\nThe /patient/contact/use route allows listing all contact uses available in 224Scan. This route does not require authentication.
We follow the HL7 (Health Level Seven) standards.
\nThe /patient/address/type route allows listing all address types available in 224Scan. This route does not require authentication.
We follow the HL7 (Health Level Seven) standards.
\nThe /patient/address/use route allows listing all address uses available in 224Scan. This route does not require authentication.
We follow the HL7 (Health Level Seven) standards.
\nThe /patient route allows inserting a patient.
The required properties are nameFamily, nameGiven, region, dicomId, and active.
\nThe /patient/{{patient}} route allows updating a patient.
The /patient/{{patient}} route allows permanently deleting a patient.
We describe in this directory how to list and manage patient.
A patient refers to any patient and/or client. Patients are automatically populated by the 224Scan Client software, which must be installed in the institution.
For internal controls within the institution, such as storing indexes, use the metadata property (e.g., key=ERPID, value=123).
Regional laws governing the location of information can be managed by selecting the regions when handling a patient.
The /printTemplate/list route allows listing all print templates.
Filters print templates by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters print templates by model.
\n","type":"text/plain"},"key":"model[]","value":""},{"disabled":true,"description":{"content":"Filters print templates by language.
\n","type":"text/plain"},"key":"language[]","value":""},{"disabled":true,"description":{"content":"Filters print templates by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":null},{"disabled":true,"description":{"content":"Filters print templates by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":null},{"disabled":true,"description":{"content":"Filters print templates by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":null},{"disabled":true,"description":{"content":"Number of print templates to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"0ece6b88-7556-460b-82d5-91f6e32620e7"},{"name":"OPEN","id":"af12afd2-c9ff-4100-a404-23f32fb325db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/printTemplate/{{printTemplate}}","description":"The /printTemplate/{{printTemplate}} route allows retrieving a specific print template.
The /printTemplate/model route allows listing all models available in 224Scan. This route does not require authentication.
The /printTemplate/language route allows listing all languages available in 224Scan. This route does not require authentication.
We describe in this directory how to list and manage printTemplate.
A printTemplate refers to any text or HTML (Hypertext Markup Language) template used in an examResult when the institution does not have a custom examTemplate. printTemplates are based on models. For example, each type of cancer corresponds to a specific model.
We use different languages to customize the experience for your clients. Only the 224Scan team is authorized to manage this information.
\n","_postman_id":"8203d17b-86d9-49cb-8e71-b331dfbd2f04"},{"name":"QRCODE","item":[{"name":"URL","id":"9c94d89a-5aec-45e9-bb0b-555becaa4d33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.224scan.com/qrcode/?url={{url}}","description":"The /qrcode/url route allows the generation of QR code (Quick Response Codes) images with dimensions of 375x375 pixels.
This route does not require authentication.
\nFor security reasons, only images of *.224scan.com domain are generated.
\n| HTTP code | \nContent type | \nBody | \nDescription | \n
|---|---|---|---|
| 200 | \nimage/png | \nSuccess. | \n|
| 400 | \napplication/json | \n{ \"error\": [{ \"message\": \"Invalid url!\", \"status_code\": 400 }] } | \nInvalid URL (Uniform Resource Locator). | \n
| 429 | \napplication/json | \n{ \"error\": [{ \"message\": \"Too many requests!\", \"status_code\": 429 }] } | \nToo many requests. | \n
URL (Uniform Resource Locator). Example: https://exam.224scan.com/224224/224224
\n","type":"text/plain"},"key":"url","value":"{{url}}"}],"variable":[]}},"response":[],"_postman_id":"9c94d89a-5aec-45e9-bb0b-555becaa4d33"}],"id":"a386e4f0-dbce-442c-bc79-52584bd76aa0","description":"We describe in this directory how to manage QR codes (Quick Response Codes).
\n","_postman_id":"a386e4f0-dbce-442c-bc79-52584bd76aa0"},{"name":"SERVER","item":[{"name":"LIST","id":"297a5ea8-bec3-4709-8a4c-d2bd88a5f10e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/server/list","description":"The /server/list route allows listing all servers.
Filters servers by server description and branch description.
\n","type":"text/plain"},"key":"searchText","value":""},{"disabled":true,"description":{"content":"Filters servers by their branch.
\n","type":"text/plain"},"key":"branch[]","value":""},{"disabled":true,"description":{"content":"Filters servers by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters servers by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters servers by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":null},{"disabled":true,"description":{"content":"Filters servers by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":null},{"disabled":true,"description":{"content":"Filters servers by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of servers to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"297a5ea8-bec3-4709-8a4c-d2bd88a5f10e"},{"name":"OPEN","id":"efbde8c4-4a64-40bf-94c7-c6659a6dfb55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/server/{{server}}","description":"The /server/{{server}} route allows retrieving a specific server.
The /server/check route allows retrieving a list with the availability status of the servers.
Response
\n","urlObject":{"path":["server","check"],"host":["https://api.224scan.com"],"query":[{"disabled":true,"description":{"content":"Filters servers by server description and branch description.
\n","type":"text/plain"},"key":"searchText","value":""},{"disabled":true,"description":{"content":"Filters servers by their branch.
\n","type":"text/plain"},"key":"branch[]","value":""},{"disabled":true,"description":{"content":"Filters servers by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters servers by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters servers by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of servers to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"33c69f0f-9dd3-4bd3-a726-d3425d5dc3a4"},{"name":"REGION","id":"c5cf772f-5339-4910-8b0f-5130c66a3fab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.224scan.com/server/region","description":"The /server/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /server route allows inserting a server.
The required properties are branch, description, region, and active.
\nThe /server/{{server}} route allows updating a server.
The /server/{{server}} route allows permanently deleting a server.
We describe in this directory how to list and manage server.
A server represents a source of DICOM (Digital Imaging and Communications in Medicine) images. This may include an external DICOM server, the embedded 224Scan DICOM server, a local filesystem storage, or another compatible image source.
Servers can be automatically registered by the 224Scan Client software when it is installed in the institution, or configured manually depending.
\nRegional laws governing the location of information can be managed by selecting the regions when handling a server.
The /serverPing/list route allows listing all server pings.
Filters server pings by server description and branch description.
\n","type":"text/plain"},"key":"searchText","value":""},{"disabled":true,"description":{"content":"Filters servers by their branch.
\n","type":"text/plain"},"key":"branch[]","value":""},{"disabled":true,"description":{"content":"Filters servers by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Filters servers by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters servers by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filter server pings by their final ping dates.
\n","type":"text/plain"},"key":"initialDatePing","value":""},{"disabled":true,"description":{"content":"Filter server pings by their initial ping dates.
\n","type":"text/plain"},"key":"finalDatePing","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of server pings to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"4db380e1-9d30-46bb-8f5e-5b564760d3f3"},{"name":"REGION","id":"65fb0b9c-e3ce-4a98-8e21-1ceb8aa96404","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.224scan.com/serverPing/region","description":"The /serverPing/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /serverPing route allows inserting a server ping.
The required properties are server and region.
\nWe describe in this directory how to list and manage serverPing.
A serverPing refers to the moments when the server was online.
This schema tracks server downtimes and helps technical teams identify network issues.
\nThe 224Scan Client software automatically registers pings from time to time.
\n","_postman_id":"89fbc1b3-6eac-4c3a-bee3-66da4800bb65"},{"name":"TENANT","item":[{"name":"LIST","id":"1d838eb0-4a3d-41f5-aa24-cf0f46395c8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/tenant/list","description":"The /tenant/list route allows listing all tenants.
The /tenant/{{tenant}} route allows retrieving a specific tenant. It is not possible to access tenants from other institutions.
The /tenant/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /tenant/timezone route allows listing all time zones available in 224Scan. This route does not require authentication.
The /tenant/{{tenant}} route allows updating a tenant. It is not possible to access tenants from other institutions.
The /tenant/logo route allows permanently deleting logo image.
We describe in this directory how to list and manage tenant.
A tenant refers to the institution, whether an imaging clinic, hospital, or government entity, that has contracted the 224Scan.
Regional laws governing the location of information can be managed by selecting the regions when handling a tenant.
PNG (Portable Network Graphics) file.
\n","value":null}]},"url":"https://api.224scan.com/upload/tenant/logo","description":"The /upload/tenant/logo route allows inserting a logo image.
Branch.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"DICOM (Digital Imaging and Communications in Medicine) file.
\n","value":null}]},"url":"/upload/dicom","description":"The /upload/dicom route allows uploading a DICOM (Digital Imaging and Communications in Medicine) file.
The 224Scan Discovery will automatically register an /exam/ after comparing the file with the artificial intelligence models for radiology.
We describe in this directory how to upload files.
\nDICOM (Digital Imaging and Communications in Medicine) files are automatically populated by the 224Scan Client software, which must be installed in the institution.
\n","_postman_id":"d2e13f59-fd34-4c6b-816d-6dc8be992b43"},{"name":"USER","item":[{"name":"LIST","id":"86db6c06-9595-42ba-bdbb-beff12b6d6cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/user/list","description":"The /user/list route allows listing all users.
Filter users by their names.
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"Filter users by their family names.
\n","type":"text/plain"},"key":"nameFamily","value":""},{"disabled":true,"description":{"content":"Filter users by their second names.
\n","type":"text/plain"},"key":"nameSecond","value":""},{"disabled":true,"description":{"content":"Filter users by their given names.
\n","type":"text/plain"},"key":"nameGiven","value":""},{"disabled":true,"description":{"content":"Filter users by the name they are called by.
\n","type":"text/plain"},"key":"nameCalledBy","value":""},{"disabled":true,"description":{"content":"Filters users by their level.
\n","type":"text/plain"},"key":"level","value":""},{"disabled":true,"description":{"content":"Filters users by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters users by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters users by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters users by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of servers to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"86db6c06-9595-42ba-bdbb-beff12b6d6cc"},{"name":"OPEN","id":"0c9ac092-cb4e-476c-9789-65681a3ede5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/user/{{user}}","description":"The /user/{{user}} route allows retrieving a specific user.
The /user/me route allows you to retrieve your own user information.
The /user/level route allows listing all user levels available in 224Scan. This route does not require authentication.
The /user/region route allows listing all regions available in 224Scan. This route does not require authentication.
The /user route allows inserting an user.
The required properties are nameFamily, nameGiven, email, level, language, region, and active.
\nThe /user/{{user}} route allows updating an user.
The /user/{user} route allows permanently deleting an user.
We describe in this directory how to list and manage user.
An user refers to anyone who has access to 224Scan. This can include radiologists, physicists, doctors, network administrators, and others.
Regional laws governing the location of information can be managed by selecting the regions when handling an user.
The /webhook/list route allows listing all webhooks.
Filters webhooks by description.
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"Filters webhooks by their schema name.
\n","type":"text/plain"},"key":"schemaName","value":""},{"disabled":true,"description":{"content":"Filters webhooks by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters webhooks by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters webhooks by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters webhooks by their active status.
\n","type":"text/plain"},"key":"active","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of webhook triggers to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"9d8a061d-b627-4c81-a305-1d21b2c6fdc3"},{"name":"OPEN","id":"67445321-254d-496a-99a2-9b28abda06e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token_bearer}}","type":"text"}],"url":"https://api.224scan.com/webhook/{{webhook}}","description":"The /webhook/{{webhook}} route allows retrieving a specific webhook.
The /webhook route allows inserting an webhook.
The required properties are description, schemaName, requestType, requestUrl, region, and active.
\nThe /webhook/{{webhook}} route allows updating an webhook.
The /webhook/{{webhook}} route allows permanently deleting an webhook.
We describe in this directory how to list and manage webhook.
An webhook refers to the configuration of automated messages that 224Scan will trigger when something happens.
Webhooks are also commonly known as HTTP (Hypertext Transfer Protocol) callbacks.
\nRegional laws governing the location of information can be managed by selecting the regions when handling an webhook.
The /webhookTrigger/list route allows listing all webhook triggers.
Filters webhook triggers by webhook description.
\n","type":"text/plain"},"key":"searchText","value":""},{"disabled":true,"description":{"content":"Filters webhook triggers by their webhook.
\n","type":"text/plain"},"key":"webhook[]","value":""},{"disabled":true,"description":{"content":"Filters webhook triggers by their status.
\n","type":"text/plain"},"key":"status[]","value":""},{"disabled":true,"description":{"content":"Filters webhook triggers by their region.
\n","type":"text/plain"},"key":"region[]","value":""},{"disabled":true,"description":{"content":"Filters webhook triggers by their created from a starting date.
\n","type":"text/plain"},"key":"initialCreatedAt","value":""},{"disabled":true,"description":{"content":"Filters webhook triggers by their created up to an ending date.
\n","type":"text/plain"},"key":"finalCreatedAt","value":""},{"disabled":true,"description":{"content":"Specific properties to be included in the response.
\n","type":"text/plain"},"key":"property","value":""},{"disabled":true,"description":{"content":"Number of webhook triggers to skip.
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[],"_postman_id":"28f8a11d-986c-4ddc-aa30-3855ee5ef219"}],"id":"341ed956-9d47-4b49-a2b1-1abf53eea3ff","description":"We describe in this directory how to list webhookTrigger.
An webhookTrigger refers to the automated messages sent by 224Scan when a /webhook has been triggered.