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
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
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
{
"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
Remove Agent Profile
DELETE https://{organisation}.clearlrs.com/xapi/agents/profile
Query Parameters
Name
Type
Description
agent
object
1
profileId
string
2
Last updated