POST api/DosageForms

Creates a new dosage form or updates an existent dosage form's information.

Request Information

URI Parameters

None.

Body Parameters

DosageFormModel
NameDescriptionTypeAdditional information
Name

Name of dosage form (Required).

 string

None.
SortOrder

Indicates the sort order of this dosage form in the list.

 integer

None.
Id

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

 globally unique identifier

None.
ExternalId

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "sortOrder": 2,
  "id": "13c73200-5b33-4fe5-a631-ccfec77f7c5f",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<DosageFormModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.DosageForms">
  <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">13c73200-5b33-4fe5-a631-ccfec77f7c5f</Id>
  <Name>sample string 1</Name>
  <SortOrder>2</SortOrder>
</DosageFormModel>

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 'DosageFormModel'.

Response Information

Resource Description

DosageFormModel
NameDescriptionTypeAdditional information
Name

Name of dosage form (Required).

 string

None.
SortOrder

Indicates the sort order of this dosage form in the list.

 integer

None.
Id

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

 globally unique identifier

None.
ExternalId

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "sortOrder": 2,
  "id": "feca9e20-fe17-4b63-9397-71a3a937d712",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<DosageFormModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.DosageForms">
  <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">feca9e20-fe17-4b63-9397-71a3a937d712</Id>
  <Name>sample string 1</Name>
  <SortOrder>2</SortOrder>
</DosageFormModel>