PATCH api/formularies/{formularyid}/formularyproductcoverageexclusions/{id}
Patches an existing Product Coverage Exclusion object
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
formularyid |
The id of the formulary for which product coverage exclusion |
integer |
Required |
id |
Product coverage exclusion identifier |
integer |
Required |
Body Parameters
The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target formulary product coverage exclusion
JsonPatchDocumentName | 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
A patched Product Coverage Exclusion object
ProductCoverageExclusionModelName | Description | Type | Additional information |
---|---|---|---|
ProductID |
Gets or sets the product ID for this resource. The value should be a valid NDC, DDID or GPI. |
string |
None. |
ProductIDType |
Gets or sets the product ID Type for the ProductID value set on this resource. The value will indicate whether the product ID for this resource is an NDC or DDID . String values other than 'NDC' or 'DDID' will not be valid. |
string |
None. |
EffectiveStartDate |
Gets or sets the Effective Start Date of this resource |
date |
None. |
EffectiveEndDate |
Gets or sets the Effective End Date of this resource |
date |
None. |
AuditNote |
Gets or sets the value indicating (for audit purposes) why the most current change was made |
string |
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, "productID": "sample string 1", "productIDType": "sample string 2", "effectiveStartDate": "2025-05-30T20:41:50.7970772-05:00", "effectiveEndDate": "2025-05-30T20:41:50.7970772-05:00", "auditNote": "sample string 3" }