PATCH api/globalcompanydiagnosiscodelimits/{id}

Patches an existing Global Company Diagnosis Code Limit object

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Diagnosis Code Limit identifier

integer

Required

Body Parameters

The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target global company diagnosis code limit object

JsonPatchDocument
NameDescriptionTypeAdditional information
Operations

Collection of Operation

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/json-patch+json

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A patched Global Company Diagnosis Code Limit object

CompanyDiagnosisCodeLimitModel
NameDescriptionTypeAdditional information
Name

Gets or sets the description of the diagnosis code limit resource

string

None.

isGlobal

Gets or sets whether this is a global diagnosis code limit resource (true if Global, false if Formulary-level) Obsolete - will be removed at a later date

boolean

None.

CreatedOn

Gets or sets the datetime when the diagnosis code limit was created

date

None.

AuditNote

Gets or sets the value indicating (for audit purposes) why the most current change was made

string

None.

Active

Gets or sets the value indicating whether this diagnosis code limit is currently active.

boolean

None.

DxCodes

Collection of CompanyDiagnosisCodeLimitDxCodeModel

None.

EffectiveStartDate

Gets or sets the Effective Start Date of the formulary level resource

date

None.

EffectiveEndDate

Gets or sets the Effective End Date of the formulary resource

date

None.

ProductID

Gets or sets the product ID for the formulary level 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 the formulary level 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.

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,
  "name": "sample string 2",
  "isGlobal": true,
  "createdOn": "2025-05-30T20:47:09.6947599-05:00",
  "auditNote": "sample string 3",
  "active": true,
  "dxCodes": [
    {
      "url": "sample string 5",
      "id": 0,
      "seqNo": 1,
      "companyDiagnosisCodeLimitSeqNo": 2,
      "diagnosisCode": "sample string 3",
      "diagnosisCodeType": "sample string 4",
      "isActive": true,
      "createdOn": "2025-05-30T20:47:09.6947599-05:00",
      "changedOn": "2025-05-30T20:47:09.6947599-05:00"
    },
    {
      "url": "sample string 5",
      "id": 0,
      "seqNo": 1,
      "companyDiagnosisCodeLimitSeqNo": 2,
      "diagnosisCode": "sample string 3",
      "diagnosisCodeType": "sample string 4",
      "isActive": true,
      "createdOn": "2025-05-30T20:47:09.6947599-05:00",
      "changedOn": "2025-05-30T20:47:09.6947599-05:00"
    }
  ],
  "effectiveStartDate": "2025-05-30T20:47:09.6947599-05:00",
  "effectiveEndDate": "2025-05-30T20:47:09.6947599-05:00",
  "productID": "sample string 4",
  "productIDType": "sample string 5"
}