GET api/PatientEducationMaterial?patientEducationMaterialId={patientEducationMaterialId}
Returns specific education material of a patient.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientEducationMaterialId |
Unique ID of patient education material. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
PatientEducationMaterialModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Unique ID of the patient education material (Read only). |
globally unique identifier |
None. |
| DoctorId |
Unique ID of the doctor. |
globally unique identifier |
None. |
| Name |
Name of the education material. |
string |
None. |
| Type |
Type of patient education material. Possible values : Document, Link and Videos. |
string |
None. |
| Active |
Indicates that patient education material is active or not. |
boolean |
None. |
| URL |
URL of the patient education material. |
string |
None. |
| DateAddedUtc |
The date when the patient education material was added. |
string |
None. |
| DoctorFullName |
Full name of the doctor |
string |
None. |
| Viewed |
Indicates if patient education material is viewed or not. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "1deaad5d-5ace-4962-bedb-08282526e667",
"DoctorId": "38654a52-fe5d-4415-be53-2be20cc152b8",
"Name": "sample string 1",
"Type": "sample string 2",
"Active": true,
"URL": "sample string 4",
"DateAddedUtc": "sample string 5",
"DoctorFullName": "sample string 6",
"Viewed": true
}
application/xml, text/xml
Sample:
<PatientEducationMaterialModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientEducationMaterials"> <Active>true</Active> <DateAddedUtc>sample string 5</DateAddedUtc> <DoctorFullName>sample string 6</DoctorFullName> <DoctorId>38654a52-fe5d-4415-be53-2be20cc152b8</DoctorId> <Id>1deaad5d-5ace-4962-bedb-08282526e667</Id> <Name>sample string 1</Name> <Type>sample string 2</Type> <URL>sample string 4</URL> <Viewed>true</Viewed> </PatientEducationMaterialModel>