GET api/MedicationFrequencies?externalId={externalId}

Gets information about a medication frequency in the Eye Reach Patients list.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalId

Unique ID of the medication frequency on integrating system.

 string

Required

Body Parameters

None.

Response Information

Resource Description

MedicationFrequencyModel
NameDescriptionTypeAdditional information
Name

Name of the medication frequency (Required).

 string

None.
FriendlyName

Friendly name of the medication frequency (Required).

 string

None.
Active

Indicates whether the medication frequency is active or not.

 boolean

None.
Id

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

 string

None.
ExternalId

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "friendlyName": "sample string 2",
  "active": true,
  "id": "sample string 4",
  "externalId": "sample string 5"
}

application/xml, text/xml

Sample: 
<MedicationFrequencyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.MedicationMaster.MedicationFrequencies">
  <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">sample string 4</Id>
  <Active>true</Active>
  <FriendlyName>sample string 2</FriendlyName>
  <Name>sample string 1</Name>
</MedicationFrequencyModel>