POST api/MedicationFormTypes
Create a new medication dosage or update an existing medication form type in the Eye Reach Patients list.
Request Information
URI Parameters
None.
Body Parameters
Model used to create or retrieve a medication form type.
MedicationFormTypeModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Name of the medication form type (Required). |
string |
None. |
| Active |
Indicates whether the medication form type 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. |
Request Formats
application/json, text/json
Sample:
{
"name": "sample string 1",
"active": true,
"id": "sample string 3",
"externalId": "sample string 4"
}
application/xml, text/xml
Sample:
<MedicationFormTypeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.MedicationMaster.MedicationFormTypes"> <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 4</ExternalId> <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 3</Id> <Active>true</Active> <Name>sample string 1</Name> </MedicationFormTypeModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
MedicationFormTypeModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Name of the medication form type (Required). |
string |
None. |
| Active |
Indicates whether the medication form type 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",
"active": true,
"id": "sample string 3",
"externalId": "sample string 4"
}
application/xml, text/xml
Sample:
<MedicationFormTypeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.MedicationMaster.MedicationFormTypes"> <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 4</ExternalId> <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 3</Id> <Active>true</Active> <Name>sample string 1</Name> </MedicationFormTypeModel>