# Activity Profile

## List Activity Profiles

<mark style="color:blue;">`GET`</mark> `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           |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Retrieve Activity Profile

<mark style="color:blue;">`GET`</mark> `https://{organisation}.clearlrs.com/xapi/activities/profile`

Retrieves the Activity Profile document

#### Query Parameters

| Name       | Type   | Description |
| ---------- | ------ | ----------- |
| activityId | string | 1           |
| profileId  | string | 2           |

{% tabs %}
{% tab title="200 The document currently stored in the Activity Profile resource." %}

```
```

{% endtab %}

{% tab title="302 " %}

```
```

{% endtab %}
{% endtabs %}

## Update Activity Profile

<mark style="color:orange;">`PUT`</mark> `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           |

{% tabs %}
{% tab title="204 The document was successfully updated." %}

```
```

{% endtab %}

{% tab title="400 The request is missing required parameters." %}

```javascript
{
    "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": ""
            }
        }
    ]
}
```

{% endtab %}
{% endtabs %}

## Merge Activity Profile

<mark style="color:green;">`POST`</mark> `https://{organisation}.clearlrs.com/xapi/activities/profile`

#### Query Parameters

| Name       | Type   | Description |
| ---------- | ------ | ----------- |
| activityId | string | 1           |
| profileId  | string | 2           |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Remove Activity Profile

<mark style="color:red;">`DELETE`</mark> `https://{organisation}.clearlrs.com/xapi/activities/profile`

#### Query Parameters

| Name       | Type   | Description |
| ---------- | ------ | ----------- |
| activityId | string | 1           |
| profileId  | string | 2           |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}
