Description: This api is useful for the assign exsisting and new students to the teacher-led opportunity.
Endpoint URL: https://apps.quickerlearning.com/api/teacherled/courseleader
Method: POST
AUTHORIZATION:
Type: Basic Auth
UserName: tenant_id,
Password:secret_key
HEADERS:
Accept: application/json
Note: We can assign existing students using single and multiple Ids.
We can assign new students single and multiple Ids.
We can assign existing and multiple students both as a same time.
Request Body For the Assign existing students using single IDs.
{
“oppId”: 123,
“company_id”: 5,
“old_student_ids”: [456]
}
Response for the Assign existing students using single IDs:
{
“message”: “Students assigned to opportunity successfully.”,
“status”: 200,
“data”: {
“assigned_count”: 1,
“assigned”: [
{
“student_id”: “556”,
“name”: “Stacy Test”,
“type”: “old”
}
],
“already_assigned”: [],
“errors”: []
}
}
Request Body For the Assign existing students using Multiple IDs.
{
“oppId”: 25,
“company_id”: 59,
“old_student_ids”: [703, 611, 556]
}
Response for the Assign existing students using Multiple IDs:
{
“message”: “Students assigned to opportunity successfully.”,
“status”: 200,
“data”: {
“assigned_count”: 3,
“assigned”: [
{
“student_id”: “703”,
“name”: “diana trouts”,
“type”: “old”
},
{
“student_id”: “611”,
“name”: “simran desai”,
“type”: “old”
},
{
“student_id”: “556”,
“name”: “Stacy Test”,
“type”: “old”
}
],
“already_assigned”: [],
“errors”: []
}
}
Request Body for the Assign New students (single) to the teacher-led opportunity
{
“oppId”: 25,
“new_students”: [
{
“firstname”: “Niklas”,
“lastname”: “Johansson”,
“email”: “n.j@kustitutveckling.se”,
“company_id”: 59,
“mobile_no”: “0700000000”,
“personal_number”: “19900101-1234”
}
]
}
Response for the Assign New students (single) to the teacher-led opportunity
{
“message”: “Students assigned to opportunity successfully.”,
“status”: 200,
“data”: {
“assigned_count”: 1,
“assigned”: [
{
“student_id”: “723”,
“name”: “Niklas Johansson”,
“type”: “new”
}
],
“already_assigned”: [],
“errors”: []
}
}
Request Body for the Assign Multiple New students to the teacher-led opportunity
{
“oppId”: 25,
“new_students”: [
{
“firstname”: “Niklas”,
“lastname”: “Johansson”,
“email”: “nj@quickerlearning.se”,
“company_id”: 59,
“mobile_no”: “0700000000”,
“personal_number”: “19900101-1234”
},
{
“firstname”: “Niklas”,
“lastname”: “Svensson”,
“email”: “ns@quickerlearning.se”,
“company_id”: 59,
“mobile_no”: “0701234567”,
“personal_number”: “19900101-1234”
}
]
}
Response for the Assign Multiple New students to the teacher-led opportunity
{
“message”: “Students assigned to opportunity successfully.”,
“status”: 200,
“data”: {
“assigned_count”: 2,
“assigned”: [
{
“student_id”: “722”,
“name”: “Niklas Johansson”,
“type”: “new”
},
{
“student_id”: “723”,
“name”: “Niklas Svensson”,
“type”: “new”
}
],
“already_assigned”: [],
“errors”: []
}
}
Request Body for the Existing student + New students Assign for the course opportunity
{
“oppId”: 25,
“company_id”: 73,
“old_student_ids”: [692],
“new_students”: [
{
“firstname”: “Stefan”,
“lastname”: “Johansson”,
“email”: “sj@quickerlearning.se”,
“personal_number”: “19900101-1234”,
“company_id”: 57
}
]
}
Response Body for the Existing student + New students Assign for the course opportunity
{
“message”: “Students assigned to opportunity successfully.”,
“status”: 200,
“data”: {
“assigned_count”: 2,
“assigned”: [
{
“student_id”: “692”,
“name”: “Stefan Johansson”,
“type”: “old”
},
{
“student_id”: “724”,
“name”: “Johan Svensson”,
“type”: “new”
}
],
“already_assigned”: [],
“errors”: []
}
}
