Learning Plan User Assignment

This end point is use for get list of assignment learning plan activity

[GET] /ruangkerja/dashboard/learning-plans/:learningPlanSerial/users

Information

This API contains information Assignment by Learning Plan in Ruangkerja.

See also API: Learning Plan.

Headers

NameTypeExampleRequiredDescription
Authorizationstringaccess_tokenYESToken of authentication. Get from Authentication API
Acceptstringapplication/jsonYESDefines the message format that is expected by the client
Content-Typestringapplication/jsonYESDefines the message format of the request body that is sent by the client

Parameter

NameTypeRequiredLocationDescription
pageintYESqueryQuery for skip page of collection
pageSizeintYESqueryQuery for limit result data from server. Maximum value 100
learningPlanSerialstringYESpathFilter learning plan serial

Example cURL Request 

curl --location --request GET 'https://api.ruangkerja.id/ruangkerja/dashboard/learning-plans/LRPN-YFXP3P98/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"
                },
                "avgPostTest": 80,
                "avgPreTest": 100,
                "numberOfCompleted": 2,
                "numberOfCourses": 2,
                "status": "COMPLETED"
            },
            {
                "user": {
                    "serial": "JOHNIASD318JJEL5",
                    "name": "John Smith",
                    "employeeID": "EMPLY005"
                },
                "avgPostTest": null,
                "avgPreTest": null,
                "numberOfCompleted": 0,
                "numberOfCourses": 2,
                "status": "EXPIRED"
            }
        ]
    }
}

Response Body Terminology

LocationTypeDescription
data.items.*.avgPreTestfloat64 (nullable)The value will be null if user not submit task/reached timeout
data.items.*.avgPostTestfloat64 (nullable)The value will be null if user not submit task/reached timeout
data.items.*.statusenum(NOT STARTED, IN PROGRESS, COMPLETED, EXPIRED)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.

← Learning Plan Course
User Learning Plan Activity →