GET api/Exams?externalId={externalId}

Gets information about an exam.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalId

Exam's unique ID on integrating system.

 string

Required

Body Parameters

None.

Response Information

Resource Description

ExamModel
NameDescriptionTypeAdditional information
PatientExternalID

Patient number of the exam (Required).

 string

None.
DoctorExternalID

Doctor number of the exam.

 string

None.
Date

Date of the exam (Required).

 date

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "patientExternalID": "sample string 1",
  "doctorExternalID": "sample string 2",
  "date": "2026-05-29T16:58:02.2205885+00:00",
  "id": "3b709bc8-b680-4e96-992b-ffccc02ed7ba",
  "externalId": "sample string 5"
}

application/xml, text/xml

Sample: 
<ExamModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Exams">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 5</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">3b709bc8-b680-4e96-992b-ffccc02ed7ba</Id>
  <Date>2026-05-29T16:58:02.2205885+00:00</Date>
  <DoctorExternalID>sample string 2</DoctorExternalID>
  <PatientExternalID>sample string 1</PatientExternalID>
</ExamModel>