GET api/PatientEducationMaterial/search?name={name}&doctorId={doctorId}&dateAddedOperator={dateAddedOperator}&dateAdded1={dateAdded1}&dateAdded2={dateAdded2}&type={type}&active={active}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of education material of a patient.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

Get the active medications searched by name.

string

Default value is

doctorId

Unique ID of doctor

globally unique identifier

None.

dateAddedOperator

Operator used to filter the list based on the start date of the appointment. Possible values: NotCompare (equals to empty string ""), Equals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, DifferentThan, Contains, StartsWith

string

Default value is

dateAdded1

Used to filter the list based on the start date of the appointment.

date

None.

dateAdded2

Used to filter the list based on the start date of the appointment(only when comparison operator is Between).

date

None.

type

Type of the education material. Possible values: Document (Default), Link, Video

string

Default value is

active

Indicates whether to get the active medications or not.

boolean

Default value is True

page

Page number requested (search results are paginated).

integer

Default value is 1

itemsPerPage

Items to return on each page. See page parameter above.

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfPatientEducationMaterialModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of PatientEducationMaterialModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": "3d035fa6-76c4-4ab1-8628-4e9cb830c8d2",
      "DoctorId": "1e4e5c0a-9468-4777-bf09-0f37b635f6c5",
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Active": true,
      "URL": "sample string 4",
      "DateAddedUtc": "sample string 5",
      "DoctorFullName": "sample string 6",
      "Viewed": true
    },
    {
      "Id": "3d035fa6-76c4-4ab1-8628-4e9cb830c8d2",
      "DoctorId": "1e4e5c0a-9468-4777-bf09-0f37b635f6c5",
      "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:
<ListModelOfPatientEducationMaterialModelrgnwL1kl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientEducationMaterials">
    <d2p1:PatientEducationMaterialModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DateAddedUtc>sample string 5</d2p1:DateAddedUtc>
      <d2p1:DoctorFullName>sample string 6</d2p1:DoctorFullName>
      <d2p1:DoctorId>1e4e5c0a-9468-4777-bf09-0f37b635f6c5</d2p1:DoctorId>
      <d2p1:Id>3d035fa6-76c4-4ab1-8628-4e9cb830c8d2</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Type>sample string 2</d2p1:Type>
      <d2p1:URL>sample string 4</d2p1:URL>
      <d2p1:Viewed>true</d2p1:Viewed>
    </d2p1:PatientEducationMaterialModel>
    <d2p1:PatientEducationMaterialModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DateAddedUtc>sample string 5</d2p1:DateAddedUtc>
      <d2p1:DoctorFullName>sample string 6</d2p1:DoctorFullName>
      <d2p1:DoctorId>1e4e5c0a-9468-4777-bf09-0f37b635f6c5</d2p1:DoctorId>
      <d2p1:Id>3d035fa6-76c4-4ab1-8628-4e9cb830c8d2</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Type>sample string 2</d2p1:Type>
      <d2p1:URL>sample string 4</d2p1:URL>
      <d2p1:Viewed>true</d2p1:Viewed>
    </d2p1:PatientEducationMaterialModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfPatientEducationMaterialModelrgnwL1kl>