User Course Status

This end point is use for get list of completed user course

[GET] /ruangkerja/dashboard/user-course-status

Information

This API contains information about Course status in Ruangkerja. It will present a list of user course completion, based on start and end datetime parameters.

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
startTimestamp	string	YES	query	Query param for start datetime filter (support all timezone) e.g. 2019-10-12T14:20:50+07:00
endTimestamp	string	YES	query	Query param for end datetime filter (support all timezone) e.g. 2019-10-12T14:20:50+07:00

Example cURL Request

curl --location --request GET 'https://api.ruangkerja.id/ruangkerja/dashboard/user-course-status?startTimestamp=2023-10-10T12:00:00+07:00&endTimestamp=2023-10-13T12:00:00+07:00' \
--header 'Authorization: access_token'

Example Success Response

{
    "status": "success",
    "message": "Success",
    "data": {
        "items": [
            ...,
            {
                "assignedCourseSerial": "ASGC-9O8QZE0T",
                "employeeID": "ID-1234",
                "courseName": "Mahir Menggunakan Microsoft Excel",
                "completedAt": "2023-10-12T12:00:00+07:00",
                "updatedAt": "2023-10-12T12:00:00+07:00",
                "status": "completed"
            },
            {
                "assignedCourseSerial": "ASGC-9O8QZE0T",
                "employeeID": "ID-1234",
                "courseName": "Mahir Menggunakan Microsoft Docs",
                "completedAt": "2023-10-11T12:00:00+07:00",
                "updatedAt": "2023-10-11T12:00:00+07:00",
                "status": "completed"
            }
        ]
    }
}

Response Body Terminology

Location	Type	Description
data.items.*.assignedCourseSerial	string	Serial of assigned course to user
data.items.*.employeeID	string	Employee ID of User
data.items.*.courseName	string	Name of course that completed by user
data.items.*.completedAt	string	rfc3339 string representation of completed timestamp
data.items.*.updatedAt	string	rfc3339 string representation of completed timestamp
data.items.*.status	string	enum(not_started, completed, expired, failed, in_progress)

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

User Course Status

Information #

Headers #

Parameter #

Example cURL Request #

Example Success Response #

Response Body Terminology #

Example Failed Response #