Skip to content

Commit

Permalink
📝(project) add mandatory statements templates
Browse files Browse the repository at this point in the history
- Started
- Terminated
- Submitted an answer
- Validated an answer
  • Loading branch information
quitterie-lcs committed Feb 1, 2023
1 parent b178335 commit 275b9d4
Show file tree
Hide file tree
Showing 3 changed files with 129 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ This documentation intends to describe assessment profile defined by the Gaia-X

## Statements

### Completion

All these statements are **MANDATORY** in ordre to comply with this profile.

- [Started](./statements/mandatory/started.md)
- [Terminated](./statements/mandatory/terminated.md)
- Submitted an answer
- Validated an answer

### Detailed completion actions

All these statements are **HIGHLY RECOMMENDED**.

### Other actions

All these statements are **OPTIONAL**.


## Contributors

| Github user | Name | Company/Institution |
Expand Down
56 changes: 56 additions & 0 deletions statements/mandatory/started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Started

## Description

The user has started an assessment.
Such statement can be generated on several contexts.
The assessment is manually launched by the user and can be time limited.
The assessment is directly available on the current page and it starts when the user chose or submitted a response for the first answer.

## Examples

```json
{
"actor": {
"account": {
"name": "john",
"homePage": "http://gaiax.org"
}
},
"verb": {
"id": "http://activitystrea.ms/start"
},
"object": {
"id": "http://gaiax.org/xapi/activities/12d4f3f2-58e0-4a42-b3c6-b9b9cd7b0a7c",
"definition": {
"type": "http://adlnet.gov/expapi/activities/assessment",
"name": {
"en": "How much do you know about xAPI?"
}
}
},
"context": {
"contextActivities": {
"category": [
{
"id": "http://schema.dases.eu/xapi/profile/assessment",
"definition": {
"type": "http://adlnet.gov/expapi/activities/profile"
}
}
]
}
},
"timestamp": "2016-06-09T15:34:26.887Z"
}
```

## Properties

- `verb.id`: INCLUDED, must be `http://activitystrea.ms/start`
- `object.definition.type`: INCLUDED, must be `http://adlnet.gov/expapi/activities/assessment`.

## Rules

- `context.contextActivities.category`: MUST contain an activity with the `http://schema.dases.eu/xapi/profile/assessment` id.
- `timestamp`: INCLUDED
55 changes: 55 additions & 0 deletions statements/mandatory/terminated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Terminated

## Description

The user has successfully terminated its assessment.
The user has answered all the questions necessary for an evaluation.
The assessment is sent to evaluation or has been evaluated but the user can no longer attempt the assessment until being allowed by the assessment administrator.

## Examples

```json
{
"actor": {
"account": {
"name": "john",
"homePage": "http://gaiax.org"
}
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/terminated"
},
"object": {
"id": "http://gaiax.org/xapi/activities/12d4f3f2-58e0-4a42-b3c6-b9b9cd7b0a7c",
"definition": {
"type": "http://adlnet.gov/expapi/activities/assessment",
"name": {
"en": "How much do you know about xAPI?"
}
}
},
"context": {
"contextActivities": {
"category": [
{
"id": "http://schema.dases.eu/xapi/profile/assessment",
"definition": {
"type": "http://adlnet.gov/expapi/activities/profile"
}
}
]
}
},
"timestamp": "2016-06-09T15:34:26.887Z"
}
```

## Properties

- `verb.id`: INCLUDED, must be `http://adlnet.gov/expapi/verbs/terminated`
- `object.definition.type`: INCLUDED, must be `http://adlnet.gov/expapi/activities/assessment`.

## Rules

- `context.contextActivities.category`: MUST contain an activity with the `http://schema.dases.eu/xapi/profile/assessment` id.
- `timestamp`: INCLUDED

0 comments on commit 275b9d4

Please sign in to comment.