Short Description: The various roles associated with the account and assigned to users.
Long Description: These Roles are synonymous with the UCF's Roles element - except that they've been imported in to the CCH and assigned to various Users.
This element connects to the following elements:
Informational Links:
JSON Calls documentation:
This element is comprised of the following fields:
| Field | Type | Description | ||
|---|---|---|---|---|
| _href | JSON Reference | string | 0 | The URL to request that document from the API. |
| id | CCH Structure | integer | 0 | ID of the record. |
| date_created | Content | date | 0 | The date the record was created. |
| time_created | UCF Structure | string | The date and time the record was created. | |
| time_updated | UCF Structure | string | The date and time the record was last updated. | |
| account.id | CCH Structure | integer | ID of the account record. | |
| check_digit | CCH Structure | integer | 0 | We humans have to use numbers. However, when entering numbers, we humans also have a tendency to screw up the entry or copying of those numbers. A Dutch mathematician named Jacobus Verhoeff conducted a study of 12,000 numerical errors J. Verhoeff, Error Detecting Decimal Codes, Mathematical Centre Tract 29, The Mathematical Centre, Amsterdam, 1969, cited in Wagner and Putter, "Error Detecting Decimal Digits", CACM, Vol 32, No. 1 (January 1989), pp. 106-110. and from that, proposed a check digit calculation scheme http://www.augustana.ab.ca/~mohrj/algorithms/checkdigit.html#verhoeff that catches all single errors as well as all adjacent transpositions and most other errors. To ensure that the IDs assigned by the system have integrity during input as well as distribution while being transferred into various formats (such as Excel, Word, Text, XML), each ID will also have its own checksum value stored in a checksum field. Currently, the methodology for creating and verifying the checksum follows the Verhoeff calculation format. The CheckDigit is created along with the record's ID as a calculation by the UCF database system. As such, once assigned it should never change because the ID will never change. A sample calculation format is shown in the use case scenarios. |
| name | string | The record's name derived from the harmonized dictionary term assigned to the record. | ||
| account._href | JSON Reference | URL | 0 | URL to get the list's account information from. |
| description | Content | string | This is a CSS formatted HTML entry containing the Authority Document's Official Name, it's ID, availability, the current number of citations associated with it, and when it was last reviewed and released. | |
| role.id | CCH Structure | integer | ID of the record | |
| user._href | JSON Reference | URL | 0 | URL to get the list's user information from. |
| user.id | CCH Structure | integer | ID of the user associated with this record. | |
| date_added | UCF Structure | string | Date_Added is a date stamp for when the record was created. This element is created when the record is entered into the UCF's Master Content database and not the working database. We chose this method because the UCF team's editorial process is a fluid one which allows, during the editing process, for records to be added, moved, deleted, or even “un-deleted” fluidly until the lock-date that ends the editorial process. Once the lock-date has been reached, all of the records are then finalized from the “working” list and uploaded as a batch to the Master Content database, which also triggers the change log process. Therefore, it is common to see all new records for any given quarter being added on the same date. Because the Date Added element is controlled post-editorial process, the UCF database system manages everything automatically. | |
| term.id | UCF Structure | Integer | ID of the associated term for this record. | |
| dotted_line_reports_to.id | UCF Structure | Integer | ID of the associated dotted line reports to for this record. | |
| position_type | Content | string | Position Type is a classification that defines the level of responsibility a role has within an organization. The choices are none, day to day role, managerial oversight, and executive oversight. | |
| reports_to.id | UCF Structure | Integer | ID of the associated reports to for this record. |