openapi: 3.0.3
info:
title: 'API Qiroah'
description: 'Here is a list of APIs used for integration to other Apps, for more information please see Documentation'
version: 1.0.0
servers:
-
url: 'https://api.qiroah.com'
paths:
/api/auth/google:
post:
summary: 'Get Access Token via GoogleSignIn'
operationId: getAccessTokenViaGoogleSignIn
description: 'This endpoint allows you to get the token for user access to the authenticated endpoints using GoogleSignIn.'
parameters: []
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": {\n \"access_token\": string,\n \"token_type\": string,\n \"expires_at\": int,\n \"email\": string,\n \"is_profile_complete\": boolean,\n }\n}"
400:
description: 'idToken is not verified'
content:
application/json:
schema:
type: object
example:
status: 400
message: 'idToken is not verified'
error: true
properties:
status:
type: integer
example: 400
message:
type: string
example: 'idToken is not verified'
error:
type: boolean
example: true
403:
description: 'Account user not found'
content:
application/json:
schema:
type: object
example:
status: 403
message: 'Account user not found'
error: true
properties:
status:
type: integer
example: 403
message:
type: string
example: 'Account user not found'
error:
type: boolean
example: true
500:
description: 'Internal Server Error'
content:
application/json:
schema:
type: object
example:
status: 500
message: 'Internal Server Error'
error: true
properties:
status:
type: integer
example: 500
message:
type: string
example: 'Internal Server Error'
error:
type: boolean
example: true
tags:
- Account
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id_token:
type: string
description: 'Must be valid JWT GoogleID'
example: null
required:
- id_token
security: []
/api/auth/register:
post:
summary: 'Register via Form'
operationId: registerViaForm
description: 'This endpoint allows you to create user account via Registration Form.'
parameters: []
responses:
201:
description: Created
content:
application/json:
schema:
type: object
example:
status: 201
error: false
properties:
status:
type: integer
example: 201
error:
type: boolean
example: false
403:
description: 'Email already registered'
content:
application/json:
schema:
type: object
example:
status: 403
message: 'Email already registered'
error: true
properties:
status:
type: integer
example: 403
message:
type: string
example: 'Email already registered'
error:
type: boolean
example: true
500:
description: 'Internal Server Error'
content:
application/json:
schema:
type: object
example:
status: 500
message: 'Internal Server Error'
error: true
properties:
status:
type: integer
example: 500
message:
type: string
example: 'Internal Server Error'
error:
type: boolean
example: true
tags:
- Account
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Must be a valid email address and not be greater than 100 characters.'
example: null
name:
type: string
description: 'Must not be greater than 50 characters.'
example: null
gender:
type: string
description: 'Must be one of Laki - Laki or Perempuan.'
example: null
whatsapp:
type: number
description: 'Must be at least 10.'
example: 63
required:
- email
- name
- gender
- whatsapp
security: []
/api/auth/logout:
get:
summary: 'Revoke The Access Token'
operationId: revokeTheAccessToken
description: 'This endpoint allows you to revoke the token.'
parameters: []
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
status: 200
error: false
properties:
status:
type: integer
example: 200
error:
type: boolean
example: false
401:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
status: 401
message: Unauthorized
error: true
properties:
status:
type: integer
example: 401
message:
type: string
example: Unauthorized
error:
type: boolean
example: true
tags:
- Account
/api/users:
get:
summary: 'Get Profile User by ID'
operationId: getProfileUserByID
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id\": int,\n \"name\": string,\n \"avatar\": string\n }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
status: 401
message: Unauthorized
error: true
properties:
status:
type: integer
example: 401
message:
type: string
example: Unauthorized
error:
type: boolean
example: true
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
status: 401
message: 'Not Found'
error: true
properties:
status:
type: integer
example: 401
message:
type: string
example: 'Not Found'
error:
type: boolean
example: true
tags:
- Account
put:
summary: 'Update Profile User'
operationId: updateProfileUser
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: []
status: 200
message: Success
error: false
properties:
data:
type: array
example: []
status:
type: integer
example: 200
message:
type: string
example: Success
error:
type: boolean
example: false
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
data: []
status: 401
message: Unauthorized
error: true
properties:
data:
type: array
example: []
status:
type: integer
example: 401
message:
type: string
example: Unauthorized
error:
type: boolean
example: true
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
data: []
status: 401
message: 'Not Found'
error: true
properties:
data:
type: array
example: []
status:
type: integer
example: 401
message:
type: string
example: 'Not Found'
error:
type: boolean
example: true
tags:
- Account
/api/feedbacks:
get:
summary: 'Get list of Feedback'
operationId: getListOfFeedback
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_feedback\": string,\n \"deskripsi\": string,\n \"daftar_pertanyaan\": [\n {\n \"id_pertanyaan\": string,\n \"id_feedback\": string,\n \"id_kategori\": string,\n \"id_content\": string,\n \"pertanyaan\": string,\n \"audio_ustadz\": string,\n \"image_soal\": string,\n \"true_sound_label\": string,\n \"daftar_content\": [\n {\n \"id_content\": string,\n \"nama_content\": string,\n \"deskripsi\": string,\n \"image\": string,\n \"video\": string,\n \"rekap\": string,\n \"intro_text\": string,\n }\n ],\n }\n ]\n }\n ]\n}"
tags:
- Lesson
security: []
/api/pertanyaans:
get:
summary: 'Get list of Pertanyaan'
operationId: getListOfPertanyaan
description: ''
parameters:
-
in: query
name: id_content
description: ''
example: 17
required: false
schema:
type: integer
description: ''
example: 17
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_pertanyaan\": string,\n \"id_feedback\": string,\n \"id_kategori\": string,\n \"id_content\": string,\n \"pertanyaan\": string,\n \"audio_ustadz\": string,\n \"image_soal\": string,\n \"true_sound_label\": string,\n \"daftar_feedbacks\": [\n {\n \"id_feedback\": string,\n \"deskripsi\": string\n }\n ],\n \"daftar_contents\": [\n {\n \"id_content\": string,\n \"nama_content\": string,\n \"deskripsi\": string,\n \"image\": string,\n \"video\": string,\n \"rekap\": string,\n \"intro_text\": string,\n }\n ],\n \"daftar_hurufs\": [\n {\n \"id_huruf\": string,\n \"huruf\": string,\n \"daftar_sifat\": [\n {\n \"id_sifatul_huruf\": string,\n \"nama_sifat\": string,\n \"deskripsi\": int\n }\n ]\n }\n ]\n }\n ]\n}"
tags:
- Lesson
security: []
/api/hurufs:
get:
summary: 'Get list of Huruf'
operationId: getListOfHuruf
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_huruf\": string,\n \"huruf\": string,\n \"daftar_sifat\": [\n {\n \"id_sifatul_huruf\": string,\n \"nama_sifat\": string,\n \"deskripsi\": int\n }\n ]\n }\n ]\n}"
tags:
- Lesson
security: []
/api/kategoris:
get:
summary: 'Get list of Kategori'
operationId: getListOfKategori
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_kategori\": string,\n \"nama_kategori\": string,\n \"deskripsi\": string,\n \"image\": string,\n \"deskripsi_panjang\": string,\n \"daftar_subkategori\": [\n {\n \"id_subkategori\": string,\n \"id_kategori\": string,\n \"bagian_mulut\": string,\n \"daftar_content\": [\n {\n \"id_content\": string,\n \"nama_content\": string,\n \"deskripsi\": string,\n \"image\": string,\n \"video\": string,\n \"rekap\": string,\n \"intro_text\": string\n }\n ]\n }\n ]\n }\n ]\n}"
tags:
- Lesson
security: []
/api/kategoris/sub:
get:
summary: 'Get list of Sub Kategori'
operationId: getListOfSubKategori
description: ''
parameters:
-
in: query
name: id_kategori
description: ''
example: 16
required: false
schema:
type: integer
description: ''
example: 16
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": [\n {\n \"id_subkategori\": string,\n \"id_kategori\": string,\n \"bagian_mulut\": string,\n \"daftar_content\": [\n {\n \"id_content\": string,\n \"nama_content\": string,\n \"deskripsi\": string,\n \"image\": string,\n \"video\": string,\n \"rekap\": string,\n \"intro_text\": string\n }\n ]\n }\n ],\n \"status\": 200,\n \"error\": false\n}"
tags:
- Lesson
security: []
/api/lembagas:
get:
summary: 'Get list of Lembaga'
operationId: getListOfLembaga
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_lembaga\": string,\n \"info\": string,\n \"nama_lembaga\": string,\n \"alamat\": string,\n \"latitude\": string,\n \"longitude\": string,\n \"nomor_telepon\": string,\n \"deskripsi\": string,\n \"instagram\": string,\n \"email\": string,\n \"web\": string\n }\n ]\n}"
tags:
- Talaqqi
security: []
/api/pengajars:
get:
summary: 'Get list of Teacher'
operationId: getListOfTeacher
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": [\n {\n \"id_teacher\": int,\n \"id_user\": int,\n \"nama_pengajar\": string,\n \"info\": string,\n \"domisili\": string,\n \"instagram\": string,\n \"nomor_telepon\": string,\n \"profesi\": string,\n \"latitude\": string,\n \"longitude\": string,\n \"sertifikats\": [\n {\n \"id_sertifikasipengajar\": string,\n \"id_pengajar\": string,\n \"sertifikasi\": string,\n \"sumber\": string\n }\n ],\n \"pengalamans\": [\n {\n \"id_pengalamanpengajar\": string,\n \"id_pengajar\": string,\n \"pengalaman\": string,\n \"tahun\": string,\n \"pengalaman_preview\": string\n }\n ],\n \"levels\": [\n {\n \"id_level\": int,\n \"level\": string,\n \"description\": string,\n \"s_active\": string\n }\n ],\n \"days\": [\n {\n \"id_day\": int,\n \"day\": string,\n \"times\": [\n {\n \"id_time\": int,\n \"time\": string,\n \"students\": [\n {\n \"id_student\": int,\n \"id_user\": int,\n \"name\": string,\n \"whatsapp\": string,\n \"gender\": string\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"status\": 200,\n \"error\": false\n}"
tags:
- Talaqqi
security: []
/api/teachers:
get:
summary: 'Get list of Teacher'
operationId: getListOfTeacher
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": [\n {\n \"id_teacher\": int,\n \"id_user\": int,\n \"nama_pengajar\": string,\n \"info\": string,\n \"domisili\": string,\n \"instagram\": string,\n \"nomor_telepon\": string,\n \"profesi\": string,\n \"latitude\": string,\n \"longitude\": string,\n \"sertifikats\": [\n {\n \"id_sertifikasipengajar\": string,\n \"id_pengajar\": string,\n \"sertifikasi\": string,\n \"sumber\": string\n }\n ],\n \"pengalamans\": [\n {\n \"id_pengalamanpengajar\": string,\n \"id_pengajar\": string,\n \"pengalaman\": string,\n \"tahun\": string,\n \"pengalaman_preview\": string\n }\n ],\n \"levels\": [\n {\n \"id_level\": int,\n \"level\": string,\n \"description\": string,\n \"s_active\": string\n }\n ],\n \"days\": [\n {\n \"id_day\": int,\n \"day\": string,\n \"times\": [\n {\n \"id_time\": int,\n \"time\": string,\n \"students\": [\n {\n \"id_student\": int,\n \"id_user\": int,\n \"name\": string,\n \"whatsapp\": string,\n \"gender\": string\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"status\": 200,\n \"error\": false\n}"
tags:
- Talaqqi
security: []
'/api/teachers/{id}':
get:
summary: 'Get Teacher by ID'
operationId: getTeacherByID
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": [\n {\n \"id_teacher\": int,\n \"id_user\": int,\n \"nama_pengajar\": string,\n \"info\": string,\n \"domisili\": string,\n \"instagram\": string,\n \"nomor_telepon\": string,\n \"profesi\": string,\n \"latitude\": string,\n \"longitude\": string,\n \"sertifikats\": [\n {\n \"id_sertifikasipengajar\": string,\n \"id_pengajar\": string,\n \"sertifikasi\": string,\n \"sumber\": string\n }\n ],\n \"pengalamans\": [\n {\n \"id_pengalamanpengajar\": string,\n \"id_pengajar\": string,\n \"pengalaman\": string,\n \"tahun\": string,\n \"pengalaman_preview\": string\n }\n ],\n \"levels\": [\n {\n \"id_level\": int,\n \"level\": string,\n \"description\": string,\n \"s_active\": string\n }\n ],\n \"days\": [\n {\n \"id_day\": int,\n \"day\": string,\n \"times\": [\n {\n \"id_time\": int,\n \"time\": string,\n \"students\": [\n {\n \"id_student\": int,\n \"id_user\": int,\n \"name\": string,\n \"whatsapp\": string,\n \"gender\": string\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"status\": 200,\n \"message\": \"Success\",\n \"error\": false\n}"
tags:
- Talaqqi
security: []
parameters:
-
in: path
name: id
description: 'The ID of the teacher.'
example: tenetur
required: true
schema:
type: string
/api/placement-test:
get:
summary: 'Get Placement Test'
operationId: getPlacementTest
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_placement_test\": int,\n \"id_reviewer\": int,\n \"id_student\": int,\n \"test_schedule_at\": string,\n \"actual_tested_at\": string,\n \"level_result\": int,\n \"notes\": string,\n \"expired_date_at\": string,\n \"s_progress\": int,\n \"id_user\": int,\n \"name\": string,\n \"whatsapp\": string,\n \"gender\": string,\n \"link_catatan\": string\n }\n ]\n}"
tags:
- 'Placement Test'
/api/placement-test/register:
post:
summary: 'Register Placement Test'
operationId: registerPlacementTest
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_placement_test\": int,\n \"id_reviewer\": int,\n \"id_student\": int,\n \"test_schedule_at\": string,\n \"actual_tested_at\": string,\n \"level_result\": int,\n \"notes\": string,\n \"expired_date_at\": string,\n \"s_progress\": int,\n \"id_user\": int,\n \"name\": string,\n \"whatsapp\": string,\n \"gender\": string,\n \"link_catatan\": string\n }\n ]\n}"
tags:
- 'Placement Test'
/api/packages:
get:
summary: 'Get list of Package'
operationId: getListOfPackage
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_package\": int,\n \"name\": string,\n \"description\": string,\n \"price\": string,\n \"duration\": float,\n \"duration_in\": float,\n \"recurred_of_meeting\": string,\n \"level\": string,\n \"bill_type\": string,\n \"recurred_of_meeting_label\": string\n }\n ]\n}"
tags:
- Package
security: []
'/api/packages/{id}':
get:
summary: 'Get Package by ID'
operationId: getPackageByID
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_package\": int,\n \"name\": string,\n \"description\": string,\n \"price\": string,\n \"duration\": float,\n \"duration_in\": float,\n \"recurred_of_meeting\": string,\n \"level\": string,\n \"bill_type\": string,\n \"recurred_of_meeting_label\": string\n }\n ]\n}"
tags:
- Package
security: []
parameters:
-
in: path
name: id
description: 'The ID of the package.'
example: at
required: true
schema:
type: string
/api/set-schedules:
get:
summary: ''
operationId: getApiSetSchedules
description: ''
parameters: []
responses:
503:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Service Unavailable'
exception: Symfony\Component\HttpKernel\Exception\HttpException
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php
line: 78
trace:
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line: 167
function: handle
class: Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/fruitcake/laravel-cors/src/HandleCors.php
line: 52
function: 'Illuminate\Pipeline\{closure}'
class: Illuminate\Pipeline\Pipeline
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line: 167
function: handle
class: Fruitcake\Cors\HandleCors
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php
line: 39
function: 'Illuminate\Pipeline\{closure}'
class: Illuminate\Pipeline\Pipeline
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line: 167
function: handle
class: Illuminate\Http\Middleware\TrustProxies
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line: 103
function: 'Illuminate\Pipeline\{closure}'
class: Illuminate\Pipeline\Pipeline
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php
line: 142
function: then
class: Illuminate\Pipeline\Pipeline
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php
line: 111
function: sendRequestThroughRouter
class: Illuminate\Foundation\Http\Kernel
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 300
function: handle
class: Illuminate\Foundation\Http\Kernel
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 288
function: callLaravelOrLumenRoute
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 91
function: makeApiCall
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 44
function: makeResponseCall
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 35
function: makeResponseCallIfConditionsPass
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php
line: 236
function: __invoke
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php
line: 163
function: iterateThroughStrategies
class: Knuckles\Scribe\Extracting\Extractor
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php
line: 95
function: fetchResponses
class: Knuckles\Scribe\Extracting\Extractor
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php
line: 125
function: processRoute
class: Knuckles\Scribe\Extracting\Extractor
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php
line: 72
function: extractEndpointsInfoFromLaravelApp
class: Knuckles\Scribe\GroupedEndpoints\GroupedEndpointsFromApp
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php
line: 50
function: extractEndpointsInfoAndWriteToDisk
class: Knuckles\Scribe\GroupedEndpoints\GroupedEndpointsFromApp
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php
line: 53
function: get
class: Knuckles\Scribe\GroupedEndpoints\GroupedEndpointsFromApp
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php
line: 36
function: handle
class: Knuckles\Scribe\Commands\GenerateDocumentation
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/Util.php
line: 40
function: 'Illuminate\Container\{closure}'
class: Illuminate\Container\BoundMethod
type: '::'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php
line: 93
function: unwrapIfClosure
class: Illuminate\Container\Util
type: '::'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php
line: 35
function: callBoundMethod
class: Illuminate\Container\BoundMethod
type: '::'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/Container.php
line: 653
function: call
class: Illuminate\Container\BoundMethod
type: '::'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Console/Command.php
line: 136
function: call
class: Illuminate\Container\Container
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/symfony/console/Command/Command.php
line: 298
function: execute
class: Illuminate\Console\Command
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Console/Command.php
line: 120
function: run
class: Symfony\Component\Console\Command\Command
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/symfony/console/Application.php
line: 1040
function: run
class: Illuminate\Console\Command
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/symfony/console/Application.php
line: 301
function: doRunCommand
class: Symfony\Component\Console\Application
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/symfony/console/Application.php
line: 171
function: doRun
class: Symfony\Component\Console\Application
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Console/Application.php
line: 94
function: run
class: Symfony\Component\Console\Application
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php
line: 129
function: run
class: Illuminate\Console\Application
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/artisan
line: 35
function: handle
class: Illuminate\Foundation\Console\Kernel
type: '->'
properties:
message:
type: string
example: 'Service Unavailable'
exception:
type: string
example: Symfony\Component\HttpKernel\Exception\HttpException
file:
type: string
example: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php
line:
type: integer
example: 78
trace:
type: array
example:
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line: 167
function: handle
class: Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/fruitcake/laravel-cors/src/HandleCors.php
line: 52
function: 'Illuminate\Pipeline\{closure}'
class: Illuminate\Pipeline\Pipeline
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line: 167
function: handle
class: Fruitcake\Cors\HandleCors
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php
line: 39
function: 'Illuminate\Pipeline\{closure}'
class: Illuminate\Pipeline\Pipeline
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line: 167
function: handle
class: Illuminate\Http\Middleware\TrustProxies
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line: 103
function: 'Illuminate\Pipeline\{closure}'
class: Illuminate\Pipeline\Pipeline
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php
line: 142
function: then
class: Illuminate\Pipeline\Pipeline
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php
line: 111
function: sendRequestThroughRouter
class: Illuminate\Foundation\Http\Kernel
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 300
function: handle
class: Illuminate\Foundation\Http\Kernel
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 288
function: callLaravelOrLumenRoute
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 91
function: makeApiCall
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 44
function: makeResponseCall
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php
line: 35
function: makeResponseCallIfConditionsPass
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php
line: 236
function: __invoke
class: Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php
line: 163
function: iterateThroughStrategies
class: Knuckles\Scribe\Extracting\Extractor
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php
line: 95
function: fetchResponses
class: Knuckles\Scribe\Extracting\Extractor
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php
line: 125
function: processRoute
class: Knuckles\Scribe\Extracting\Extractor
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php
line: 72
function: extractEndpointsInfoFromLaravelApp
class: Knuckles\Scribe\GroupedEndpoints\GroupedEndpointsFromApp
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php
line: 50
function: extractEndpointsInfoAndWriteToDisk
class: Knuckles\Scribe\GroupedEndpoints\GroupedEndpointsFromApp
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php
line: 53
function: get
class: Knuckles\Scribe\GroupedEndpoints\GroupedEndpointsFromApp
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php
line: 36
function: handle
class: Knuckles\Scribe\Commands\GenerateDocumentation
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/Util.php
line: 40
function: 'Illuminate\Container\{closure}'
class: Illuminate\Container\BoundMethod
type: '::'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php
line: 93
function: unwrapIfClosure
class: Illuminate\Container\Util
type: '::'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php
line: 35
function: callBoundMethod
class: Illuminate\Container\BoundMethod
type: '::'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Container/Container.php
line: 653
function: call
class: Illuminate\Container\BoundMethod
type: '::'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Console/Command.php
line: 136
function: call
class: Illuminate\Container\Container
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/symfony/console/Command/Command.php
line: 298
function: execute
class: Illuminate\Console\Command
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Console/Command.php
line: 120
function: run
class: Symfony\Component\Console\Command\Command
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/symfony/console/Application.php
line: 1040
function: run
class: Illuminate\Console\Command
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/symfony/console/Application.php
line: 301
function: doRunCommand
class: Symfony\Component\Console\Application
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/symfony/console/Application.php
line: 171
function: doRun
class: Symfony\Component\Console\Application
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Console/Application.php
line: 94
function: run
class: Symfony\Component\Console\Application
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php
line: 129
function: run
class: Illuminate\Console\Application
type: '->'
-
file: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/artisan
line: 35
function: handle
class: Illuminate\Foundation\Console\Kernel
type: '->'
items:
type: object
properties:
file:
type: string
example: /home/u136005164/domains/qiroah.com/public_html/prod/api/qiroah.com/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php
line:
type: integer
example: 167
function:
type: string
example: handle
class:
type: string
example: Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance
type:
type: string
example: '->'
tags:
- Package
security: []
/api/programs:
get:
summary: 'Get list of Program'
operationId: getListOfProgram
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_program\": int,\n \"program_name\": string,\n \"url_register\": string,\n \"short_description\": string,\n \"description_html\": string,\n \"s_active\": int,\n \"program_type\": string,\n \"s_progress\": int\n }\n ]\n}"
tags:
- Program
security: []
'/api/programs/{id}':
get:
summary: 'Get Program by ID'
operationId: getProgramByID
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": [\n {\n \"id_program\": int,\n \"program_name\": string,\n \"url_register\": string,\n \"short_description\": string,\n \"description_html\": string,\n \"s_active\": int,\n \"program_type\": string,\n \"s_progress\": int\n }\n ],\n \"status\": 200,\n \"message\": \"Success\",\n \"error\": false\n}"
tags:
- Program
security: []
parameters:
-
in: path
name: id
description: 'The ID of the program.'
example: ab
required: true
schema:
type: string
/api/teachers/slot-time:
get:
summary: 'Get List of Teacher Slot Time'
operationId: getListOfTeacherSlotTime
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_teacher\": int,\n \"id_user\": int,\n \"nama_pengajar\": string,\n \"info\": string,\n \"domisili\": string,\n \"instagram\": string,\n \"nomor_telepon\": string,\n \"profesi\": string,\n \"latitude\": string,\n \"longitude\": string,\n \"levels\": [\n {\n \"id_level\": int,\n \"level\": string,\n \"description\": string,\n \"s_active\": string\n }\n ],\n \"days\": [\n {\n \"id_day\": int,\n \"day\": string,\n \"times\": [\n {\n \"id_time\": int,\n \"time\": string,\n \"students\": [\n {\n \"id_student\": int,\n \"id_user\": int,\n \"name\": string,\n \"whatsapp\": string,\n \"gender\": string\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}"
tags:
- 'Teacher Slot Time'
security: []
'/api/teachers/{id}/slot-time':
get:
summary: 'Get Teacher Slot Time by ID'
operationId: getTeacherSlotTimeByID
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"error\": false,\n \"data\": [\n {\n \"id_teacher\": int,\n \"id_user\": int,\n \"nama_pengajar\": string,\n \"info\": string,\n \"domisili\": string,\n \"instagram\": string,\n \"nomor_telepon\": string,\n \"profesi\": string,\n \"latitude\": string,\n \"longitude\": string,\n \"levels\": [\n {\n \"id_level\": int,\n \"level\": string,\n \"description\": string,\n \"s_active\": string\n }\n ],\n \"days\": [\n {\n \"id_day\": int,\n \"day\": string,\n \"times\": [\n {\n \"id_time\": int,\n \"time\": string,\n \"students\": [\n {\n \"id_student\": int,\n \"id_user\": int,\n \"name\": string,\n \"whatsapp\": string,\n \"gender\": string\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}"
tags:
- 'Teacher Slot Time'
security: []
parameters:
-
in: path
name: id
description: 'The ID of the teacher.'
example: illo
required: true
schema:
type: string
tags:
-
name: Account
description: ''
-
name: Lesson
description: ''
-
name: Talaqqi
description: ''
-
name: 'Placement Test'
description: ''
-
name: Package
description: ''
-
name: Program
description: ''
-
name: 'Teacher Slot Time'
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by contacting the support of qiroah.com'
security:
-
default: []