POST api/formularies/{formularyid}/formularycompanygenderlimits
Posts a new Formulary Company Gender Limit
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| formularyid |
The id of the formulary for which gender limits |
integer |
Required |
Body Parameters
FormularyCompanyGenderLimitModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyGenderLimitNo |
Gets or sets the value indicating whether this formulary gender limit is inheriting from a global/company-level gender limit. |
integer |
None. |
| CompanyGenderLimitUrl |
Gets the url where the global/company-level gender limit resource can be found |
string |
None. |
| 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 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. |
| Gender |
Gets or sets the Gender value for this resource. This should be an 'M' or an 'F'. |
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. |
| Active |
Gets or sets the value indicating whether this gender 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. |
Request Formats
application/json, text/json, application/json-patch+json
{
"url": "sample string 5",
"id": 6,
"companyGenderLimitNo": 1,
"companyGenderLimitUrl": "sample string 1",
"productID": "sample string 2",
"productIDType": "sample string 3",
"gender": "sample string 4",
"effectiveStartDate": "2025-05-30T21:19:44.8306503-05:00",
"effectiveEndDate": "2025-05-30T21:19:44.8306503-05:00",
"active": true
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The newly created Formulary Company Gender Limit object
FormularyCompanyGenderLimitModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyGenderLimitNo |
Gets or sets the value indicating whether this formulary gender limit is inheriting from a global/company-level gender limit. |
integer |
None. |
| CompanyGenderLimitUrl |
Gets the url where the global/company-level gender limit resource can be found |
string |
None. |
| 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 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. |
| Gender |
Gets or sets the Gender value for this resource. This should be an 'M' or an 'F'. |
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. |
| Active |
Gets or sets the value indicating whether this gender 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
{
"url": "sample string 5",
"id": 6,
"companyGenderLimitNo": 1,
"companyGenderLimitUrl": "sample string 1",
"productID": "sample string 2",
"productIDType": "sample string 3",
"gender": "sample string 4",
"effectiveStartDate": "2025-05-30T21:19:44.8306503-05:00",
"effectiveEndDate": "2025-05-30T21:19:44.8306503-05:00",
"active": true
}