POST api/groups/{groupid}/drugprofiles/{drugprofileid}/drugprofileadvancedgpis

Creates a new drug profile advanced GPI associated with a specified group.

Request Information

URI Parameters

Name	Description	Type	Additional information
groupid	The ID of the group.	integer	Required
drugprofileid	The drug profile ID associated with the new advanced GPI.	integer	Required

Body Parameters

The drug profile advanced GPI model to add.

DrugProfileAdvancedGPIModel

Name	Description	Type	Additional information
GenericProductIdentifier	Gets or sets the GPI associated with 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.
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.
EffectiveStartDate	Gets or sets the Effective Start Date for the associated drug profile	date	None.
EffectiveEndDate	Gets or sets the Effective End Date for the associated drug profile	date	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 4",
  "id": 5,
  "genericProductIdentifier": "sample string 2",
  "isBrand": true,
  "isRx": true,
  "brandNameCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "multiSourceCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "effectiveStartDate": "2026-08-08T01:17:57.6065918-05:00",
  "effectiveEndDate": "2026-08-08T01:17:57.6065918-05:00"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

DrugProfileAdvancedGPIModel

Name	Description	Type	Additional information
GenericProductIdentifier	Gets or sets the GPI associated with 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.
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.
EffectiveStartDate	Gets or sets the Effective Start Date for the associated drug profile	date	None.
EffectiveEndDate	Gets or sets the Effective End Date for the associated drug profile	date	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 4",
  "id": 5,
  "genericProductIdentifier": "sample string 2",
  "isBrand": true,
  "isRx": true,
  "brandNameCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "multiSourceCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "effectiveStartDate": "2026-08-08T01:17:57.6065918-05:00",
  "effectiveEndDate": "2026-08-08T01:17:57.6065918-05:00"
}