Registrations

Manage your adaptive learners and their instructors in meaningful groups

In this section:


Creating Registrations

POST /registrations

Registers a user to a learning instance.

Authorization

To register a user as an instructor, this endpoint must be called by the partner admin user.
To register a user as a learner, this endpoint must be called by either the partner admin user or by a user registered as an instructor of the specified learning instance.

Request Body

Parameter Type Optional Description
account_id uuid No The ID of the account that the registration will be created for.
learning_instance_id uuid No The ID of the learning instance in which to register the user.
type string No “learner”: a learner in a learning instance . “instructor”: a registration that receives administrative privileges on the learning instance.

Sample Request Body

{
  "type": "learner",
  "account_id": "eff3b9cf-df82-477a-ac12-c0e01b90bf6e",
  "learning_instance_id": "307b072c-6194-46fa-b226-68d40cee521f"
}

Response body

Parameter Type Optional Description
id uuid No The registration ID.
account_id uuid No The ID of the account that the registration will be created for.
learning_instance_id uuid No The ID of the learning instance in which to register the user.
type string No “learner”: a learner in a learning instance . “instructor”: a registration that receives administrative privileges on the learning instance.

Sample Response Body

{
  "id": "d0effd52-c3a7-4a3c-827a-3ac5eaa049a1",
  "type": "learner",
  "account_id": "eff3b9cf-df82-477a-ac12-c0e01b90bf6e",
  "learning_instance_id": "307b072c-6194-46fa-b226-68d40cee521f"
}

Retrieving Registrations

Get a Specific Registration

GET /registrations/{reg_id}

Retrieves a registration with a specified registration id.

Authorization

This endpoint must be called by the partner admin user, the user associated with the registration, or a user registered as an instructor of the learning instance associated with the specified registration.

Path Parameters

Parameter Type Optional Description
reg_id UUID No The ID of the registration to retrieve.

Response body

Parameter Type Optional Description
id uuid No The registration ID.
account_id uuid No The ID of the account with which the registration is associated.
learning_instance_id uuid No The ID of the learning instance with which the registration is associated.
type string No “learner”: a learner in a learning instance . “instructor”: a registration that receives administrative privileges on the learning instance .

Sample Response Body

{
  "id": "d0effd52-c3a7-4a3c-827a-3ac5eaa049a1",
  "type": "learner",
  "account_id": "eff3b9cf-df82-477a-ac12-c0e01b90bf6e",
  "learning_instance_id": "307b072c-6194-46fa-b226-68d40cee521f"
}

Get Registrations For a Specified Learning Instance

GET /learning-instances/{li_id}/registrations

Retrieves all registrations for a learning instance with the specified id.

Authorization

This endpoint must be called by the partner admin user or a user registered as an instructor of the specified learning instance.

Path Parameters

Parameter Type Optional Description
li_id UUID No The ID of the learning instance to retrieve registrations for.

Query Parameters

Parameter Type Optional Description
type string Yes “learner”: a learner in a learning instance. “instructor”: a registration that receives administrative privileges on the learning instance.

Response Body

Parameter Type Optional Description
[] object[] No A list of registrations in the specified learning instance.
[].id uuid No The registration ID.
[].account_id uuid No The ID of the account with which the registration is associated.
[].learning_instance_id uuid No The ID of the learning instance with which the registration is associated.
[].type string No “learner”: a learner in a learning instance . “instructor”: a registration that receives administrative privileges on the learning instance .

Sample Response Body

[
  {
    "id": "2799596d-5745-47e8-82dd-a900c5d602d7",
    "type": "learner",
    "account_id": "348db09b-7042-4a0a-a435-8872f9fa6907",
    "learning_instance_id": "307b072c-6194-46fa-b226-68d40cee521f"
  },
  {
    "id": "f2d83e0c-b7a9-42ab-bdf2-2840e62c1df6",
    "type": "instructor",
    "account_id": "23250ea8-538f-4a51-a761-da800103b557",
    "learning_instance_id": "307b072c-6194-46fa-b226-68d40cee521f"
  }
]

Delete Registrations

DELETE registrations/{reg_id}

Deletes a registration with the specified id.

Authorization

This endpoint must be called by the partner admin or a user registered as an instructor of the learning instance associated with the specified registration.

Path Parameters

Parameter Type Optional Description
reg_id UUID No Registration ID to delete.