POST api/globalcompanyquantitylimits
Posts a new Global Company Quantity Limit
Request Information
URI Parameters
None.
Body Parameters
CompanyQuantityLimitModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Gets or sets the description of the quantity limit resource |
string |
None. |
| isGlobal |
Gets or sets whether this is a global quantity limit resource (true if Global, false if Formulary-level) Obsolete - will be removed at a later date |
boolean |
None. |
| MaxAmount |
Gets or sets the Max Amount |
decimal number |
None. |
| MaxAmountQualifier |
Gets or sets the two letter code representing the qualifier for the max amount value DS - Days Supply FL - Fills DL - Dollar Amount QY - Quantity |
MaxAmountQualifier |
None. |
| MaxAmountTimePeriod |
Gets or sets the two letter code representing the time period for the max amount SP - Specific Date Range DY - Days CM - Calendar Month LT - Lifetime CY - Calendar Year PD - Per Dispensing CQ - Calendar Quarter |
MaxAmountTimePeriod |
None. |
| MaxAmountTimePeriodStartDate |
Gets or sets the Max Amount Time Period Start Date |
date |
None. |
| MaxAmountTimePeriodEndDate |
Gets or sets the Max Amount Time Period End Date |
date |
None. |
| MaxAmountTimePeriodUnits |
Gets or sets the units to use in combination with the max amount time period(e.g.MaxAmountTimePeriodUnits= 30 and a MaxAmountTimePeriod of 'DY' would indicate 30 days) |
string |
None. |
| EffectiveEndDate |
Gets or sets the Effective End Date of this resource |
date |
None. |
| EffectiveStartDate |
Gets or sets the Effective Start Date of this resource |
date |
None. |
| CreatedOn |
Gets or sets the Created On Date for this resource |
date |
None. |
| ChangedOn |
Gets or sets the Changed On Date for this resource |
date |
None. |
| AuditNote |
Gets or sets the Audit Note for this resource |
string |
None. |
| Active |
Gets or sets the Active status for this resource |
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
{
"url": "sample string 5",
"id": 6,
"name": "sample string 2",
"isGlobal": true,
"maxAmount": 1.0,
"maxAmountQualifier": 0,
"maxAmountTimePeriod": 0,
"maxAmountTimePeriodStartDate": "2025-05-30T20:50:53.1523665-05:00",
"maxAmountTimePeriodEndDate": "2025-05-30T20:50:53.1523665-05:00",
"maxAmountTimePeriodUnits": "sample string 3",
"effectiveEndDate": "2025-05-30T20:50:53.1523665-05:00",
"effectiveStartDate": "2025-05-30T20:50:53.1523665-05:00",
"createdOn": "2025-05-30T20:50:53.1523665-05:00",
"changedOn": "2025-05-30T20:50:53.1523665-05:00",
"auditNote": "sample string 4",
"active": true
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The newly created Global Company Quantity Limit object
CompanyQuantityLimitModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Gets or sets the description of the quantity limit resource |
string |
None. |
| isGlobal |
Gets or sets whether this is a global quantity limit resource (true if Global, false if Formulary-level) Obsolete - will be removed at a later date |
boolean |
None. |
| MaxAmount |
Gets or sets the Max Amount |
decimal number |
None. |
| MaxAmountQualifier |
Gets or sets the two letter code representing the qualifier for the max amount value DS - Days Supply FL - Fills DL - Dollar Amount QY - Quantity |
MaxAmountQualifier |
None. |
| MaxAmountTimePeriod |
Gets or sets the two letter code representing the time period for the max amount SP - Specific Date Range DY - Days CM - Calendar Month LT - Lifetime CY - Calendar Year PD - Per Dispensing CQ - Calendar Quarter |
MaxAmountTimePeriod |
None. |
| MaxAmountTimePeriodStartDate |
Gets or sets the Max Amount Time Period Start Date |
date |
None. |
| MaxAmountTimePeriodEndDate |
Gets or sets the Max Amount Time Period End Date |
date |
None. |
| MaxAmountTimePeriodUnits |
Gets or sets the units to use in combination with the max amount time period(e.g.MaxAmountTimePeriodUnits= 30 and a MaxAmountTimePeriod of 'DY' would indicate 30 days) |
string |
None. |
| EffectiveEndDate |
Gets or sets the Effective End Date of this resource |
date |
None. |
| EffectiveStartDate |
Gets or sets the Effective Start Date of this resource |
date |
None. |
| CreatedOn |
Gets or sets the Created On Date for this resource |
date |
None. |
| ChangedOn |
Gets or sets the Changed On Date for this resource |
date |
None. |
| AuditNote |
Gets or sets the Audit Note for this resource |
string |
None. |
| Active |
Gets or sets the Active status for this resource |
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
{
"url": "sample string 5",
"id": 6,
"name": "sample string 2",
"isGlobal": true,
"maxAmount": 1.0,
"maxAmountQualifier": 0,
"maxAmountTimePeriod": 0,
"maxAmountTimePeriodStartDate": "2025-05-30T20:50:53.1563665-05:00",
"maxAmountTimePeriodEndDate": "2025-05-30T20:50:53.1563665-05:00",
"maxAmountTimePeriodUnits": "sample string 3",
"effectiveEndDate": "2025-05-30T20:50:53.1563665-05:00",
"effectiveStartDate": "2025-05-30T20:50:53.1563665-05:00",
"createdOn": "2025-05-30T20:50:53.1563665-05:00",
"changedOn": "2025-05-30T20:50:53.1563665-05:00",
"auditNote": "sample string 4",
"active": true
}