Learning Plan

This end point is use for get list of learning plan

[GET] /ruangkerja/dashboard/learning-plans

Information

This API contains information about Learning Plan in Ruangkerja. Learning plan is a learning method that assigns participants to complete a number of courses set out in the Learning plan. Learning plan is used so that participants can complete the course sequentially according to the rules contained in the learning plan.

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
name	string	OPTIONAL	query	Filter learning plan contains name

Example cURL Request

curl --location --request GET 'https://api.ruangkerja.id/ruangkerja/dashboard/learning-plans?page=1&pageSize=10' \
--header 'Authorization: access_token'

Example Success Response

{
    "status": "success",
    "message": "Success",
    "data": {
        "currentPage": 1,
        "totalItems": 100,
        "totalPage": 10,
        "items": [
            ...,
            {
                "serial": "LRPN-YFXP3P98",
                "name": "[Learning Plan] Menjadi Software Engineer Profesional",
                "description": "",
                "createdAt": "2022-07-22T01:00:00.000Z",
                "updatedAt": "2022-07-22T01:00:00.000Z",
                "avgPostTest": null,
                "avgPreTest": null,
                "numberOfCompleted": 0,
                "numberOfCourses": 1,
                "numberOfExpired": 0,
                "numberOfFailed": 0,
                "numberOfInProgress": 0,
                "numberOfNotStarted": 0,
                "numberOfParticipants": 1
            },
            {
                "serial": "LRPN-AJSLW15D",
                "name": "[Learning Plan] Menjadi DevOps Profesional",
                "description": "",
                "createdAt": "2022-07-22T01:00:00.000Z",
                "updatedAt": "2022-07-22T01:00:00.000Z",
                "avgPostTest": 100,
                "avgPreTest": 80,
                "numberOfCompleted": 1,
                "numberOfCourses": 1,
                "numberOfExpired": 0,
                "numberOfFailed": 0,
                "numberOfInProgress": 0,
                "numberOfNotStarted": 0,
                "numberOfParticipants": 1
            }
        ]
    }
}

Response Body Terminology

Location	Type	Description
data.items.*.avgPostTest	float64 (nullable)	The value will be null when no one user submit Post-Test
data.items.*.avgPretest	float64 (nullable)	The value will be null when no one user submit Pre-Test

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"
}

Learning Plan

Information #

Headers #

Parameter #

Example cURL Request #

Example Success Response #

Response Body Terminology #

Example Failed Response #