Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Add-on Code

Accounting Code

Restriction

Implemented in Production

OEM 3 Document Pack, 48 months, billed every 48 months

oem-a-1-48-48

oem-a-1-48-48

No

OEM 5 Document Pack, 48 months, billed every 48 months

oem-a-2-48-48

oem-a-2-48-48

No

OEM 10 Document Pack, 48 months, billed every 48 months

oem-a-3-48-48

oem-a-3-48-48

No

OEM 20 Document Pack, 48 months, billed every 48 months

oem-a-4-48-48

oem-a-4-48-48

No

OEM 30 Document Pack, 48 months, billed every 48 months

oem-a-5-48-48

oem-a-5-48-48

No

Add-On Restrictions

...

In order for customers to be able to use (via the UI or APIs) Authority Documents (or other entities) that are part of an entitled add-on with restriction, we have to add rows to the entity_entitlements table of the CCH database as a new Authority Document (or other targeted entities) is published. Adding a restriction to an entity will only prevent it from being directly accessed via API and will not prevent it from appearing inside of other responses. CCH only supports restrictions for Authority Documents at the moment.

...

restriction = stateAgencyArizona

OEM Vendor Restrictions

In order for OEM Vendors to be able to use Authority Documents (or other entities), we have to add rows to the entity_singular_entitlements table of the CCH database as a new Authority Document (or other targeted entities) is published. Adding a restriction to an entity will only prevent it from being directly accessed via API and will not prevent it from appearing inside of other responses. CCH only supports restrictions for Authority Documents at the moment.

Table structure for entity_singular_entitlements:

Column

Type

Example Value(s)

class_name

string

Db_Entity_AuthorityDocument

entity_id

integer

The ID of the entity

account_id

integer

The ID of the vendor account

Example:

To restrict Authority Document 1234 to Arizona, add the following to the entity_entitlements table:

class_name = Db_Entity_AuthorityDocument

entity_id = 1234

account_id = 12345