Agent Profile

List Agent Profiles

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

Returns a list of profileIds stored for the specified parameters.

Query Parameters

Name	Type	Description
agent	object	1
registration	string	2

200

Retrieve Agent Profile

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

Retrieves the Agent Profile document

Query Parameters

Name	Type	Description
agent	object	1
profileId	string	2

200 The document currently stored in the Agent Profile resource.

302

Update Agent Profile

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

Replaces the Agent Profile document for the given agent and profileId.

Query Parameters

Name	Type	Description
agent	object	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  'agent'",
            "property": "query",
            "value": {
                "document": ""
            }
        },
        {
            "name": "ValidationError",
            "description": "'query' must contain property  'profileId'",
            "property": "query",
            "value": {
                "document": ""
            }
        }
    ]
}

Merge Agent Profile

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

Query Parameters

Name	Type	Description
agent	object	1
profileId	string	2

200

Remove Agent Profile

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

Query Parameters

Name	Type	Description
agent	object	1
profileId	string	2

200