ConsumerType

Overview

This entity is used to help understand the device was used to access an itslearning course ('Course') or content within the course ('CourseElement'). This allows tracking of desktop (PC, Mac, etc) or mobile sessions.

Which consumer type are included?

This entity is included for all courses or course element sessions. If missing, then the session was before we started tracking the (this measure was introduced in 2017).

Usage in itslearning

This entity does not appear in the itslearning user interface. It is used by the Course or CourseElement entity to determine the type of device used to access the course or course element. The values can be one of the following:

'Other'
'MobileAppPersonalApi'
'MobileAppWebView',
'Web'

Web: Access by a browser, such as Chrome on PC or Safari on Mac.

MobileAppPersonalApi: Access to itslearnings' data endpoints by the native mobile app, usually not seen when tracking sessions

'MobileAppWebView': Access through a web view on a mobile app (usually through our app).

Other denotes that we could not determine the user's device (or it was deliberately hidden).

Note - to get a total for mobile session. Count both to get a total number of mobile access.

Relationships

UserCourseSession - Course access session are from web or mobile.
UserElementSession - Course content sessions are from web or mobile.

Entity Details

Name

Data type

Nullable

Description

ConsumerTypeId

Edm.Int32

false

Id of a consumer type

ConsumerTypeTitle

Edm.String

Consumer type title, one of:

'Other'
'MobileAppPersonalApi'
'MobileAppWebView',
'Web'

T_ModifiedDate

End.DateTime

false

Date and time the entity was last modified in data warehouse

Diagram

Request body

URI

https://reporting.itslearning.com/odata/engine7/ConsumerTypes

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" xml
ns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml">
  <id>http://schemas.datacontract.org/2004/07/</id>
  <title />
  <updated>2018-04-23T12:57:32Z</updated>
  <link rel="self" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes" />
  <entry>
    <id>https://reporting.itslearning.com/odata/engine7/ConsumerTypes(1)</id>
    <category term="Itslearning.Reporting.Data.Models.ConsumerType" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(1)" />
    <link rel="self" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(1)" />
    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/UserCourseSessions" type="application/atom+xml;type=feed" title="UserCourseSessions" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(1)/UserCour
seSessions" />
    <title />
    <updated>2018-04-23T12:57:32Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:ConsumerTypeId m:type="Edm.Int32">1</d:ConsumerTypeId>
        <d:ConsumerTypeTitle>Other</d:ConsumerTypeTitle>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reporting.itslearning.com/odata/engine7/ConsumerTypes(2)</id>
    <category term="Itslearning.Reporting.Data.Models.ConsumerType" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(2)" />
    <link rel="self" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(2)" />
    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/UserCourseSessions" type="application/atom+xml;type=feed" title="UserCourseSessions" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(2)/UserCour
seSessions" />
    <title />
    <updated>2018-04-23T12:57:32Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:ConsumerTypeId m:type="Edm.Int32">2</d:ConsumerTypeId>
        <d:ConsumerTypeTitle>Mobile</d:ConsumerTypeTitle>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reporting.itslearning.com/odata/engine7/ConsumerTypes(3)</id>
    <category term="Itslearning.Reporting.Data.Models.ConsumerType" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(3)" />
    <link rel="self" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(3)" />
    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/UserCourseSessions" type="application/atom+xml;type=feed" title="UserCourseSessions" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(3)/UserCour
seSessions" />
    <title />
    <updated>2018-04-23T12:57:32Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:ConsumerTypeId m:type="Edm.Int32">3</d:ConsumerTypeId>
        <d:ConsumerTypeTitle>Mobile</d:ConsumerTypeTitle>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reporting.itslearning.com/odata/engine7/ConsumerTypes(4)</id>
    <category term="Itslearning.Reporting.Data.Models.ConsumerType" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(4)" />
    <link rel="self" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(4)" />
    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/UserCourseSessions" type="application/atom+xml;type=feed" title="UserCourseSessions" href="https://reporting.itslearning.com/odata/engine7/ConsumerTypes(4)/UserCour
seSessions" />
    <title />
    <updated>2018-04-23T12:57:32Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:ConsumerTypeId m:type="Edm.Int32">4</d:ConsumerTypeId>
        <d:ConsumerTypeTitle>Web</d:ConsumerTypeTitle>
      </m:properties>
    </content>
  </entry>
</feed>

Response body - JSON (default output format)

JSON response

{
  "odata.metadata":"https://reporting.itslearning.com/odata/engine7/$metadata#ConsumerTypes","value":[
    {
      "ConsumerTypeId":1,"ConsumerTypeTitle":"Other"
    },{
      "ConsumerTypeId":2,"ConsumerTypeTitle":"Mobile"
    },{
      "ConsumerTypeId":3,"ConsumerTypeTitle":"Mobile"
    },{
      "ConsumerTypeId":4,"ConsumerTypeTitle":"Web"
    }
  ]
}