Entities

1. Annotation
2. Annotation Item
3. Annotation Item Response
4. Annotation Tag
5. Course Section
6. Entitlement
7. Learning Resource
8. Learning Resource Segment
9. Person

Annotation

This entity is required.

Entity filename: annotation.csv.

A web resource with a body, which is a comment or other descriptive resource, and a single target that the body is somehow about.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Annotation.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Annotation, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text
learning_resource_id	The Learning resource in which the Annotation was first generated. See Learning Resource.	No	Yes	integer
course_section_id	The Course section context in which the Annotation was made, if any. See Course Section.	No	Yes	integer
author_id	The Person record who originally authored the Annotation. See Person.	No	Yes	integer
type	The type of Annotation (`Note`, `Question`, `Answer`, `Highlight`, `Comment`).	Yes	No	text
target	The target of the Annotation.	No	No	text
body_value	The contents of the Annotation's body.	No	No	text
body_language	The language in which the Body value is written, in ISO 639-1 format (e.g., `en`, `fr`, `de`).	No	No	text
body_format	The IANA media type format of the Body value. A written comment is generally `text/plain`, but other systems may support, for example, voice recordings that are of `audio/mp3` format.	No	No	text
color	The color of the Annotation.	No	No	text
status	The status of the Annotation (`Active`, `Deleted`).	No	No	text
page_number	The page number on which the Annotation was made, if any.	No	No	text
created_date	The date on which the Annotation was originally created.	No	No	timestamp
updated_date	The date on which the Annotation was last updated.	No	No	timestamp

top

Annotation Item

This entity is required.

Entity filename: annotation_item.csv.

An item, attached to an Annotation, which itself may be the object of a teaching or learning interaction.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Annotation Item.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Annotation Item, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text
annotation_id	The Annotation Id that is a question. See Annotation.	No	Yes	integer
body_value	The content of the question body.	No	No	text

top

Annotation Item Response

This entity is required.

Entity filename: annotation_item_response.csv.

A response to an Annotation item.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Annotation Item Response.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Annotation Item Response, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text
annotation_id	The Annotation that is an answer. See Annotation.	No	Yes	integer
annotation_item_id	The Annotation to which the answer is given. See Annotation Item.	No	Yes	integer
body_value	The content of the answer body.	No	No	text

top

Annotation Tag

This entity is required.

Entity filename: annotation_tag.csv.

A keyword or term that describes an Annotation to enable searching or group related Annotations.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Annotation Tag.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Annotation Tag, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text
title	The title or text of the tag.	No	No	text
annotation_id	The Annotation to which the Annotation tag is applied. See Annotation.	No	Yes	integer
created_date	The date on which the tag was originally created.	No	No	timestamp

top

Course Section

This entity is required.

Entity filename: course_section.csv.

An administrative and instructional sub-organization of a Course offering. Instructors may be assigned to one or more sections of a particular Course offering.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Course Section.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Course Section, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text

top

Entitlement

This entity is required.

Entity filename: entitlement.csv.

The guarantee of access to Learning resources based on established rights.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Entitlement.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Entitlement, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text
learning_resource_id	The Learning resource to be associated with a Person. See Learning Resource.	No	Yes	integer
person_id	The Person who has a relationship with the Learning resource. See Person.	No	Yes	integer
course_section_id	The Course section context in which the Entitlement is delivered, if any. See Course Section.	No	Yes	integer
role	The Role in which the Person acts in the Course section context, if any. (option set)	No	No	text
offer_type	The type of offer purchased by the Person to access the Learning resource (Individual, Subscription, AllInclusive).	No	No	text
duration_type	The length of time in which the Person is entitled to the Learning resource (Term, Rental, Career, Endless).	No	No	text
begin_date	The date on which the Entitlement begins, if any.	No	No	timestamp
end_date	The date on which the Entitlement ends, if any.	No	No	timestamp
status	The current status of the relationship between the Person and Learning resource (Active, Deleted)	No	No	text
created_date	The date on which the Entitlement was first created.	No	No	timestamp
updated_date	The date on which the Entitlement was last updated.	No	No	timestamp

top

Learning Resource

This entity is required.

Entity filename: learning_resource.csv.

A piece of content, such as a textbook, that can be used in aid of learning.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Learning Resource.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Learning Resource, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text
title	The title of the Learning resource.	No	No	text
print	The ISBN used for a Learner resource if and when it is offered with print entitlement.	No	No	text
digital_purchase	The ISBN used for a Learner resource if and when it is offered with digital purchase entitlement.	No	No	text
digital_rental	The ISBN used for a Learner resource if and when it is offered with digital rental entitlement.	No	No	text
all_inclusive	The ISBN used for a Learner resource if and when it is offered with an all-inclusive access entitlement.	No	No	text
file_format	The IANA media type format of the Learning resource.	No	No	text

top

Learning Resource Segment

This entity is required.

Entity filename: learning_resource_segment.csv.

A conceptual portion of a Learning resource, such as a chapter.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Learning Resource Segment.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Learning Resource Segment, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text
learning_resource_id	The Learning resource of which the Learning resource segment is a part. See Learning Resource.	No	Yes	integer
parent_learning_resource_segment_id	The parent learning resource segment of the current segment (e.g., if the segment is a section, its parent might be a chapter), if any. See Learning Resource Segment.	No	Yes	integer
begins_at	The location (such as page number) at which the Learner resource segment begins.	No	No	timestamp
ends_at	The location (such as page number) at which the Learner resource segment ends.	No	No	timestamp
name	The name of the Learning resource segment (such as a chapter title).	No	No	text
created_date	The date on which the Learning resource segment was first created.	No	No	timestamp
updated_date	The date on which the Learning resource segment was last updated.	No	No	timestamp

top

Person

This entity is required.

Entity filename: person.csv.

An individual participating, in any capacity, in the design, delivery, or evaluation of teaching and learning processes and environments.

Code (Header)	Description	Is required	Is foreign key	Datatype
ereader_int_id	The key used within the EREADER to identify this Person.	Yes	No	text
ereader_ext_id	The global key generated by this EREADER to identify this Person, for use by external tools that are provisioned or launched from the EREADER.	Yes	No	text

top