Domoscio Viz Engine (v2.2.0)

We designed the Domoscio Visualization Engine in a Restful way, so that your user experience is simple and straightforward.

You will find in this documentation all the information necessary to interact with it.

Authentication

The workflow to authentify is based on Oauth2 protocol. To have access to Domoscio functionalities the user should follow these steps:

  • AuthorizationToken:

    The AuthorizationToken is given to the user when he starts working with the Domoscio API. This token must remain secret.

    1. The AuthorizationToken should be used inside the Header of the request when calling the API for the first time & when the RefreshToken expires:
      Authorization: Bearer < AuthorizationToken >

    2. Inside the response Header, the AccessToken and RefreshToken will be given:
      AccessToken: < AccessToken >
      RefreshToken: < RefreshToken >

    3. The RefreshToken should now be used in the header of the API request with the AccessToken. Here is an example on how to retrieve the AccessToken & RefreshToken:

  • Note: You will receive the AccessToken in the response at every request. However, when the RefreshToken is expired, you will receive a 401 error. At this point, it will be necessary to reuse the AuthenticationToken to retrieve a new pair of RefreshToken / AccessToken.

Header Parameters

When making the requests to the Visualization Engine, you will need to specify the following parameters in the header:

  • ClientId: The client ID given to you by Domoscio.
  • Authorization: The AuthorizationToken when calling the engine for the first time.
  • RefreshToken & AccessToken: The tokens retrieved after the first call.
  • User-Agent: The agent from which you are making the requests.

Request Process

MemorizeClassRoomDatatable

The MemorizeClassRoomDatatable shows for each student whether they are up to date with their reviews. The table is represented in the image below:

MemorizeClassRoomDatatable

In order to obtain the MemorizeClassRoomDatatable iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters
ClientId
required
integer
Example: 5

The client ID given to you by Domoscio.

Authorization
required
string
Example: Token token=given_token

The AuthorizationToken when calling the engine for the first time.

AccessToken
required
string

The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.

RefreshToken
required
string

The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.

User-Agent
required
string
Example: PostmanRuntime/7.26.8

The agent from which you are making the requests.

Request Body schema: application/json
required
integer or Array of integers (Student_id)

Scope the statistics with specific Student ID(s). Required if no student_uid is given.

required
string or Array of strings (Student_uid)

Scope the statistics with a set of Student UID(s). Required if no student_id is given.

required
integer or Array of integers (Objective_id)

Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.

required
string or Array of strings (Objective_uid)

Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.

student_ids
Array of integers (Student_ids)
Deprecated

An array of Student IDs for which you wish to fetch data.

objective_ids
Array of integers (Objective_ids)
Deprecated

An array of Objective IDs for which you wish to fetch data.

locale
string (Locale)
Enum: "fr" "en" "es"

The language in which the tables and graphs labels should be displayed.

primary_color
string (Primary_color)

The primary color for the graph/table, you should use the hexcolor format without the '#' sign.

secondary_color
string (Secondary_color)

The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Content type
application/json
{
  • "objective_uid": [
    ],
  • "student_uid": [
    ],
  • "locale": "en",
  • "primary_color": "04accc",
  • "secondary_color": "113240"
}

Response samples

Content type
application/json

StudentsDatatableMemorize

The StudentsDatatableMemorize summarizes for each student, their activities, the average time spent on each session, their success rates, and their knowledge retention levels. The table is represented in the image below:

StudentsDatatableMemorize

In order to obtain the StudentsDatatableMemorize iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters
ClientId
required
integer
Example: 5

The client ID given to you by Domoscio.

Authorization
required
string
Example: Token token=given_token

The AuthorizationToken when calling the engine for the first time.

AccessToken
required
string

The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.

RefreshToken
required
string

The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.

User-Agent
required
string
Example: PostmanRuntime/7.26.8

The agent from which you are making the requests.

Request Body schema: application/json
required
integer or Array of integers (Student_id)

Scope the statistics with specific Student ID(s). Required if no student_uid is given.

required
string or Array of strings (Student_uid)

Scope the statistics with a set of Student UID(s). Required if no student_id is given.

required
integer or Array of integers (Objective_id)

Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.

required
string or Array of strings (Objective_uid)

Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.

student_ids
Array of integers (Student_ids)
Deprecated

An array of Student IDs for which you wish to fetch data.

objective_ids
Array of integers (Objective_ids)
Deprecated

An array of Objective IDs for which you wish to fetch data.

locale
string (Locale)
Enum: "fr" "en" "es"

The language in which the tables and graphs labels should be displayed.

primary_color
string (Primary_color)

The primary color for the graph/table, you should use the hexcolor format without the '#' sign.

secondary_color
string (Secondary_color)

The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Content type
application/json
{
  • "objective_uid": [
    ],
  • "student_uid": [
    ],
  • "locale": "en",
  • "primary_color": "04accc",
  • "secondary_color": "113240"
}

Response samples

Content type
application/json

EventHistory

The EventHistory graph summarizes the number of events that happend since a specific date for each month. The graph is represented in the image below:

EventHistory

In order to obtain the EventHistory iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters
ClientId
required
integer
Example: 5

The client ID given to you by Domoscio.

Authorization
required
string
Example: Token token=given_token

The AuthorizationToken when calling the engine for the first time.

AccessToken
required
string

The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.

RefreshToken
required
string

The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.

User-Agent
required
string
Example: PostmanRuntime/7.26.8

The agent from which you are making the requests.

Request Body schema: application/json
required
integer or Array of integers (Student_id)

Scope the statistics with specific Student ID(s). Required if no student_uid is given.

required
string or Array of strings (Student_uid)

Scope the statistics with a set of Student UID(s). Required if no student_id is given.

required
integer or Array of integers (Objective_id)

Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.

string or Array of strings (Objective_uid)

Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.

student_ids
Array of integers (Student_ids)
Deprecated

An array of Student IDs for which you wish to fetch data.

objective_ids
Array of integers (Objective_ids)
Deprecated

An array of Objective IDs for which you wish to fetch data.

string or boolean (Event_type)
Enum: "EventRead" "EventReview" "EventResult" false

The type of event for which you wish to get a graph/datatable, set to false if you don't wish to specify.

date_start
required
string <date> (Date_start)

The date from which you wish to display the events.

locale
string (Locale)
Enum: "fr" "en" "es"

The language in which the tables and graphs labels should be displayed.

primary_color
string (Primary_color)

The primary color for the graph/table, you should use the hexcolor format without the '#' sign.

secondary_color
string (Secondary_color)

The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Content type
application/json
{
  • "objective_uid": [
    ],
  • "student_uid": [
    ],
  • "date_start": "2020-03-25",
  • "event_type": "EventReview",
  • "locale": "en",
  • "primary_color": "04accc",
  • "secondary_color": "113240"
}

Response samples

Content type
application/json

AverageMemorization

The AverageMemorization summarizes for each subtopic the level of knowledge retention for a specific student or the average for a set of students. The visualization is represented in the image below:

</