Term

Overview

This is a dimension entity which provides basic information about terms.

Terms help define the date period for a course. Examples are autumn/spring/summer term, semesters, quarters, or trimesters. Terms must be established prior to using the grade book, and can be associated with courses and with assessments. If integrating with a student information system, the terms may be created during integration.

Term are managed by the system administrator at the site (customer) level.

Which 'terms' are included in the Data Warehouse?

  • This entity includes all the terms used in the application, created for different organisations or for the whole site.

  • The entity shows the latest version of each term.

Usage in itslearning

Terms are set-up at the site (customer) level. Terms are important for structuring the dates over which courses run. A course can be associated with one or more terms.

Term Management in itslearning

images/download/attachments/284208358/image2018-7-14_16_20_55.png

images/download/attachments/284208358/image2018-7-14_16_20_55.png

Relationships

  • Organisation (an organization can have one or more terms)

  • LearningItem (an assessment item can be associated with a term)

Diagram

images/download/attachments/284208358/Term.PNG

Entity Details


Name

Data type

Nullable

Description

Name

Data type

Nullable

Description

TermId

Edm.Int32

false

Id of a term

TermName

Edm.String


Term name

TermDescription

Edm.String


Term description

OrganizationId

Edm.Int32

false

Id of an organization

StartDate

Edm.DateTime

false

Start date of a term

EndDate

Edm.DateTime

false

End date of a term

TermStatus

Edm.String


Status information if the term is active

ExternalTermId

Edm.String


External id for a term

T_ModifiedDate

Edm.DateTime

false

Date and time the entity was last modified in data warehouse


Request body


URI
https://reporting.itslearning.com/odata/engine7/Terms?$top=10

Response body - XML


XML response
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reporting.itslearning.com/odata/engine7" xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices
/metadata" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml">
<id>http://schemas.datacontract.org/2004/07/</id>
<title />
<updated>2017-08-29T13:51:59Z</updated>
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms" />
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(-1)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(-1)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(-1)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(-1)/Organization
" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(-1)/LearningIte
ms" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">-1</d:TermId>
<d:TermName>No term</d:TermName>
<d:TermDescription>No description</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">1</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">1900-01-01T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">1900-01-01T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(1)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(1)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(1)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(1)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(1)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">1</d:TermId>
<d:TermName>Sven Term December</d:TermName>
<d:TermDescription>Sven Term December</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">14</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-12-01T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2010-12-31T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(2)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(2)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(2)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(2)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(2)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">2</d:TermId>
<d:TermName>Marthas term</d:TermName>
<d:TermDescription>Marthas term</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">26</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-09-01T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2010-12-31T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(3)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(3)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(3)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(3)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(3)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">3</d:TermId>
<d:TermName>Martha - Haust</d:TermName>
<d:TermDescription>Haust</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">26</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-08-01T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2010-12-31T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(4)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(4)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(4)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(4)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(4)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">4</d:TermId>
<d:TermName>RM Term1</d:TermName>
<d:TermDescription>asda</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">29</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-11-01T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2010-11-30T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(5)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(5)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(5)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(5)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(5)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">5</d:TermId>
<d:TermName>RM Term2</d:TermName>
<d:TermDescription xml:space="preserve">asdas </d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">30</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-12-01T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2010-12-31T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(6)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(6)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(6)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(6)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(6)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">6</d:TermId>
<d:TermName>Martha V??r</d:TermName>
<d:TermDescription>V??r</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">26</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-01-01T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2010-07-01T00:00:00</d:EndDate>
<d:TermStatus>Deleted</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(7)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(7)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(7)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(7)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(7)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">7</d:TermId>
<d:TermName>SchoolA</d:TermName>
<d:TermDescription>h</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">20</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-10-01T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2010-12-31T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(8)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(8)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(8)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(8)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(8)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">8</d:TermId>
<d:TermName>RM term</d:TermName>
<d:TermDescription>dffafa</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">1</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-11-30T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2011-01-09T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reporting.itslearning.com/odata/engine7/Terms(9)</id>
<category term="Itslearning.Reporting.Data.Models.Term" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" href="https://reporting.itslearning.com/odata/engine7/Terms(9)" />
<link rel="self" href="https://reporting.itslearning.com/odata/engine7/Terms(9)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Organization" type="application/atom+xml;type=entry" title="Organization" href="https://reporting.itslearning.com/odata/engine7/Terms(9)/Organization"
/>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LearningItems" type="application/atom+xml;type=feed" title="LearningItems" href="https://reporting.itslearning.com/odata/engine7/Terms(9)/LearningItem
s" />
<title />
<updated>2017-08-29T13:51:59Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:TermId m:type="Edm.Int32">9</d:TermId>
<d:TermName>schoolB</d:TermName>
<d:TermDescription>schoolB</d:TermDescription>
<d:OrganizationId m:type="Edm.Int32">23</d:OrganizationId>
<d:StartDate m:type="Edm.DateTime">2010-09-02T00:00:00</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2010-12-31T00:00:00</d:EndDate>
<d:TermStatus>Active</d:TermStatus>
<d:ExternalTermId m:null="true" />
</m:properties>
</content>
</entry>
</feed>


Response body - JSON (default output format)


JSON response
{
"odata.metadata":"https://reporting.itslearning.com/odata/engine7/$metadata#Terms","value":[
{
"TermId":-1,"TermName":"No term","TermDescription":"No description","OrganizationId":1,"StartDate":"1900-01-01T00:00:00","EndDate":"1900-01-01T00:00:00","TermStatus":"Active","ExternalTermId":null
},{
"TermId":1,"TermName":"Sven Term December","TermDescription":"Sven Term December","OrganizationId":14,"StartDate":"2010-12-01T00:00:00","EndDate":"2010-12-31T00:00:00","TermStatus":"Active","ExternalTermId":null
},{
"TermId":2,"TermName":"Marthas term","TermDescription":"Marthas term","OrganizationId":26,"StartDate":"2010-09-01T00:00:00","EndDate":"2010-12-31T00:00:00","TermStatus":"Active","ExternalTermId":null
},{
"TermId":3,"TermName":"Martha - Haust","TermDescription":"Haust","OrganizationId":26,"StartDate":"2010-08-01T00:00:00","EndDate":"2010-12-31T00:00:00","TermStatus":"Active","ExternalTermId":null
},{
"TermId":4,"TermName":"RM Term1","TermDescription":"asda","OrganizationId":29,"StartDate":"2010-11-01T00:00:00","EndDate":"2010-11-30T00:00:00","TermStatus":"Active","ExternalTermId":null
},{
"TermId":5,"TermName":"RM Term2","TermDescription":"asdas ","OrganizationId":30,"StartDate":"2010-12-01T00:00:00","EndDate":"2010-12-31T00:00:00","TermStatus":"Active","ExternalTermId":null
},{
"TermId":6,"TermName":"Martha V\u00e5r","TermDescription":"V\u00e5r","OrganizationId":26,"StartDate":"2010-01-01T00:00:00","EndDate":"2010-07-01T00:00:00","TermStatus":"Deleted","ExternalTermId":null
},{
"TermId":7,"TermName":"SchoolA","TermDescription":"h","OrganizationId":20,"StartDate":"2010-10-01T00:00:00","EndDate":"2010-12-31T00:00:00","TermStatus":"Active","ExternalTermId":null
},{
"TermId":8,"TermName":"RM term","TermDescription":"dffafa","OrganizationId":1,"StartDate":"2010-11-30T00:00:00","EndDate":"2011-01-09T00:00:00","TermStatus":"Active","ExternalTermId":null
},{
"TermId":9,"TermName":"schoolB","TermDescription":"schoolB","OrganizationId":23,"StartDate":"2010-09-02T00:00:00","EndDate":"2010-12-31T00:00:00","TermStatus":"Active","ExternalTermId":null
}
]
}