POST api/groups/{groupid}/drugprofiles

Creates a new drug profile associated with a specified group.

Request Information

URI Parameters

Name	Description	Type	Additional information
groupid	The ID of the group.	integer	Required

Body Parameters

The drug profile model to add.

DrugProfileModel

Name	Description	Type	Additional information
GroupNo	The identifier for the drug profile's group. This value will only be populated if the drug profile is not global.	integer	None.
ProfileName	Gets or sets the Name of the Drug Profile	string	None.
Description	Gets or sets the description of the drug profile.	string	None.
IsBrand	Gets or sets a value indicating whether the drug is a brand.	boolean	None.
IsRx	Gets or sets a value indicating whether the drug is prescription.	boolean	None.
GenericAvailable	Gets or sets a value indicating whether a generic version is available.	boolean	None.
OTCAvailable	Gets or sets a value indicating whether an over-the-counter version is available.	boolean	None.
IsMultiSourced	Gets or sets a value indicating whether the drug is multi-sourced.	boolean	None.
IsRepackaged	Gets or sets a value indicating whether the drug is repackaged.	boolean	None.
IsMaintenanceDrug	Gets or sets a value indicating whether the drug is a maintenance drug.	boolean	None.
DEAClassCodes	Gets or sets the applicable DEA schedules for the drug criteria	Collection of DEAScheduleModel	None.
BrandNameCodes	Gets or sets the applicable brand codes for the drug criteria	Collection of BrandNameCodeModel	None.
MultiSourceCodes	Gets or sets the applicable multi-source codes for the drug criteria	Collection of MultiSourceCodeModel	None.
DrugProfileGPIsUrl	Gets the Url where the GPI's for this Drug Profile can be found and updated.	string	None.
DrugProfileNDCsUrl	Gets the Url where the NDC's for this Drug Profile can be found and updated.	string	None.
DrugProfileDDIDsUrl	Gets the Url where the DDID's for this Drug Profile can be found and updated.	string	None.
DrugProfileRoutesOfAdministrationUrl	Gets the Url where the Routes of Administration for this Drug Profile can be found and updated.	string	None.
DrugProfileDosageFormsUrl	Gets the Url where the Dosage Forms for this Drug Profile can be found and updated.	string	None.
NDCListIsExclusion	Gets or sets the NDCListIsExclusion for this Drug Profile.	boolean	None.
DDIDListIsExclusion	Gets or sets the DDIDListIsExclusion for this Drug Profile.	boolean	None.
Url	Gets or sets the link representing a link back to the resource	string	None.
ID	Gets or sets the identifier for the resource	integer	None.

Request Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "url": "sample string 10",
  "id": 11,
  "groupNo": 1,
  "profileName": "sample string 1",
  "description": "sample string 2",
  "isBrand": true,
  "isRx": true,
  "genericAvailable": true,
  "otcAvailable": true,
  "isMultiSourced": true,
  "isRepackaged": true,
  "isMaintenanceDrug": true,
  "deaClassCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "brandNameCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "multiSourceCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "drugProfileGPIsUrl": "sample string 3",
  "drugProfileNDCsUrl": "sample string 4",
  "drugProfileDDIDsUrl": "sample string 5",
  "drugProfileRoutesOfAdministrationUrl": "sample string 6",
  "drugProfileDosageFormsUrl": "sample string 7",
  "ndcListIsExclusion": true,
  "ddidListIsExclusion": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the newly created drug profile model if successful; otherwise, returns an error message.

CompanyAgeLimitModel

Name	Description	Type	Additional information
Name	Gets or sets the description of the age limit resource	string	None.
isGlobal	Gets or sets whether this is a global age limit resource (true if Global, false if Formulary-level) Obsolete - will be removed at a later date	boolean	None.
MinAge	Gets or sets the Min Age of the age limit resource	integer	None.
MinAgeQualifier	Gets or sets the Min Age Qualifier of the age limit resource D=Days, Y=Years	string	None.
MaxAge	Gets or sets the Max Age of the age limit resource	integer	None.
MaxAgeQualifier	Gets or sets the Max Age Qualifier of the age limit resource D=Days, Y=Years	string	None.
CreatedOn	Gets or sets the datetime when the age limit was created	date	None.
AuditNote	Gets or sets the value indicating (for audit purposes) why the most current change was made	string	None.
Active	Gets or sets the value indicating whether this age limit is currently active.	boolean	None.
Url	Gets or sets the link representing a link back to the resource	string	None.
ID	Gets or sets the identifier for the resource	integer	None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "url": "sample string 6",
  "id": 7,
  "name": "sample string 2",
  "isGlobal": true,
  "minAge": 1,
  "minAgeQualifier": "sample string 3",
  "maxAge": 1,
  "maxAgeQualifier": "sample string 4",
  "createdOn": "2025-05-30T20:55:00.9780001-05:00",
  "auditNote": "sample string 5",
  "active": true
}