Course Webinar User Assignment
This end point is use for get list of assignment webinar course
[GET] /ruangkerja/dashboard/courses/:courseSerial/webinar/:batchSerial/users
Information
This API contains information Webinar Course Assignment by Batch in Ruangkerja.
See also API: Course Batch.
Headers
| Name | Type | Example | Required | Description |
|---|---|---|---|---|
| Authorization | string | access_token | YES | Token of authentication. Get from Authentication API |
| Accept | string | application/json | YES | Defines the message format that is expected by the client |
| Content-Type | string | application/json | YES | Defines the message format of the request body that is sent by the client |
Parameter
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
| page | int | YES | query | Query for skip page of collection |
| pageSize | int | YES | query | Query for limit result data from server. Maximum value 100 |
| courseSerial | string | YES | path | Filter course serial |
| batchSerial | string | YES | path | Filter course batch serial |
Example cURL Request
curl --location --request GET 'https://api.ruangkerja.id/ruangkerja/dashboard/courses/COURSE-EXAMPLE2/webinar/BATCH-EXP-01/users?page=1&pageSize=10' \
--header 'Authorization: access_token'
Example Success Response
{
"status": "success",
"message": "Success",
"data": {
"currentPage": 1,
"totalItems": 100,
"totalPage": 10,
"items": [
...,
{
"user": {
"serial": "JOHNILXV3QAJJEL3",
"name": "John Doe",
"employeeID": "EMPLY001"
},
"absentReason": "",
"assignedCourseSerial": "ASGC-T0MHUDPV",
"feedback": "",
"isAttend": true,
"userAssignedStatus": "Cleared"
"postActivityStatus": "",
"postTestAttempt": 0,
"postTestScore": 0,
"postTestPassingScore": null
},
{
"user": {
"serial": "JOHNIASD318JJEL5",
"name": "John Smith",
"employeeID": "EMPLY005"
},
"absentReason": "",
"assignedCourseSerial": "ASGC-T0MHUDPV",
"feedback": "",
"isAttend": false,
"userAssignedStatus": "Failed"
"postActivityStatus": "",
"postTestAttempt": 0,
"postTestScore": 0,
"postTestPassingScore": null
},
{
"user": {
"serial": "JANELFMMCKASNDJM",
"name": "Jane Smith",
"employeeID": "EMPLY006"
},
"absentReason": "",
"assignedCourseSerial": "ASGC-T0MHUDPV",
"feedback": "",
"isAttend": true,
"userAssignedStatus": "Ongoing"
"postActivityStatus": "",
"postTestAttempt": 0,
"postTestScore": 0,
"postTestPassingScore": null
}
]
}
}
Response Body Terminology
| Location | Type | Description |
|---|---|---|
| data.items.*.postTestPassingScore | int (nullable) | The rules passing score |
| data.items.*.postActivityStatus | enum(NOT STARTED, IN PROGRESS, COMPLETED, EXPIRED) | The status of user post activity, Possible empty string if course doesn’t have post activity |
| data.items.*.userAssignedStatus | enum(Ongoing, Cleared, Failed) | The status of user task |
Example Failed Response
{
"errorCode": 123,
"message": "rpc error: code = PermissionDenied desc = Token is not valid",
"detail": "rpc error: code = PermissionDenied desc = Token is not valid"
}
See also: Error Dictionary.