POST api/Medications

Create a new medication or update the configuration of an existing medication in the Eye Reach Patients list.

Request Information

URI Parameters

None.

Body Parameters

Model used to create or retrieve a medication.

MedicationModel
NameDescriptionTypeAdditional information
Name

Name of the medication (Required).

 string

None.
Strength

Strength of the medication (Required).

 string

None.
Active

Indicates whether the medication is active or not.

 boolean

None.
DosageExternalIds

List of dosage unique IDs on integrating system.

 Collection of string

None.
FrequencyExternalIds

List of frequency unique IDs on integrating system.

 Collection of string

None.
FormTypeExternalIds

List of form type unique IDs on integrating system.

 Collection of string

None.
RouteExternalIds

List of route unique IDs on integrating system.

 Collection of string

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.

Request Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "strength": "sample string 2",
  "active": true,
  "dosageExternalIds": [
    "sample string 1",
    "sample string 2"
  ],
  "frequencyExternalIds": [
    "sample string 1",
    "sample string 2"
  ],
  "formTypeExternalIds": [
    "sample string 1",
    "sample string 2"
  ],
  "routeExternalIds": [
    "sample string 1",
    "sample string 2"
  ],
  "id": "sample string 4",
  "externalId": "sample string 5"
}

application/xml, text/xml

Sample: 
<MedicationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.MedicationMaster.Medications">
  <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>
  <DosageExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DosageExternalIds>
  <FormTypeExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FormTypeExternalIds>
  <FrequencyExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FrequencyExternalIds>
  <Name>sample string 1</Name>
  <RouteExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RouteExternalIds>
  <Strength>sample string 2</Strength>
</MedicationModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MedicationModel'.

Response Information

Resource Description

MedicationModel
NameDescriptionTypeAdditional information
Name

Name of the medication (Required).

 string

None.
Strength

Strength of the medication (Required).

 string

None.
Active

Indicates whether the medication is active or not.

 boolean

None.
DosageExternalIds

List of dosage unique IDs on integrating system.

 Collection of string

None.
FrequencyExternalIds

List of frequency unique IDs on integrating system.

 Collection of string

None.
FormTypeExternalIds

List of form type unique IDs on integrating system.

 Collection of string

None.
RouteExternalIds

List of route unique IDs on integrating system.

 Collection of string

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",
  "strength": "sample string 2",
  "active": true,
  "dosageExternalIds": [
    "sample string 1",
    "sample string 2"
  ],
  "frequencyExternalIds": [
    "sample string 1",
    "sample string 2"
  ],
  "formTypeExternalIds": [
    "sample string 1",
    "sample string 2"
  ],
  "routeExternalIds": [
    "sample string 1",
    "sample string 2"
  ],
  "id": "sample string 4",
  "externalId": "sample string 5"
}

application/xml, text/xml

Sample: 
<MedicationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.MedicationMaster.Medications">
  <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>
  <DosageExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DosageExternalIds>
  <FormTypeExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FormTypeExternalIds>
  <FrequencyExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FrequencyExternalIds>
  <Name>sample string 1</Name>
  <RouteExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RouteExternalIds>
  <Strength>sample string 2</Strength>
</MedicationModel>