### Get Bundle Instances Response Examples

Source: https://demo.anewspring.com/apidocs

Example response structures for the getBundleCourses endpoint in JSON and XML formats.

```json
{
  "bundles": [
    {
      "id": "string",
      "uid": "string",
      "name": "string"
    }
  ]
}
```

```xml
<?xml version="1.0"?>
<inline_model_8>
  <bundles>
    <bundles id="string" uid="string">
      <name>string</name>
    </bundles>
  </bundles>
</inline_model_8>
```

--------------------------------

### Get Course Details Response

Source: https://demo.anewspring.com/apidocs

Example response formats for retrieving detailed course information.

```json
{
  "id": "string",
  "uid": "string",
  "name": "string",
  "title": "string",
  "description": "string",
  "isTemplate": true,
  "templateUid": "string",
  "active": true,
  "archived": true,
  "reseller": "string",
  "type": "Blended",
  "accessType": "Code",
  "startDate": "2014-08-25",
  "expireDate": "2015-08-25",
  "expireInterval": "1 year",
  "teachersAllowed": true,
  "teacherGroup": "string",
  "mentorGroup": "string"
}
```

```xml
<?xml version="1.0"?>
<course id="string" uid="string">
  <name>string</name>
  <title>string</title>
  <description>string</description>
  <isTemplate>true</isTemplate>
  <templateUid>string</templateUid>
  <active>true</active>
  <archived>true</archived>
  <reseller>string</reseller>
  <type>Blended</type>
  <accessType>Code</accessType>
  <startDate>2014-08-25</startDate>
  <expireDate>2015-08-25</expireDate>
  <expireInterval>1 year</expireInterval>
  <teachersAllowed>true</teachersAllowed>
  <teacherGroup>string</teacherGroup>
  <mentorGroup>string</mentorGroup>
</course>
```

--------------------------------

### Get Bundles Response Examples

Source: https://demo.anewspring.com/apidocs

Example response structures for the getBundles endpoint in JSON and XML formats.

```json
{
  "bundleTemplates": [
    {
      "id": "string",
      "uid": "string",
      "name": "string"
    }
  ]
}
```

```xml
<?xml version="1.0"?>
<inline_model_7>
  <bundleTemplates>
    <bundleTemplates id="string" uid="string">
      <name>string</name>
    </bundleTemplates>
  </bundleTemplates>
</inline_model_7>
```

--------------------------------

### Bundle Course Subscription Response Examples

Source: https://demo.anewspring.com/apidocs

Example response bodies for the bundle course subscription endpoint in JSON and XML formats.

```json
{
  "courseBundleId": "string",
  "courseBundleUid": "string",
  "subscribeDate": "2026-04-13T14:22:45.838Z",
  "lastAccessDate": "2026-04-13T14:22:45.838Z",
  "courses": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "reseller": "string",
      "active": true,
      "subscribeDate": "2014-08-25",
      "subscribeDateTime": "2026-04-13T14:22:45.838Z",
      "startDate": "2014-08-25",
      "startDateTime": "2026-04-13T14:22:45.838Z",
      "finished": true,
      "expired": true,
      "progress": "string",
      "knowledgeIntake": 0,
      "efficiency": 0,
      "objectiveProgress": 0
    }
  ]
}
```

```xml
<?xml version="1.0"?>
<bundleCourseStatistic courseBundleId="string" courseBundleUid="string">
  <subscribeDate>1970-01-01T00:00:00.001Z</subscribeDate>
  <lastAccessDate>1970-01-01T00:00:00.001Z</lastAccessDate>
  <courses>
    <courses id="string" uid="string">
      <name>string</name>
      <reseller>string</reseller>
      <active>true</active>
      <subscribeDate>2014-08-25</subscribeDate>
      <subscribeDateTime>1970-01-01T00:00:00.001Z</subscribeDateTime>
      <startDate>2014-08-25</startDate>
      <startDateTime>1970-01-01T00:00:00.001Z</startDateTime>
      <finished>true</finished>
      <expired>true</expired>
      <progress>string</progress>
      <knowledgeIntake>1.1</knowledgeIntake>
      <efficiency>1.1</efficiency>
      <objectiveProgress>1.1</objectiveProgress>
    </courses>
  </courses>
</bundleCourseStatistic>
```

--------------------------------

### Add Event Request Example

Source: https://demo.anewspring.com/apidocs

This example demonstrates how to add a new calendar item to a course. It shows how to specify course and event UIDs, and other event details like type, time, and description.

```curl
curl -X POST "/addEvent/{courseID}/{UID}?courseUID=example&UID=example" \
     -H "Content-Type: application/json" \
     -d '{ "type": "Meeting", "start": "yyyy-MM-ddTHH:mm:ssZ", "end": "yyyy-MM-ddTHH:mm:ssZ", "summary": "example", "description": "example", "location": "example", "notify": "true" }'
```

--------------------------------

### Add User to Skill Profile (Curl Example)

Source: https://demo.anewspring.com/apidocs

Example using Curl to add users to a skill profile. Prioritize external IDs over UIDs if provided in the path or parameters.

```bash
curl -X POST "/addSkillProfileUsers/{skillProfileID}?skillProfileUID=example&userUID=example" -d "user=example&ignoreDuplicates=true"
```

--------------------------------

### Update Event Request Example

Source: https://demo.anewspring.com/apidocs

This example shows how to update an existing calendar item using its UID. It allows modification of start and end times, summary, description, location, and notification settings.

```curl
curl -X POST "/updateEvent/{UID}" \
     -H "Content-Type: application/json" \
     -d '{ "start": "yyyy-MM-ddTHH:mm:ss", "end": "yyyy-MM-ddTHH:mm:ss", "summary": "example", "description": "example", "location": "example", "notify": "true" }'
```

--------------------------------

### Create Access Codes Response Example

Source: https://demo.anewspring.com/apidocs

Example response bodies for the create access codes endpoint in JSON and XML formats.

```json
{
  "accessCodes": [
    {
      "code": "RSDRW46DN9"
    }
  ],
  "group": "string"
}
```

```xml
<?xml version="1.0"?>
<inline_model_14 group="string">
  <accessCodes>
    <accessCodes code="RSDRW46DN9"></accessCodes>
  </accessCodes>
</inline_model_14>
```

--------------------------------

### Check user existence response examples

Source: https://demo.anewspring.com/apidocs

Example response bodies for the /userExists/{userID} endpoint in JSON and XML formats.

```json
{
  "result": true
}
```

```xml
<?xml version="1.0"?>
<result>
  <value>true</value>
</result>
```

--------------------------------

### GET /getTemplates

Source: https://demo.anewspring.com/apidocs

Retrieves all published course templates.

```APIDOC
## GET /getTemplates

### Description
Obtains all course templates that are published and available for instance creation.

### Method
GET

### Endpoint
/getTemplates

### Parameters
#### Query Parameters
- **includeWithoutId** (string) - Optional - Include templates without an external ID (true/false).
- **includeCourses** (string) - Optional - Include active course instances of the templates (true/false).

### Response
#### Success Response (200)
- **templates** (Array) - List of template objects containing id, uid, and name.

#### Response Example
{
  "templates": [
    {
      "id": "string",
      "uid": "string",
      "name": "string"
    }
  ]
}
```

--------------------------------

### PartResult Data Model Examples

Source: https://demo.anewspring.com/apidocs

Example representations of the PartResult object in JSON and XML formats.

```json
{
  "id": "string",
  "uid": "string",
  "name": "string",
  "type": "string",
  "subType": "string",
  "blockName": "string",
  "completed": true,
  "completeDate": "2013-04-20",
  "completeDateTime": "2013-04-20T12:34:56Z",
  "score": "string",
  "passed": true,
  "attempts": [
    {
      "attemptNumber": 0,
      "startDate": "2013-04-05",
      "startDateTime": "2013-04-05T12:34:56Z",
      "completed": true,
      "completeDate": "2013-04-05",
      "completeDateTime": "2013-04-05T12:34:56Z",
      "expireDate": "2013-04-05",
      "progress": "2/2",
      "score": "10.0",
      "passed": true,
      "terms": [
        {
          "name": "string",
          "score": 1,
          "maxScore": 3,
          "threshold": 2
        }
      ],
      "criteria": [
        {
          "id": "string",
          "name": "string",
          "maxScore": 3,
          "score": 1
        }
      ]
    }
  ]
}
```

```xml
<?xml version="1.0"?>
<part id="string" uid="string" name="string" type="string" subType="string" blockName="string" completed="true" completeDate="2013-04-20" completeDateTime="2013-04-20T12:34:56Z" score="string" passed="true">
  <attempt attemptNumber="1">
    <startDate>2013-04-05</startDate>
    <startDateTime>2013-04-05T12:34:56Z</startDateTime>
    <completed>true</completed>
    <completeDate>2013-04-05</completeDate>
    <completeDateTime>2013-04-05T12:34:56Z</completeDateTime>
    <expireDate>2013-04-05</expireDate>
    <progress>2/2</progress>
    <score>10.0</score>
    <passed>true</passed>
    <terms>
      <terms name="string">
        <score>1</score>
        <maxScore>3</maxScore>
        <threshold>2</threshold>
      </terms>
    </terms>
    <criteria>
      <criteria id="string" name="string">
        <maxScore>3</maxScore>
        <score>1</score>
      </criteria>
    </criteria>
  </attempt>
</part>
```

--------------------------------

### Remove User from Skill Profile (Curl Example)

Source: https://demo.anewspring.com/apidocs

Example using Curl to remove users from a skill profile. External IDs take precedence over UIDs.

```bash
curl -X POST "/deleteSkillProfileUsers/{skillProfileID}?skillProfileUID=example&userUID=example" -d "user=example&ignoreMissing=true"
```

--------------------------------

### GET /getBundles

Source: https://demo.anewspring.com/apidocs

Retrieves a list of existing bundle templates.

```APIDOC
## GET /getBundles

### Description
Lists existing bundle templates data.

### Method
GET

### Endpoint
/getBundles

### Query Parameters
- **includeWithoutId** (string) - Optional - include templates without an external ID

### Response
#### Success Response (200)
- **bundleTemplates** (Array[bundleTemplate]) - Description: An array of bundle templates.
  - **id** (string) - The ID of the bundle template.
  - **uid** (string) - The UID of the bundle template.
  - **name** (string) - The name of the bundle template.

#### Response Example
```json
{
  "bundleTemplates": [
    {
      "id": "string",
      "uid": "string",
      "name": "string"
    }
  ]
}
```
```

--------------------------------

### Retrieve Course List Response

Source: https://demo.anewspring.com/apidocs

Example response body for a successful course list retrieval.

```json
{
  "courses": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "title": "string",
      "description": "string",
      "isTemplate": true,
      "templateUid": "string",
      "active": true,
      "archived": true,
      "reseller": "string",
      "type": "Blended",
      "accessType": "Code",
      "startDate": "2014-08-25",
      "expireDate": "2015-08-25",
      "expireInterval": "1 year",
      "teachersAllowed": true,
      "teacherGroup": "string",
      "mentorGroup": "string"
    }
  ]
}
```

```xml
<?xml version="1.0"?>
<inline_model_6>
  <courses>
    <courses id="string" uid="string">
      <name>string</name>
      <title>string</title>
      <description>string</description>
      <isTemplate>true</isTemplate>
      <templateUid>string</templateUid>
      <active>true</active>
      <archived>true</archived>
      <reseller>string</reseller>
      <type>Blended</type>
      <accessType>Code</accessType>
      <startDate>2014-08-25</startDate>
      <expireDate>2015-08-25</expireDate>
      <expireInterval>1 year</expireInterval>
      <teachersAllowed>true</teachersAllowed>
      <teacherGroup>string</teacherGroup>
      <mentorGroup>string</mentorGroup>
    </courses>
  </courses>
</inline_model_6>
```

--------------------------------

### Retrieve Course Structure Response

Source: https://demo.anewspring.com/apidocs

Example response body for a successful course structure retrieval.

```json
{
  "id": "string",
  "uid": "string",
  "name": "string",
  "active": true,
  "blocks": [
    {
      "name": "string",
      "hidden": true,
      "adaptive": true,
      "courseParts": [
        {
          "id": "string",
          "uid": "string",
          "name": "string",
          "active": true,
          "hidden": true,
          "adaptive": true
        }
      ]
    }
  ]
}
```

```xml
<?xml version="1.0"?>
<course id="string" uid="string" name="string" active="true">
  <blocks>
    <blocks name="string" hidden="true" adaptive="true">
      <courseParts>
        <courseParts id="string" uid="string" name="string" active="true" hidden="true" adaptive="true"></courseParts>
      </courseParts>
    </blocks>
  </blocks>
</course>
```

--------------------------------

### Retrieve Course Templates XML Response

Source: https://demo.anewspring.com/apidocs

Example XML response structure for the getTemplates endpoint.

```xml
<?xml version="1.0"?>
<inline_model_5>
  <templates>
    <templates id="string" uid="string" name="string"></templates>
  </templates>
</inline_model_5>
```

--------------------------------

### Skill Profile JSON Response

Source: https://demo.anewspring.com/apidocs

Example JSON structure for a skill profile, including an array of skill profiles.

```json
{
  "skillProfiles": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "description": "string"
    }
  ]
}
```

--------------------------------

### Skill Profile XML Response

Source: https://demo.anewspring.com/apidocs

Example XML structure for a skill profile, including an array of skill profiles.

```xml
<?xml version="1.0"?>
<inline_model_15>
  <skillProfiles>
    <skillProfiles id="string">
      <uid>string</uid>
      <name>string</name>
      <description>string</description>
    </skillProfiles>
  </skillProfiles>
</inline_model_15>
```

--------------------------------

### GET /getEvents

Source: https://demo.anewspring.com/apidocs

Retrieves all events from the learning environment.

```APIDOC
## GET /getEvents

### Description
Gets all events (exams and meetings) from the learning environment. Planned activities and blocks are excluded.

### Method
GET

### Endpoint
/getEvents
```

--------------------------------

### Retrieve Course Templates JSON Response

Source: https://demo.anewspring.com/apidocs

Example JSON response structure for the getTemplates endpoint.

```json
{
  "templates": [
    {
      "id": "string",
      "uid": "string",
      "name": "string"
    }
  ]
}
```

--------------------------------

### GET /getCourse/{ID}

Source: https://demo.anewspring.com/apidocs

Retrieves detailed information about a specific course template.

```APIDOC
## GET /getCourse/{ID}

### Description
Obtain the details of a specified course template. Note that role terms used are: student (learner), teacher (instructor), and mentor (observer).

### Method
GET

### Endpoint
/getCourse/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - The ID in the external system (external ID).

#### Query Parameters
- **UID** (string) - Optional - The UID in the platform (36 characters required).

### Response
#### Success Response (200)
- **id** (string) - Course ID
- **uid** (string) - Course UID
- **name** (string) - Course name
- **title** (string) - Course title
- **description** (string) - Course description
- **isTemplate** (boolean) - Whether it is a template
- **templateUid** (string) - Template UID
- **active** (boolean) - Active status
- **archived** (boolean) - Archived status
- **reseller** (string) - Reseller info
- **type** (string) - Course type
- **accessType** (string) - Access type
- **startDate** (string) - Start date
- **expireDate** (string) - Expiration date
- **expireInterval** (string) - Expiration interval
- **teachersAllowed** (boolean) - If teachers are allowed
- **teacherGroup** (string) - Teacher group
- **mentorGroup** (string) - Mentor group

#### Response Example
{
  "id": "string",
  "uid": "string",
  "name": "string",
  "title": "string",
  "description": "string",
  "isTemplate": true,
  "templateUid": "string",
  "active": true,
  "archived": true,
  "reseller": "string",
  "type": "Blended",
  "accessType": "Code",
  "startDate": "2014-08-25",
  "expireDate": "2015-08-25",
  "expireInterval": "1 year",
  "teachersAllowed": true,
  "teacherGroup": "string",
  "mentorGroup": "string"
}
```

--------------------------------

### Retrieve Bookable Event Subscription Model

Source: https://demo.anewspring.com/apidocs

Example response structures for bookable event subscriptions in JSON and XML formats.

```json
{
  "eventId": "string",
  "eventName": "string",
  "userId": "string",
  "userUid": "string",
  "userName": "string",
  "reseller": "string",
  "active": true,
  "courseId": "string",
  "courseUid": "string",
  "courseName": "string",
  "activityId": "string",
  "activityName": "string",
  "subscribeDate": "string",
  "subscribeDateTime": "string"
}
```

```xml
<?xml version="1.0"?>
<bookableEventSubscription>
  <eventId>string</eventId>
  <eventName>string</eventName>
  <userId>string</userId>
  <userUid>string</userUid>
  <userName>string</userName>
  <reseller>string</reseller>
  <active>true</active>
  <courseId>string</courseId>
  <courseUid>string</courseUid>
  <courseName>string</courseName>
  <activityId>string</activityId>
  <activityName>string</activityName>
  <subscribeDate>string</subscribeDate>
  <subscribeDateTime>string</subscribeDateTime>
</bookableEventSubscription>
```

--------------------------------

### GET /getCourses/{templateID}

Source: https://demo.anewspring.com/apidocs

Retrieves all course instances for a specific course template.

```APIDOC
## GET /getCourses/{templateID}

### Description
Obtains all course instances for a specific course template that have an external ID. Priority is given to external IDs in path, then parameters, then UIDs.

### Method
GET

### Endpoint
/getCourses/{templateID}

### Parameters
#### Path Parameters
- **templateID** (string) - Required - The external ID of the course template.
```

--------------------------------

### Get User Subscriptions Response

Source: https://demo.anewspring.com/apidocs

Returns a list of subscription objects containing course details, progress, and status.

```json
{
  "courses": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "reseller": "string",
      "active": true,
      "subscribeDate": "2013-04-05",
      "subscribeDateTime": "2013-04-05T12:34:56Z",
      "startDate": "2013-04-05",
      "startDateTime": "2013-04-05T12:34:56Z",
      "finished": true,
      "expired": true,
      "progress": "11/16",
      "knowledgeIntake": 0.4,
      "efficiency": 0.27,
      "objectiveProgress": 0.58
    }
  ]
}
```

```xml
<?xml version="1.0"?>
<inline_model_1>
  <courses>
    <courses id="string" uid="string" name="string" reseller="string" active="true" subscribeDate="2013-04-05" subscribeDateTime="2013-04-05T12:34:56Z" startDate="2013-04-05" startDateTime="2013-04-05T12:34:56Z" finished="true" expired="true" progress="11/16" knowledgeIntake="0.4" efficiency="0.27" objectiveProgress="0.58"></courses>
  </courses>
</inline_model_1>
```

--------------------------------

### Group User Response Model

Source: https://demo.anewspring.com/apidocs

Example response structure for group user queries in JSON and XML formats.

```json
{
  "users": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "login": "string",
      "email": "string",
      "active": true,
      "archived": true
    }
  ]
}
```

```xml
<?xml version="1.0"?>
<inline_model_3>
  <users>
    <users id="string" uid="string" name="string" login="string" email="string" active="true" archived="true"></users>
  </users>
</inline_model_3>
```

--------------------------------

### GET /getUsers

Source: https://demo.anewspring.com/apidocs

Retrieves a core set of details for all users in the learning environment.

```APIDOC
## GET /getUsers

### Description
Get all users. This can be used to obtain (a core set of details of) all users in the learning environment.

### Method
GET

### Endpoint
/getUsers

### Response
#### Success Response (200)
- **users** (Array[UserCore]) - Description of the users array

#### Response Example
```json
{
  "users": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "login": "string",
      "email": "string",
      "active": true,
      "archived": true
    }
  ]
}
```
```

--------------------------------

### GET /getBundleCourses/{bundleID}

Source: https://demo.anewspring.com/apidocs

Retrieves a list of bundle instances for a given bundle template.

```APIDOC
## GET /getBundleCourses/{bundleID}

### Description
Lists existing bundle instances for a given bundle template.

### Method
GET

### Endpoint
/getBundleCourses/{bundleID}

### Parameters
#### Path Parameters
- **bundleID** (string) - Required - The ID of the bundle template in the external system, which is shown as external ID in the platform.

#### Query Parameters
- **bundleID** (string) - Optional - The ID of the bundle template in the external system, which is shown as external ID in the platform.
- **bundleUID** (string) - Optional - The UID (formatted as UUID) of the bundle template in the platform. 36 characters required.

### Implementation Notes
Note: If an external ID is added as a path component, that will have priority and all other IDs will be ignored. If an external ID is added as a parameter, that will have priority and the UID will be ignored. If a UID is added as a parameter, it will only be considered if there is no external ID included (as a parameter or as a path) in the call. Example: /getBundleCourses?bundleUID=example

### Response
#### Success Response (200)
- **bundles** (Array[bundle]) - Description: An array of bundle instances.
  - **id** (string) - The ID of the bundle instance.
  - **uid** (string) - The UID of the bundle instance.
  - **name** (string) - The name of the bundle instance.

#### Response Example
```json
{
  "bundles": [
    {
      "id": "string",
      "uid": "string",
      "name": "string"
    }
  ]
}
```
```

--------------------------------

### GET /getResellerSkillProfiles/{resellerID}

Source: https://demo.anewspring.com/apidocs

Retrieves all skill profiles associated with a specific reseller.

```APIDOC
## GET /getResellerSkillProfiles/{resellerID}

### Description
Get reseller skill profiles. This can be used to obtain all the skill profiles linked to the reseller.

### Method
GET

### Endpoint
/getResellerSkillProfiles/{resellerID}

### Parameters
#### Path Parameters
- **resellerID** (string) - Required - The ID of the reseller in the external system, which is shown as 'external ID' in the platform.

### Response
#### Success Response (200)
- **skillProfiles** (Array[SkillProfile], optional)

Model:
SkillProfile {
  id (string, optional),
  uid (string, optional),
  name (string, optional),
  description (string, optional)
}

### Response Example (application/json)
```json
{
  "skillProfiles": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "description": "string"
    }
  ]
}
```

### Response Example (application/xml)
```xml
<?xml version="1.0"?>
<inline_model_4>
  <skillProfiles>
    <skillProfiles id="string">
      <uid>string</uid>
      <name>string</name>
      <description>string</description>
    </skillProfiles>
  </skillProfiles>
</inline_model_4>
```

#### Error Response
- **404**: No reseller exists with the specified ID.
```

--------------------------------

### GET /courses

Source: https://demo.anewspring.com/apidocs

Retrieves a list of courses with detailed progress, completion status, and performance metrics for each course.

```APIDOC
## GET /courses

### Description
Retrieves a list of courses associated with the user, including detailed progress, completion status, grades, and performance metrics.

### Method
GET

### Endpoint
/courses

### Response
#### Success Response (200)
- **courses** (Array[CourseResult]) - A list of course result objects.

#### Response Example
{
  "courses": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "reseller": "string",
      "active": true,
      "subscribeDate": "2013-04-05",
      "startDate": "2013-04-05",
      "finished": true,
      "expired": true,
      "progress": "11/16",
      "knowledgeIntake": 0.4,
      "efficiency": 0.27,
      "objectivesProgress": 0.58,
      "lastTrainingCompletedDate": "2014-07-02",
      "lastTrainingCompletedDateTime": "2014-07-02T12:34:56Z",
      "completed": true,
      "completeDate": "2013-04-20",
      "grade": "84%",
      "passed": true,
      "gradeDate": "2013-04-20",
      "parts": [],
      "objectives": []
    }
  ]
}
```

--------------------------------

### Course Result Response (XML)

Source: https://demo.anewspring.com/apidocs

This section provides an XML example of the CourseResult response, illustrating the structure for course results.

```APIDOC
## Course Result Response (XML Example)

### Description
An example of the CourseResult response in XML format.

### Response Example (XML)
```xml
<?xml version="1.0"?>
<course id="string" uid="string" name="string" reseller="string" active="true" subscribeDate="2013-04-05" startDate="2013-04-05" finished="true" expired="true" progress="11/16" knowledgeIntake="0.4" efficiency="0.27" objectivesProgress="0.58" lastTrainingCompletedDate="2014-07-02" lastTrainingCompletedDateTime="2014-07-02T12:34:56Z" completed="true" completeDate="2013-04-20" grade="84%" passed="true" gradeDate="2013-04-20">
  <parts>
    <parts id="string" uid="string" name="string" type="string" subType="string" blockName="string" completed="true" completeDate="2013-04-20" completeDateTime="2013-04-20T12:34:56Z" score="string" passed="true">
      <attempt attemptNumber="1">
        <startDate>2013-04-05</startDate>
        <startDateTime>2013-04-05T12:34:56Z</startDateTime>
        <completed>true</completed>
        <completeDate>2013-04-05</completeDate>
        <completeDateTime>2013-04-05T12:34:56Z</completeDateTime>
        <expireDate>2013-04-05</expireDate>
        <progress>2/2</progress>
        <score>10.0</score>
        <passed>true</passed>
        <terms>
          <terms name="string">
            <score>1</score>
            <maxScore>3</maxScore>
            <threshold>2</threshold>
          </terms>
        </terms>
      </attempt>
    </parts>
  </parts>
</course>
```
```

--------------------------------

### GET /getSkillProfiles

Source: https://demo.anewspring.com/apidocs

Retrieve all skill profiles available in the environment. This endpoint is used for managing and viewing skill profile data.

```APIDOC
## GET /getSkillProfiles

### Description
Get skill profiles.

### Method
GET

### Endpoint
/getSkillProfiles

### Implementation Notes
This can be used to obtain all skill profiles of the environment.

### Response
#### Success Response (200)
- **skillProfiles** (array) - A list of skill profiles.
```

--------------------------------

### GET /userExists/{userID}

Source: https://demo.anewspring.com/apidocs

Check if a user exists in the learning environment using either an external ID or a platform UID.

```APIDOC
## GET /userExists/{userID}

### Description
Check if a certain user exists in the learning environment. Note that external IDs take priority over UIDs.

### Method
GET

### Endpoint
/userExists/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user in the external system (external ID).

#### Query Parameters
- **userUID** (string) - Optional - The UID (formatted as UUID) of the user in the platform (36 characters).

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the user exists.

#### Response Example
{
  "result": true
}
```

--------------------------------

### POST /instantiate

Source: https://demo.anewspring.com/apidocs

Creates a new instance of an existing course template.

```APIDOC
## POST /instantiate

### Description
Creates a new instance of an existing course template. Priority is given to external IDs provided in path or parameters over UIDs.

### Method
POST

### Endpoint
/instantiate

### Parameters
#### Path Parameters
- **templateID** (string) - Optional - The ID of the template in the external system (external ID).
- **courseID** (string) - Optional - The ID of the course in the external system (external ID).

#### Query Parameters
- **templateUID** (string) - Optional - The UID of the template in the platform (36 characters).

#### Request Body (formData)
- **name** (string) - Required - Must be unique.
- **title** (string) - Optional
- **description** (string) - Optional
- **reseller** (string) - Optional - External ID of the reseller.
- **resellerName** (string) - Optional - DEPRECATED: Name of the reseller.
- **teacherGroup** (string) - Optional - External ID of the instructor group.
- **mentorGroup** (string) - Optional - External ID of the observer group.
- **startDate** (date) - Optional - Format yyyy-MM-dd.
- **expireDate** (date) - Optional - Format yyyy-MM-dd (mutually exclusive with expireInterval).
- **expireInterval** (string) - Optional - Period from first use (mutually exclusive with expireDate).

### Response
#### Success Response (200)
- Success

#### Error Responses
- 404: Template, reseller, or group does not exist.
- 409: Template not published, course ID/name exists, or group type mismatch.
```

--------------------------------

### GET /getResults/{userID}/{courseID}/{activityID}

Source: https://demo.anewspring.com/apidocs

Retrieves the results of a specified course activity for a given user, including start date, completion status, progress, and scores.

```APIDOC
## GET /getResults/{userID}/{courseID}/{activityID}

### Description
This endpoint retrieves the results of a specified course activity for a given user. It provides details such as start date, completion status, progress, score, and pass status.

### Method
GET

### Endpoint
/getResults/{userID}/{courseID}/{activityID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user in the external system.
- **courseID** (string) - Required - The ID of the course in the external system.
- **activityID** (string) - Required - The ID of the activity in the external system.

#### Query Parameters
- **userUID** (string) - Optional - The UID (UUID) of the user in the platform.
- **courseUID** (string) - Optional - The UID (UUID) of the course in the platform.
- **asStudent** (string) - Optional - Indicates if results should contain only visible activities (true/false).

### Response
#### Success Response (200)
- **course** (object) - Contains objectives and attempt details including criteria, maxScore, and score.

#### Error Handling
- **404** - Returned if no user and/or course exists with the specified ID, or the user is not subscribed to the course.
```

--------------------------------

### POST /instantiate/{templateID}/{courseID}

Source: https://demo.anewspring.com/apidocs

Creates a new course instance based on a provided template and course ID.

```APIDOC
## POST /instantiate/{templateID}/{courseID}

### Description
Create course instance.

### Method
POST

### Endpoint
/instantiate/{templateID}/{courseID}
```

--------------------------------

### POST /addUser/{userID}

Source: https://demo.anewspring.com/apidocs

Adds a new user to the learning environment. All parameters except ID are optional.

```APIDOC
## POST /addUser/{userID}

### Description
This can be used to add a new user to the learning environment. All parameters except ID are optional, but keep in mind that users without a name can result in unforeseen situations on certain screens.

### Method
POST

### Endpoint
/addUser/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user in the external system, which is shown as **external ID** in the platform

### Request Example
```json
{
  "login": "user@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "email": "user@example.com"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates successful user addition.

#### Error Response
- **409 Conflict**: The user already has an ID or if the ID is already used.
- **404 Not Found**: No user exists with the specified login.

#### Response Example
```json
{
  "message": "User added successfully."
}
```
```

--------------------------------

### POST /subscribe

Source: https://demo.anewspring.com/apidocs

Enrolls an existing student into an existing course. Supports identification via external IDs or platform UIDs.

```APIDOC
## POST /subscribe/{userID}/{courseID}

### Description
Enrols an existing student (user with student role) in an existing course. External IDs provided as path components take priority over query parameters.

### Method
POST

### Endpoint
/subscribe/{userID}/{courseID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user in the external system.
- **courseID** (string) - Required - The ID of the course in the external system.

#### Query Parameters
- **userUID** (string) - Optional - The UID (UUID) of the user in the platform.
- **courseUID** (string) - Optional - The UID (UUID) of the course in the platform.

#### Request Body (formData)
- **reseller** (string) - Optional - External ID of the reseller to link to this enrolment.
- **startDate** (date) - Optional - First date/time the course is available.
- **expireDate** (date) - Optional - Date on which the course expires.
- **addToTeacherStudents** (string) - Optional - Add student to 'My Students' list (default: true).
- **notify** (string) - Optional - Send notification email (default: false).

### Response
#### Success Response (200)
- **Status** (200) - Success
```

--------------------------------

### GET /getStudentSubscriptions/{courseID}

Source: https://demo.anewspring.com/apidocs

Retrieves the subscriptions associated with a specific course.

```APIDOC
## GET /getStudentSubscriptions/{courseID}

### Description
Obtain the subscriptions of the specified course.

### Method
GET

### Endpoint
/getStudentSubscriptions/{courseID}

### Parameters
#### Path Parameters
- **courseID** (string) - Required - The ID of the course.
```

--------------------------------

### POST /initializeId/{login}/{userID}

Source: https://demo.anewspring.com/apidocs

Initializes a user ID. This endpoint is used to set up a user's identifier.

```APIDOC
## POST /initializeId/{login}/{userID}

### Description
Initialize user ID.

### Method
POST

### Endpoint
/initializeId/{login}/{userID}

### Parameters
#### Path Parameters
- **login** (string) - Required - The login name of the user.
- **userID** (string) - Required - The ID of the user in the external system, which is shown as external ID in the platform.
```

--------------------------------

### GET /getResults/{userID}

Source: https://demo.anewspring.com/apidocs

Retrieves course results for a specific user.

```APIDOC
## GET /getResults/{userID}

### Description
Retrieves course results for a user.

### Method
GET

### Endpoint
/getResults/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user.
```

--------------------------------

### GET /isSubscribed

Source: https://demo.anewspring.com/apidocs

Checks if a specific user is enrolled in a specific course.

```APIDOC
## GET /isSubscribed

### Description
Checks if a certain user is enrolled in a certain course. Priority is given to external IDs if provided as path components or parameters.

### Method
GET

### Endpoint
/isSubscribed

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user in the external system.
- **courseID** (string) - Required - The ID of the course in the external system.

#### Query Parameters
- **userUID** (string) - Optional - The UID of the user in the platform.
- **courseUID** (string) - Optional - The UID of the course in the platform.

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the user is subscribed.

#### Response Example
{
  "result": true
}
```

--------------------------------

### GET /getUser/{userID}

Source: https://demo.anewspring.com/apidocs

Retrieve personal details of a specified user.

```APIDOC
## GET /getUser/{userID}

### Description
Obtain the personal details of the specified user. Note: External IDs take priority over UIDs. Role terms used in the API are 'student' (learner), 'teacher' (instructor), and 'mentor' (observer).

### Method
GET

### Endpoint
/getUser/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user in the external system (external ID).

#### Query Parameters
- **userUID** (string) - Optional - The UID (formatted as UUID) of the user in the platform (36 characters).
```

--------------------------------

### GET /getStudentSkillProfiles/{userID}

Source: https://demo.anewspring.com/apidocs

Retrieves the progress of skill profiles for a specified student.

```APIDOC
## GET /getStudentSkillProfiles/{userID}

### Description
Obtains the progress of skill profiles from a specified student. Supports identification via external ID or UID.

### Method
GET

### Endpoint
/getStudentSkillProfiles/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user in the external system (external ID).

#### Query Parameters
- **userUID** (string) - Optional - The UID (UUID) of the user in the platform.

### Response
#### Success Response (200)
- **studentSkillProfiles** (Array[StudentSkillProfile]) - List of skill profiles with progress data.

#### Response Example
{
  "studentSkillProfiles": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "description": "string",
      "achieved": 0,
      "total": 0
    }
  ]
}

#### Error Response (404)
- No user exists with the specified ID.
```

--------------------------------

### GET /getBundleCourseSubscriptions/{userID}

Source: https://demo.anewspring.com/apidocs

Retrieves bundle subscription details for a specific user.

```APIDOC
## GET /getBundleCourseSubscriptions/{userID}

### Description
Returns bundle subscription details for a user.

### Method
GET

### Endpoint
/getBundleCourseSubscriptions/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user in the external system, which is shown as external ID in the platform.

#### Query Parameters
- **userUID** (string) - Optional - The UID (formatted as UUID) of the user in the platform. 36 characters required.
- **bundleCourseID** (string) - Required - The ID of the bundle course in the external system, which is shown as external ID in the platform.
- **bundleCourseUID** (string) - Optional - The UID (formatted as UUID) of the bundle course in the platform. 36 characters required.

### Response
#### Success Response (200)
- **bundleCourseStatistic** (object) - Contains course bundle statistics.
  - **courseBundleId** (string, optional)
  - **courseBundleUid** (string, optional)
  - **subscribeDate** (string, optional)
  - **lastAccessDate** (string, optional)
  - **courses** (Array[object], optional)
    - **id** (string, optional)
    - **uid** (string, optional)
    - **name** (string, optional)
    - **reseller** (string, optional)
    - **active** (boolean, optional)
    - **subscribeDate** (string, optional)
    - **subscribeDateTime** (string, optional)
    - **startDate** (string, optional)
    - **startDateTime** (string, optional)
    - **finished** (boolean, optional)
    - **expired** (boolean, optional)
    - **progress** (string, optional)
    - **knowledgeIntake** (number, optional)
    - **efficiency** (number, optional)
    - **objectiveProgress** (number, optional)

#### Response Example
```json
{
  "courseBundleId": "string",
  "courseBundleUid": "string",
  "subscribeDate": "2026-04-13T14:22:45.838Z",
  "lastAccessDate": "2026-04-13T14:22:45.838Z",
  "courses": [
    {
      "id": "string",
      "uid": "string",
      "name": "string",
      "reseller": "string",
      "active": true,
      "subscribeDate": "2014-08-25",
      "subscribeDateTime": "2026-04-13T14:22:45.838Z",
      "startDate": "2014-08-25",
      "startDateTime": "2026-04-13T14:22:45.838Z",
      "finished": true,
      "expired": true,
      "progress": "string",
      "knowledgeIntake": 0,
      "efficiency": 0,
      "objectiveProgress": 0
    }
  ]
}
```

#### Error Response
- **404** - Command not found
```