Create a user and add into a classroom

To sign up a user for a particular classroom ID, simply send a request with the following body parameters varying on whether it is an existing user or a new one.

New user classroom enrollment

POST https://api.cakes.com/api/v2/public/enrol/classroom

This endpoint allows you to get free cakes.

Headers

Name	Type	Description
ApiKey	string	School's API Key

Request Body

Name	Type	Description
FirstName	string	User's first name
LastName	string	User's last name
Email	string	User's email address
Classroom	string	ID of classroom to enroll into

200 User registered and enrolled into classroom

{
    firstName: string,
    lastName: string,
    email: string,
    lastlogin: DateTime,
    passwordResetTicketUrl: string,
    classroom: {
        courseId: string,
        courseName: string,
        classId: string,
        className: string
    }
}

401 Invalid API Key

{
    status: 401,
    userMessage: "This API key is invalid."
}

Existing user classroom enrollment

POST /api/v2/public/enrol/classroom

Headers

Name	Type	Description
ApiKey	string	School's API Key

Request Body

Name	Type	Description
Email	string	User's email address
Classroom	string	Classroom ID to enroll into

200 User enrolled to classroom

{
    firstName: string,
    lastName: string,
    email: string,
    lastlogin: DateTime,
    passwordResetTicketUrl: string,
    classroom: {
        courseId: string,
        courseName: string,
        classId: string,
        className: string
    }
}