Short Description: Each account can create one to many lists of Authority Documents (including private Authority Documents).
Long Description: Authority Document Lists (AD Lists for short) are groupings of various Authority Documents.
AD Lists are owned by users, but can be assigned to both groups and initiatives.
This element connects to the following elements:
Informational Links:
JSON Calls documentation:
This element is comprised of the following fields:
| Field | Type | Description |
|---|---|---|
| _href | string | The URL to request that document from the API. |
| id | integer | ID of the record |
| date_created | date | The date the record was created. |
| date_updated | date | The date the record was updated. |
| account.href | URL | The URL to get the account's information. |
| account.id | integer | ID of the account record. |
| active_status | string | The status of the list. 'A' = active. 'D' = deprecated. |
| authority_documents._href | URL | URL to get the list's Authority Document from. |
| check_digit | integer | 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. |
| creator._href | URL | URL to get the user who created the list. |
| creator.id | integer | The ID of the user who created the list. |
| groups._href | URL | URL to get the list's groups from. |
| name | string | The record’s name derived from the harmonized dictionary term assigned to the record. |
| initiatives._href | URL | URL to get the list's initiative information from. |
