PATCH api/drugprofiles/{drugprofileid}/drugprofileadvancedgpis/{id}
This endpoint allows modification of a global drug profile advanced GPI.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| drugprofileid |
The ID of the drug profile. |
integer |
Required |
| id |
The ID of the drug profile advanced GPI to update. |
integer |
Required |
Body Parameters
The JSON Patch document containing the changes.
JsonPatchDocument| Name | Description | Type | Additional information |
|---|---|---|---|
| Operations | Collection of Operation |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
application/json-patch+json
Sample not available.
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Returns the updated 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
{
"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:58.5230861-05:00",
"effectiveEndDate": "2026-08-08T01:17:58.5230861-05:00"
}