Api Contract Kampus Komerce (1.0.0)

Download OpenAPI specification:Download

E-mail: [email protected] License: Apache 2.0 Terms of Service

This is an Api Contract for Kampus Komerce project. use Token to consumes endpoint.

Authentication

Bearer

Security Scheme Type	API Key
Header parameter name:	Authorization

Auth

Everything about Auth

Logs user into the system

Request Body schema: application/json

username required	string
password required	string <password>

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "pa$$word"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"code": "200",
"data": {"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiMGQyMzE4NTg0YWNmYTU4MGQxYjM1ZWM1NzczNTFlYThjYzY2ZTA4MjNhODdkMWZiODJlYjVlYWQxYTUxNzA1M2RhMjVmYTk0MGI2NzExMDEiLCJpYXQiOjE2MjczNjc3MjMsIm5iZiI6MTYyNzM2NzcyMywiZXhwIjoxNjU4OTAzNzIzLCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Swq2EdjNWL7JrRZFu1Gh9x5ZHwo7jmCioZz4Z19IQB2rTIGUDyhkds276ZzPHh-pDwkrD2uEWhceOuXrKnlOwtvJOu3Kf3VymsabIKqJpb8e4dq76FWPbUD6k-WexL7QKQan9gH1LwoQey2nMKFi5hd7_3A9sFLRrQerqh3qugWdD7RqqYS3vYY9M3VqHf108w5iQa_GHkRx2KRv0PxRVRqofkTCBBf-Oc-kcvLkau8N6BVojkYDJ8Cl8uG5XcS0F1RjbNy6SuiuTyqq1BqaZmcasi87zwJEeuJSgdqBfnNch608impEBu9q_ON1kMIgK9LZvqL8_Uk1vP5qosUq39VgJj8qbFDpCKsKus6fjO78G-zeYbZ32D-s03QwPr9FkwoZXg_HaiyTDvsbTcgH63wU-Q7ycor8IgSKPsfkJN1OytohleJMWYOObiN-IKqKGbXnf85DnJrhZuOZB9tQdoq4fIXYx68LQgmiLSVemXUbHMtRmXbYWwAIFy3QexPRGtHxK8wCzqEH-whXh66RKBy31gf1Fu9wxHHEb95U_UfYYynbbDxapwurJHzgxUswdBWDNguNoAJZslZfwVMguAmgtylFvNYzIlEWkENTk5fcTNOJsmVWDYuO-QJyWwCStB7_a7jcPFHLqcs7pwu9cvV-X1__x0BgRD6E9VBfYQg",
"token_type": "Bearer",
"expires_at": "2022-07-27 13:35:23",
"user_id": "1",
"username": "john_doe",
"img_path": "https://example.com/img/johndoe-90923498934892834.jpg"
}
}

Log out from application

Authorizations:

Bearer

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"code": "200",
"message": "logout successful"
}

Send link to forgot password

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"code": "200",
"message": "Forgot passwword link has been sent to your email"
}

Update Password

query Parameters

email required	string get email from deep link
password required	string New password, 8 character minimum

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"code": "200",
"message": "Password changed successfully"
}

Change password for authenticate user

Authorizations:

Bearer

query Parameters

old_password required	string old password
new_password required	string New password, 8 character minimum

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"code": "200",
"message": "Password changed successfully"
}

refresh-token

Authorizations:

Bearer

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"code": "200",
"message": "Refresh Token successful",
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiMGQyMzE4NTg0YWNmYTU4MGQxYjM1ZWM1NzczNTFlYThjYzY2ZTA4MjNhODdkMWZiODJlYjVlYWQxYTUxNzA1M2RhMjVmYTk0MGI2NzExMDEiLCJpYXQiOjE2MjczNjc3MjMsIm5iZiI6MTYyNzM2NzcyMywiZXhwIjoxNjU4OTAzNzIzLCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Swq2EdjNWL7JrRZFu1Gh9x5ZHwo7jmCioZz4Z19IQB2rTIGUDyhkds276ZzPHh-pDwkrD2uEWhceOuXrKnlOwtvJOu3Kf3VymsabIKqJpb8e4dq76FWPbUD6k-WexL7QKQan9gH1LwoQey2nMKFi5hd7_3A9sFLRrQerqh3qugWdD7RqqYS3vYY9M3VqHf108w5iQa_GHkRx2KRv0PxRVRqofkTCBBf-Oc-kcvLkau8N6BVojkYDJ8Cl8uG5XcS0F1RjbNy6SuiuTyqq1BqaZmcasi87zwJEeuJSgdqBfnNch608impEBu9q_ON1kMIgK9LZvqL8_Uk1vP5qosUq39VgJj8qbFDpCKsKus6fjO78G-zeYbZ32D-s03QwPr9FkwoZXg_HaiyTDvsbTcgH63wU-Q7ycor8IgSKPsfkJN1OytohleJMWYOObiN-IKqKGbXnf85DnJrhZuOZB9tQdoq4fIXYx68LQgmiLSVemXUbHMtRmXbYWwAIFy3QexPRGtHxK8wCzqEH-whXh66RKBy31gf1Fu9wxHHEb95U_UfYYynbbDxapwurJHzgxUswdBWDNguNoAJZslZfwVMguAmgtylFvNYzIlEWkENTk5fcTNOJsmVWDYuO-QJyWwCStB7_a7jcPFHLqcs7pwu9cvV-X1__x0BgRD6E9VBfYQg"
}

Register new user

query Parameters

email required	string email active
password required	string <password> Password, 8 character minimum

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"code": "200",
"message": "Register success."
}

Class

Admin to manage class

Returns class data

action add, edit, delete

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"class_id": "1",
"class_skill": "Advertiser",
"total_module": "5",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"class_status": "publish"
}
]
}

Get class by class_id

Authorizations:

Bearer

path Parameters

class_id

required

string

class_id from class list. This responses can be applied at edit page and detail page

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"class_id": "1",
"class_skill": "Advertiser",
"class_trailer_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"class_trailer_url": "https://example.com/videos/class/class-020292829282928.3gp",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"class_status": "publish"
}
}

Store new Class

Authorizations:

Bearer

query Parameters

class_skill required	string Enum: "Advertiser" "Customer Service" "Admin Marketplace" Post the id from class_skill
class_trailer_url required	string video url
class_trailer_description required	string short explanation of the class
class_status required	string Enum: "draft" "publish" publish status

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Class has been stored successfully."
}

Update current Class

Authorizations:

Bearer

query Parameters

class_skill required	string Enum: "Advertiser" "Customer Service" "Admin Marketplace" Post the id from class_skill
class_trailer_url required	string video url
class_trailer_description required	string short explanation of the class
class_status required	string Enum: "draft" "publish" publish status

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"class_id": "1",
"class_skill": "Advertiser",
"class_trailer_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"class_trailer_url": "https://example.com/videos/class/class-020292829282928.3gp",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"class_status": "publish"
}
}

Delete Class

Rules: cannot delete class if class has module, if class already publish, if class already has user joined

Authorizations:

Bearer

query Parameters

class_id

required

integer

id of the class

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Class has been deleted successfully."
}

Module

Admin to manage module

Returns module data

action add, edit, delete

Authorizations:

Bearer

query Parameters

class_id

required

integer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"class_id": "1",
"class_skill": "Advertiser",
"modules": [{"module_id": "1",
"module_class_id": "1",
"module_title": "Modul 1",
"module_subtitle": "Subtitle 1.A",
"module_trainer": "John Doe",
"module_thumbnail": "https://example.com/img/module/module-020292829282928.jpg",
"module_status": "publish"
}
]
}
}

Get module by module_id

Authorizations:

Bearer

path Parameters

module_id

required

string

module_id from module list. This responses can be applied at edit page and detail page

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"module_id": "1",
"module_class_id": "1",
"module_title": "Lorem ipsum dolor sit amet",
"module_subtitle": "Lorem ipsum dolor sit amet",
"module_trainer": "John Doe",
"module_thumbnail": "https://example.com/img/module/module-020292829282928.jpg",
"module_status": "publish"
}
}

Store new Module

Authorizations:

Bearer

query Parameters

module_title required	string Unique values. Duplicate module_title not allowed
module_subtitle required	string
module_trainer required	integer select option
module_status required	string Enum: "draft" "publish" publish status
module_class_id required	integer

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Module has been stored successfully."
}

Update current Module

Authorizations:

Bearer

query Parameters

module_title required	string Unique values. Duplicate module_title not allowed
module_subtitle required	string
module_trainer required	integer select option
module_status required	string Enum: "draft" "publish" publish status

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"module_id": "1",
"module_class_id": "1",
"module_title": "Lorem ipsum dolor sit amet",
"module_subtitle": "Lorem ipsum dolor sit amet",
"module_trainer": "John Doe",
"module_thumbnail": "https://example.com/img/module/module-020292829282928.jpg",
"module_status": "publish"
}
}

Delete Module

Rules: cannot delete module if module has lessons, if module already publish

Authorizations:

Bearer

query Parameters

module_id

required

integer

id of the module

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Module has been deleted successfully."
}

Lesson

Admin to manage Lesson

Returns lesson data

action add, edit, delete

Authorizations:

Bearer

query Parameters

module_id

required

integer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"module_id": "1",
"module_title": "Module 1",
"module_subtitle": "Module 1",
"module_status": "publish",
"module_trainer_name": "John Doe",
"module_thumbnail": "https://example.com/img/module/module-020292829282928.jpg",
"lessons": [{"lesson_id": "1",
"lesson_module_id": "1",
"lesson_title": "Lesson 1",
"lesson_thumbnail": "https://example.com/img/lesson/lesson-020292829282928.jpg",
"lesson_video_url": "https://example.com/img/lesson/lesson-020292829282928.3gp",
"lesson_video_description": "Lorem ipsum dolor sit amet",
"lesson_status": "publish"
}
]
}
}

Returns lesson data

action add, edit, delete

Authorizations:

Bearer

path Parameters

module_id required	integer
filter_title required	integer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"module_id": "1",
"module_title": "Module 1",
"module_subtitle": "Module 1",
"module_status": "publish",
"module_trainer_name": "John Doe",
"module_thumbnail": "https://example.com/img/module/module-020292829282928.jpg",
"lessons": [{"lesson_id": "1",
"lesson_module_id": "1",
"lesson_title": "Lesson 1",
"lesson_thumbnail": "https://example.com/img/lesson/lesson-020292829282928.jpg",
"lesson_video_url": "https://example.com/img/lesson/lesson-020292829282928.3gp",
"lesson_video_description": "Lorem ipsum dolor sit amet",
"lesson_status": "publish"
}
]
}
}

Get lesson by lesson_id

Authorizations:

Bearer

path Parameters

lesson_id

required

string

lesson_id from lesson list. This responses can be applied at edit page and detail page

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"lesson_id": "1",
"lesson_module_id": "1",
"lesson_title": "Modul 1",
"lesson_thumbnail": "https://example.com/img/lesson/lesson-020292829282928.jpg",
"lesson_video_url": "https://example.com/img/lesson/lesson-020292829282928.3gp",
"lesson_video_description": "Lorem ipsum dolor sit amet",
"edumo_lesson_id": "dee303e7-0381-4f07-8eb3-71115ceeb71c",
"lesson_status": "publish"
}
}

Store new Lesson

Authorizations:

Bearer

query Parameters

lesson_title required	string Unique values. Duplicate lesson_title not allowed
lesson_video_description required	string
lesson_video_url required	string
lesson_status required	string Enum: "draft" "publish" publish status
lesson_class_id required	integer

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Lesson has been stored successfully."
}

Update current Lesson

Authorizations:

Bearer

query Parameters

lesson_title required	string Unique values. Duplicate lesson_title not allowed
lesson_video_description required	string
lesson_video_url required	string
lesson_status required	string Enum: "draft" "publish" publish status
lesson_class_id required	integer

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"lesson_id": "1",
"lesson_module_id": "1",
"lesson_title": "Modul 1",
"lesson_thumbnail": "https://example.com/img/lesson/lesson-020292829282928.jpg",
"lesson_video_url": "https://example.com/img/lesson/lesson-020292829282928.3gp",
"lesson_video_description": "Lorem ipsum dolor sit amet",
"edumo_lesson_id": "dee303e7-0381-4f07-8eb3-71115ceeb71c",
"lesson_status": "publish"
}
}

Delete Lesson

Rules: cannot delete lesson if lesson has lessons, if lesson already publish

Authorizations:

Bearer

query Parameters

lesson_id

required

integer

id of the lesson

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Lesson has been deleted successfully."
}

Quiz

Admin to manage Quiz

Returns quiz data

action add, edit, delete

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"lesson_id": "1",
"quiz_id": "dee303e7-0381-4f07-8eb3-71115ceebkj0",
"question": [{"id": "dee303e7-0381-4f07-8eb3-71115ceeb71c",
"question": "1 + 1 =",
"type": "text",
"answers_type": "choices",
"position": "0",
"answers": [{"id": "4ba0ba74-f1ca-4944-9d0c-aa1f97139d77",
"answer": "2",
"correct_answer": true,
"position": 0
},
{"id": "59a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "3",
"correct_answer": false,
"position": 1
},
{"id": "56a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "5",
"correct_answer": false,
"position": 2
},
{"id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "4",
"correct_answer": false,
"position": 3
}
]
}
]
}
}

Returns quiz data

Authorizations:

Bearer

Request Body schema: application/json

quiz_id	uuid
question_id	uuid
question	string
type	string
answers_type	string
position	integer
	Array of objects (answers) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"quiz_id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"question_id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"question": "1 + 1 =",
"type": "text",
"answers_type": "choices",
"position": "0",
"answers": [{"id": "4ba0ba74-f1ca-4944-9d0c-aa1f97139d77",
"answer": "2",
"correct_answer": true,
"position": 0
},
{"id": "59a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "3",
"correct_answer": false,
"position": 1
},
{"id": "56a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "5",
"correct_answer": false,
"position": 2
},
{"id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "4",
"correct_answer": false,
"position": 3
}
]
}

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "quiz has been stored successfully."
}

quiz-update

Authorizations:

Bearer

Request Body schema: application/json

quiz_id	uuid
question_id	uuid
question	string
type	string
answers_type	string
position	integer
	Array of objects (answers) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"quiz_id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"question_id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"question": "1 + 1 =",
"type": "text",
"answers_type": "choices",
"position": "0",
"answers": [{"id": "4ba0ba74-f1ca-4944-9d0c-aa1f97139d77",
"answer": "2",
"correct_answer": true,
"position": 0
},
{"id": "59a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "3",
"correct_answer": false,
"position": 1
},
{"id": "56a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "5",
"correct_answer": false,
"position": 2
},
{"id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "4",
"correct_answer": false,
"position": 3
}
]
}

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"id": "dee303e7-0381-4f07-8eb3-71115ceeb71c",
"question": "1 + 1 =",
"type": "text",
"answers_type": "choices",
"position": "0",
"answers": [{"id": "4ba0ba74-f1ca-4944-9d0c-aa1f97139d77",
"answer": "2",
"correct_answer": true,
"position": 0
},
{"id": "59a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "3",
"correct_answer": false,
"position": 1
},
{"id": "56a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "5",
"correct_answer": false,
"position": 2
},
{"id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "4",
"correct_answer": false,
"position": 3
}
]
}
}

Delete question

Rules: cannot delete question if quiz has user joined

Authorizations:

Bearer

query Parameters

question_id

required

uuid

id of the question

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "question has been deleted successfully."
}

Trainer

Admin to manage Trainer

Returns trainer data

action add, edit, delete

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"id": "1",
"name": "john doe",
"skill_id": "Advertiser",
"phone": "081 2214 211214",
"email": "[email protected]",
"photo_profile": "https://example.com/img/trainer/user-020292829282928.jpg",
"bank_name": "BCA",
"bank_account_number": "3909199187",
"bank_account_name": "John Doe",
"npwp": "1212187873651",
"cv": "https://example.com/cv/johndoe-90923498934892834.pdf",
"province": {"id": 1002,
"name": "Jawa Tengah"
},
"regency": {"id": 1011,
"name": "Purbalingga"
},
"district": {"id": 1092,
"name": "Karangmoncol"
},
"address": "jl. Karangmoncol no 21 a rt 10 rw IV",
"xml": null
}
]
}

Returns trainer data

action add, edit, delete

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"schema": {"id": "1",
"name": "john doe",
"skill_id": "Advertiser",
"phone": "081 2214 211214",
"email": "[email protected]",
"photo_profile": "https://example.com/img/trainer/user-020292829282928.jpg",
"bank_name": "BCA",
"bank_account_number": "3909199187",
"bank_account_name": "John Doe",
"npwp": "1212187873651",
"cv": "https://example.com/cv/johndoe-90923498934892834.pdf",
"province": {"id": 1002,
"name": "Jawa Tengah"
},
"regency": {"id": 1011,
"name": "Purbalingga"
},
"district": {"id": 1092,
"name": "Karangmoncol"
},
"address": "jl. Karangmoncol no 21 a rt 10 rw IV",
"xml": null
}
}

Returns trainer data

Authorizations:

Bearer

query Parameters

name required	string name
skill_id required	string Enum: "Advertiser" "Customer Service" "Admin Marketplace" Post the id from skill_id
phone required	string phone
email required	string email
bank_name required	string bank_name
bank_account_number required	string bank_account_number
bank_account_name required	string bank_account_name
npwp required	string npwp
province_id required	integer
regency_id required	integer
distric_id required	integer
address required	string detail address

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Trainer has been stored successfully."
}

trainer-update

Authorizations:

Bearer

Request Body schema: application/json

id	integer
name	string
skill_id	integer Enum: "Advertiser" "Customer Service" "Admin Marketplace"
phone	string
email	string
photo_profile	string
bank_name	string
bank_account_number	char
bank_account_name	string
npwp	char
cv	string
province_id	char
regency_id	char
distric_id	char
address	string

Responses

Request samples

Payload

Content type

application/json

{"id": "1",
"name": "john doe",
"skill_id": "Advertiser",
"phone": "081 2214 211214",
"email": "[email protected]",
"photo_profile": "https://example.com/img/trainer/user-020292829282928.jpg",
"bank_name": "BCA",
"bank_account_number": "3909199187",
"bank_account_name": "John Doe",
"npwp": "1212187873651",
"cv": "https://example.com/cv/johndoe-90923498934892834.pdf",
"province_id": "1212",
"regency_id": "1000",
"distric_id": "1090",
"address": "jl. Karangmoncol no 21 a rt 10 rw IV"
}

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "trainer has been updated successfully."
}

Delete trainer

Rules: cannot delete trainer if trainer has lessons

Authorizations:

Bearer

query Parameters

trainer_id

required

uuid

id of the trainer

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "trainer has been deleted successfully."
}

Dashboard

Admin Dashboard

Returns dasboard data

Data for admin dashboard, cart object filtered by default with start_date = {current_year}/01/01 and end_date = {current_year}/12/31

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"class": [{"class_skill": "Advertiser",
"total_student_joined": 1000,
"total_student_finished": 710,
"progress_student": 71
},
{"class_skill": "Customer Service",
"total_student_joined": 2121,
"total_student_finished": 1211,
"progress_student": 67
},
{"class_skill": "Admin Marketplace",
"total_student_joined": 1444,
"total_student_finished": 311,
"progress_student": 21
}
],
"cart": {"student_joined": 35,
"student_finished": 800,
"lines": {"joined": [{"total": "190",
"date": "2021-03-11"
}
],
"finished": [{"total": "190",
"date": "2021-03-11"
}
]
}
},
"certificate_downloaded": 2300
}
}

Returns dasboard data

only return data for displaying cart

Authorizations:

Bearer

query Parameters

start_date	string <YY/MM/DD> Example: start_date=2021/01/01
end_date	string <YY/MM/DD> Example: end_date=2021/12/31

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"cart": {"student_joined": 35,
"student_finished": 800,
"lines": {"joined": [{"total": "190",
"date": "2021-03-11"
}
],
"finished": [{"total": "190",
"date": "2021-03-11"
}
]
}
}
}
}

Report

Admin Report

Returns my class data

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"joined": [{"class_skill": "Advertiser",
"student": [{"student_user_id": 1,
"student_name": "Bambang",
"student_score": "90",
"student_finished_at": "12/11/2021"
},
{"student_user_id": 2,
"student_name": "Bambang 2",
"student_score": "80",
"student_joined_at": "12/12/2021"
}
]
}
],
"finished": [{"class_skill": "Advertiser",
"student": [{"student_user_id": 1,
"student_name": "Bambang",
"student_score": "90",
"student_finished_at": "12/11/2021"
},
{"student_user_id": 2,
"student_name": "Bambang 2",
"student_score": "80",
"student_joined_at": "12/12/2021"
}
]
}
]
}
}

Public-object

Returns province, district, regency data

get data

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"province_id": "1002",
"province_name": "JAWA TENGAH",
"regencies": [{"regency_id": "1992",
"regency_name": "PURBALINGGA",
"districts": [{"district_id": 1212,
"district_name": "TEUPAH SELATAN"
},
{"district_id": 1212,
"district_name": "SIMEULUE TIMUR"
},
{"district_id": 1212,
"district_name": "TEUPAH BARAT"
},
{"district_id": 1212,
"district_name": "TEUPAH TENGAH"
},
{"district_id": 1212,
"district_name": "SIMEULUE TENGAH"
}
]
}
]
}
]
}

Returns Skill data

Get Skill data

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"skill_id": "1",
"skill_name": "Advertiser"
}
]
}

Profile

Manage Profile

Returns profile data

action add, edit, delete

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"user_id": "1",
"user_name": "adv123",
"user_fullname": "Advertiser",
"user_img": "https://example.com/img/user/user-020292829282928.jpg",
"user_birth_date": "31/12/1990",
"user_gender": "1 | Laki-laki",
"user_marital_status": "0 | Belum Menikah",
"user_email": "[email protected]",
"user_phone": "081212323454",
"user_province_id": "1000",
"user_regency_id": "1000",
"user_district_id": "1000",
"user_education": "Sarjana",
"user_address": "jln. Karangmoncol no 13",
"user_has_work_experience": 1,
"user_work_experience": "< 1 year"
}
]
}

Get user by user_id

Authorizations:

Bearer

path Parameters

user_id

required

string

user_id from list. This responses can be applied at edit page and detail page

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"user_id": "1",
"user_name": "Adv123",
"user_fullname": "Advertiser",
"user_img": "https://example.com/img/user/user-020292829282928.jpg",
"user_birth_date": "31/12/1990",
"user_gender": "1 | Laki-laki",
"user_marital_status": "0 | Belum Menikah",
"user_email": "[email protected]",
"user_phone": "081212323454",
"user_province_id": "1000",
"user_regency_id": "1000",
"user_district_id": "1000",
"user_education": "Sarjana",
"user_address": "jln. Karangmoncol no 13",
"user_has_work_experience": 1,
"user_work_experience": "< 1 year",
"user_course_score": "100",
"user_certificate": "https://example.com/certificate/user-020292829282928.pdf"
}
}

Check profile complete

Authorizations:

Bearer

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"is_complete": true
}
}

Store new Profile Deprecated

Authorizations:

Bearer

query Parameters

user_name required	string user_name
user_birth_date required	date <dd-mm-yyyy> user_birth_date
user_gender required	enum Enum: "1 \| Laki-laki" "2 \| Perempuan" user_gender
user_marital_status required	enum Enum: "0 \| Belum Menikah" "1 \| Menikah" "else \| -" user_marital_status
user_email required	string user_email
user_phone required	string user_phone
user_province_id required	integer user_province_id
user_regency_id required	integer user_regency_id
user_regency_id required	integer user_regency_id
user_education required	enum Enum: "Sarjana" "SMA/SMK" "SMP" "SD" user_education
user_address required	string user_address
user_email required	string user_email
user_has_work_experience required	boolean 1=true,0=false
user_work_experience required	enum Enum: "< 1 year" "1 year" "2 years" "3 years" user_work_experience

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Profile has been stored successfully."
}

Update current Profile

send only field which need to be updated, no need to sent all the field.

Authorizations:

Bearer

query Parameters

user_fullname	string user_fullname
user_birth_date	date <dd-mm-yyyy> user_birth_date
user_gender	enum Enum: "1 \| Laki-laki" "2 \| Perempuan" user_gender
user_marital_status	enum Enum: "0 \| Belum Menikah" "1 \| Menikah" "else \| -" user_marital_status
user_email	string user_email
user_phone	string user_phone
user_province_id	integer user_province_id
user_regency_id	integer user_regency_id
user_regency_id	integer user_regency_id
user_education	enum Enum: "Sarjana" "SMA/SMK" "SMP" "SD" user_education
user_address	string user_address
user_email	string user_email
user_has_work_experience	boolean 1=true,0=false
user_work_experience	enum Enum: "< 1 year" "1 year" "2 years" "3 years" user_work_experience

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"user_id": "1",
"user_name": "Adv123",
"user_fullname": "Advertiser",
"user_img": "https://example.com/img/user/user-020292829282928.jpg",
"user_birth_date": "31/12/1990",
"user_gender": "1 | Laki-laki",
"user_marital_status": "0 | Belum Menikah",
"user_email": "[email protected]",
"user_phone": "081212323454",
"user_province_id": "1000",
"user_regency_id": "1000",
"user_district_id": "1000",
"user_education": "Sarjana",
"user_address": "jln. Karangmoncol no 13",
"user_has_work_experience": 1,
"user_work_experience": "< 1 year",
"user_course_score": "100",
"user_certificate": "https://example.com/certificate/user-020292829282928.pdf"
}
}

no-auth

get data without auth

Returns class only published class

action view

Responses

Response samples

200
503

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"class_id": "1",
"class_skill": "Advertiser",
"total_module": "5",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"class_status": "publish"
}
]
}

Get class by class_id for no auth user

path Parameters

class_id

required

string

class_id from class list. This responses can be applied at detail page

Responses

Response samples

200
400
503

Content type

application/json

{"status": "success",
"code": "200",
"data": {"class_id": "1",
"class_skill": "Advertiser",
"class_trailer_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"class_trailer_url": "https://example.com/videos/class/class-020292829282928.3gp",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"class_status": "publish"
}
}

Returns only published testimonial data

action view detail

Responses

Response samples

200
503

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"testimonial_id": "1",
"testimonial_url": "www.blog.com/articles/user-020292829282928",
"testimonial_image": "https://example.com/img/testimonial/testimonial-020292829282928.jpg",
"user_fullname": "John Doe",
"testimonial_description": "Lorem ipsum dolor sit amet",
"user_img": "https://example.com/user/user-020292829282928.jpg"
}
]
}

Student-Class

Student Class

Returns only published class data

action show detail, join

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"class_id": "1",
"class_skill": "Advertiser",
"total_module": "5",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"class_trailer_url": {"otp": "20160313versASE3237sLsL5eYqzwAWu3mUCasE3xzQZa7qkeVgSpbxxkXiR8Gg5",
"playbackInfo": "eyJ2aWRlb0lkIjoiZWRhYThiNjU2MmIxNGY2NmJkZTY0NmNmMGJmY2Q2ZDIifQ=="
},
"class_trailer_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"class_status": "publish"
}
]
}

Get class by class_id

Authorizations:

Bearer

path Parameters

class_id

required

string

class_id from class list. This responses can be applied at edit page and detail page

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"class_id": "1",
"class_skill": "Advertiser",
"total_module": "5",
"user_joined": "50",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"class_trailer_url": {"otp": "20160313versASE3237sLsL5eYqzwAWu3mUCasE3xzQZa7qkeVgSpbxxkXiR8Gg5",
"playbackInfo": "eyJ2aWRlb0lkIjoiZWRhYThiNjU2MmIxNGY2NmJkZTY0NmNmMGJmY2Q2ZDIifQ=="
},
"class_trailer_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"class_status": "publish",
"is_joined": true
}
}

Get class with module. only published class and module

Authorizations:

Bearer

path Parameters

class_id

required

string

class_id from class list. This responses can be applied at edit page and detail page

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"class_id": "1",
"class_skill": "Advertiser",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"modules": [{"module_id": "1",
"module_title": "Modul 1",
"module_subtitle": "Subtitle 1.A",
"module_thumbnail": "https://example.com/img/module/module-020292829282928.jpg"
}
]
}
}

join Class

generate row for my-module and my-lesson which the first object`s status is unlocked and the rest are locked.

Authorizations:

Bearer

query Parameters

class_id

required

int

Example: class_id=1

Post the id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Class has been stored successfully."
}

Student-Module

Student Module

Get module with Lesson . only published module and Lesson

Authorizations:

Bearer

path Parameters

module_id

required

string

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"module_id": "success",
"module_title": "Module 1",
"module_subtitle": "Module 1",
"module_status": "publish",
"module_trainer_name": "John Doe",
"module_thumbnail": "https://example.com/img/module/module-020292829282928.jpg",
"class_name": "Advertiser",
"lessons": [{"lesson_id": "1",
"lesson_module_id": "1",
"lesson_title": "Modul 1",
"lesson_thumbnail": "https://example.com/img/lesson/lesson-020292829282928.jpg",
"lesson_video_url": "https://example.com/img/lesson/lesson-020292829282928.3gp",
"lesson_video_description": "Lorem ipsum dolor sit amet",
"lesson_status": "publish"
}
]
}
}

Student-Quiz

Student Quiz

Returns quiz data

Authorizations:

Bearer

query Parameters

lesson_id

required

int

Example: lesson_id=1

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"lesson_id": "1",
"quiz_id": "dee303e7-0381-4f07-8eb3-71115ceebkj0",
"question": [{"id": "dee303e7-0381-4f07-8eb3-71115ceeb71c",
"question": "1 + 1 =",
"type": "text",
"answers_type": "choices",
"position": "0",
"answers": [{"id": "4ba0ba74-f1ca-4944-9d0c-aa1f97139d77",
"answer": "2",
"correct_answer": true,
"position": 0
},
{"id": "59a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "3",
"correct_answer": false,
"position": 1
},
{"id": "56a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "5",
"correct_answer": false,
"position": 2
},
{"id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "4",
"correct_answer": false,
"position": 3
}
]
}
]
}
}

My-Class

Class which joined

Returns my class data

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"my_class_id": "1",
"class_id": "1",
"class_skill": "Advertiser",
"total_module": "5",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"class_progress": "70"
}
]
}

My-Module

Module which joined

Returns my module data

class_id = id from lms_class_id

Authorizations:

Bearer

query Parameters

class_id

required

string

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"my_class_id": "1",
"class_id": "1",
"class_skill": "Advertiser",
"module": [{"my_module_id": "1",
"module_title": "Modul 1",
"module_trainer": "John Doe",
"my_module_status": "unlocked"
}
]
}
}

My-Lesson

lesson which joined

Returns my lesson data

Authorizations:

Bearer

query Parameters

module_id

required

string

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"trainer_img": "https://example.com/img/trainer-020292829282928.jpg",
"class_trainer": "1",
"class_skill": "Advertiser",
"lesson_title": "First Lesson",
"lesson_video_url": {"otp": "20160313versASE3237sLsL5eYqzwAWu3mUCasE3xzQZa7qkeVgSpbxxkXiR8Gg5",
"playbackInfo": "eyJ2aWRlb0lkIjoiZWRhYThiNjU2MmIxNGY2NmJkZTY0NmNmMGJmY2Q2ZDIifQ=="
},
"lesson_video_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"lesson_thumbnail": "https://example.com/img/lesson/user-020292829282928",
"lessons": [{"my_lesson_id": 1,
"lesson_id": 11,
"lesson_title": "Lorem ipsum dolor sit amet",
"lesson_thumbnail": "https://example.com/img/lesson/lesson11-020292829282928.jpg",
"lesson_video_url": "https://example.com/img/lesson/lesson11-020292829282928.3gp",
"lesson_video_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"my_lesson_status": "unlocked"
},
{"my_lesson_id": 2,
"lesson_id": 12,
"lesson_title": "Lorem ipsum dolor sit amet",
"lesson_thumbnail": "https://example.com/img/lesson/lesson12-020292829282928.jpg",
"lesson_video_url": "https://example.com/img/lesson/lesson12-020292829282928.3gp",
"lesson_video_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"my_lesson_status": "locked"
},
{"my_lesson_id": 3,
"lesson_id": 13,
"lesson_title": "Lorem ipsum dolor sit amet",
"lesson_thumbnail": "https://example.com/img/lesson/lesson13-020292829282928.jpg",
"lesson_video_url": "https://example.com/img/lesson/lesson13-020292829282928.3gp",
"lesson_video_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"my_lesson_status": "locked"
}
]
}
}

My-Quiz

My Quiz which joined

Returns quiz data

answers sort by position

Authorizations:

Bearer

query Parameters

lesson_id

required

integer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"lesson_id": "1",
"quiz_id": "dee303e7-0381-4f07-8eb3-71115ceebkj0",
"question": [{"id": "dee303e7-0381-4f07-8eb3-71115ceeb71c",
"question": "1 + 1 =",
"type": "text",
"answers_type": "choices",
"position": "0",
"answers": [{"id": "4ba0ba74-f1ca-4944-9d0c-aa1f97139d77",
"answer": "2",
"correct_answer": true,
"position": 0
},
{"id": "59a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "3",
"correct_answer": false,
"position": 1
},
{"id": "56a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "5",
"correct_answer": false,
"position": 2
},
{"id": "55a0ba74-f1ca-4944-9d0c-bb2397139d7k",
"answer": "4",
"correct_answer": false,
"position": 3
}
]
}
]
}
}

Submit Quiz to save score

if score > 50 then is_pass = 1 and finish lesson, and unlocked next lesson or finish lesson, or unlocked new module or finish module, or finish class

Authorizations:

Bearer

Request Body schema: application/json

lesson_id	integer
score	integer

Responses

Request samples

Payload

Content type

application/json

{"lesson_id": "1",
"score": "70"
}

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Quiz Finished!"
}

My-Certificate

Returns my certificate data

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"my_class_id": "1",
"class_id": "1",
"class_skill": "Advertiser",
"class_img": "https://example.com/img/class/class-020292829282928.jpg"
}
]
}

Returns my certificate data

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": {"my_class_id": "1",
"class_id": "1",
"class_skill": "Advertiser",
"class_img": "https://example.com/img/class/class-020292829282928.jpg",
"my_class_certificate_url": "https://example.com/certificate/class-020292829282928.pdf",
"class_group_url": "https://t.me/Advertiser"
}
}

notification

user notification

Returns my certificate data

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"data": [{"notif_id": "1",
"notif_title": "Sertifikat Terbit",
"notif_message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"notif_is_read": 1
}
]
}

Delete notification

Authorizations:

Bearer

query Parameters

notif_id

required

integer

id of the notification

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Notification has been deleted successfully."
}

Read Notification

Authorizations:

Bearer

query Parameters

notif_id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Notification updated successfully."
}

Read All Notification

Authorizations:

Bearer

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"code": "200",
"message": "Notification updated successfully."
}