Activity Profile

List Activity Profiles

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

Returns a list of profileIds stored for the specified parameters.

Query Parameters

Name	Type	Description
activityId	string	1

200

Retrieve Activity Profile

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

Retrieves the Activity Profile document

Query Parameters

Name	Type	Description
activityId	string	1
profileId	string	2

200 The document currently stored in the Activity Profile resource.

302

Update Activity Profile

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

Replaces the Activity Profile document for the given activityId and profileId.

Query Parameters

Name	Type	Description
activityId	string	1
profileId	string	2

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  'profileId'",
            "property": "query",
            "value": {
                "document": ""
            }
        }
    ]
}

Merge Activity Profile

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

Query Parameters

Name	Type	Description
activityId	string	1
profileId	string	2

200

Remove Activity Profile

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

Query Parameters

Name	Type	Description
activityId	string	1
profileId	string	2

200