State

List State

GET https://{organisation}.clearlrs.com/xapi/activities/state

Returns a list of stateIds stored for the specified parameters.

Query Parameters

Name	Type	Description
activityId	string	1
agent	object	2
registration	string	3

200

Retrieve State

GET https://{organisation}.clearlrs.com/xapi/activities/state

Retrieves the state document

Query Parameters

Name	Type	Description
activityId	string	1
agent	object	2
stateId	string	3
registration	string	4

200 The document currently stored in the state resource.

302

Update State

PUT https://{organisation}.clearlrs.com/xapi/activities/state

Replaces the state document for the given agent, activityId and stateId.

Query Parameters

Name	Type	Description
activityId	string	1
agent	object	2
stateId	string	3
registration	string	4

204 The document was successfully updated.

400 The request is missing required parameters.

{
    "code": 400,
    "name": "Bad Request",
    "body": [
        {
            "name": "ValidationError",
            "description": "'query' must contain property  'activityId'",
            "property": "query",
            "value": {
                "document": ""
            }
        },
        {
            "name": "ValidationError",
            "description": "'query' must contain property  'agent'",
            "property": "query",
            "value": {
                "document": ""
            }
        },
        {
            "name": "ValidationError",
            "description": "'query' must contain property  'stateId'",
            "property": "query",
            "value": {
                "document": ""
            }
        }
    ]
}

Merge State

POST https://{organisation}.clearlrs.com/xapi/activities/state

Query Parameters

Name	Type	Description
activityId	string	1
agent	object	2
stateId	string	3
registration	string	4

200

Remove State

DELETE https://{organisation}.clearlrs.com/xapi/activities/state

Query Parameters

Name	Type	Description
activityId	string	1
agent	object	2
stateId	string	3
registration	string	4

200