POST api/formularies/{formularyid}/formularycompanyagelimits

Posts a new Formulary Company Age Limit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
formularyid

The id of the formulary for which age limits

integer

Required

Body Parameters

FormularyCompanyAgeLimitModel
NameDescriptionTypeAdditional information
CompanyAgeLimitNo

Gets or sets the value indicating whether this formulary age limit is inheriting from a global/company-level age limit.

integer

None.

CompanyAgeLimitUrl

Gets the url where the global/company-level age 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.

MinAge

Gets or sets the Min Age of the age limit resource

integer

None.

MinAgeQualifier

Gets or sets the Min Age Qualifier of the age limit resource D=Days, Y=Years

string

None.

MaxAge

Gets or sets the Max Age of the age limit resource

integer

None.

MaxAgeQualifier

Gets or sets the Max Age Qualifier of the age limit resource D=Days, Y=Years

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 age 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

Sample:
{
  "url": "sample string 6",
  "id": 7,
  "companyAgeLimitNo": 1,
  "companyAgeLimitUrl": "sample string 1",
  "productID": "sample string 2",
  "productIDType": "sample string 3",
  "minAge": 1,
  "minAgeQualifier": "sample string 4",
  "maxAge": 1,
  "maxAgeQualifier": "sample string 5",
  "effectiveStartDate": "2025-05-30T21:39:17.4479281-05:00",
  "effectiveEndDate": "2025-05-30T21:39:17.4479281-05:00",
  "active": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The newly created Formulary Company Age Limit object

FormularyCompanyAgeLimitModel
NameDescriptionTypeAdditional information
CompanyAgeLimitNo

Gets or sets the value indicating whether this formulary age limit is inheriting from a global/company-level age limit.

integer

None.

CompanyAgeLimitUrl

Gets the url where the global/company-level age 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.

MinAge

Gets or sets the Min Age of the age limit resource

integer

None.

MinAgeQualifier

Gets or sets the Min Age Qualifier of the age limit resource D=Days, Y=Years

string

None.

MaxAge

Gets or sets the Max Age of the age limit resource

integer

None.

MaxAgeQualifier

Gets or sets the Max Age Qualifier of the age limit resource D=Days, Y=Years

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 age 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

Sample:
{
  "url": "sample string 6",
  "id": 7,
  "companyAgeLimitNo": 1,
  "companyAgeLimitUrl": "sample string 1",
  "productID": "sample string 2",
  "productIDType": "sample string 3",
  "minAge": 1,
  "minAgeQualifier": "sample string 4",
  "maxAge": 1,
  "maxAgeQualifier": "sample string 5",
  "effectiveStartDate": "2025-05-30T21:39:17.4479281-05:00",
  "effectiveEndDate": "2025-05-30T21:39:17.4479281-05:00",
  "active": true
}