title | language_tabs | toc_footers | includes | search | code_clipboard | highlight_theme | headingLevel | generator | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DriveScript v1.0.0 |
|
true |
true |
darkula |
2 |
@tarslib/widdershins v4.0.17 |
v1.0.0
Base URLs:
GET /api/alunos/
Name | Location | Type | Required | Description |
---|---|---|---|---|
x-access-token | header | string | yes | none |
Response Examples
403
{
"status": "Forbidden",
"message": "Token não fornecido."
}
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
403 | Forbidden | 403 | Inline |
HTTP Status Code 403
Name | Type | Required | Restrictions | Title | description |
---|---|---|---|---|---|
» status | string | true | none | none | |
» message | string | true | none | none |
GET /api/alunos/{id}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | yes | none |
Response Examples
0
null
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
0 | Unknown | 0 | Inline |
POST /api/alunos/criar
Body Parameters
{
"nome": "string",
"cpf": "string",
"data_nascimento": "string",
"endereco": "string",
"telefone": "string"
}
Name | Location | Type | Required | Description |
---|---|---|---|---|
x-access-token | header | string | yes | none |
body | body | object | no | none |
» nome | body | string | yes | none |
» cpf | body | string | yes | none |
» data_nascimento | body | string | yes | none |
» endereco | body | string | yes | none |
» telefone | body | string | yes | none |
Response Examples
401
{
"status": "Unauthorized",
"message": "Token inválido."
}
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
401 | Unauthorized | 401 | Inline |
HTTP Status Code 401
Name | Type | Required | Restrictions | Title | description |
---|---|---|---|---|---|
» status | string | true | none | none | |
» message | string | true | none | none |
PUT /api/alunos/update/{id}
Body Parameters
{
"nome": "string",
"cpf": "string",
"data_nascimento": "string",
"endereco": "string",
"telefone": "string"
}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | yes | none |
body | body | object | no | none |
» nome | body | string | yes | none |
» cpf | body | string | yes | none |
» data_nascimento | body | string | yes | none |
» endereco | body | string | yes | none |
» telefone | body | string | yes | none |
Response Examples
403
{
"status": "Forbidden",
"message": "Token não fornecido."
}
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
403 | Forbidden | 403 | Inline |
HTTP Status Code 403
Name | Type | Required | Restrictions | Title | description |
---|---|---|---|---|---|
» status | string | true | none | none | |
» message | string | true | none | none |
DELETE /api/alunos/delete/{id}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | yes | none |
Response Examples
Success
{
"status": "OK"
}
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
HTTP Status Code 200
Name | Type | Required | Restrictions | Title | description |
---|---|---|---|---|---|
» status | string | true | none | none |
GET /api/carros
Name | Location | Type | Required | Description |
---|---|---|---|---|
x-access-token | header | string | yes | none |
Response Examples
403
{
"status": "Forbidden",
"message": "Token não fornecido."
}
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
403 | Forbidden | 403 | Inline |
HTTP Status Code 403
Name | Type | Required | Restrictions | Title | description |
---|---|---|---|---|---|
» status | string | true | none | none | |
» message | string | true | none | none |
GET /api/carros/{id}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | yes | none |
Response Examples
0
null
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
0 | Unknown | 0 | Inline |
POST /api/carros/criar
Body Parameters
{
"marca": "string",
"modelo": "string",
"ano": 0,
"placa": "string",
"capacidade_de_passageiros": 0
}
Name | Location | Type | Required | Description |
---|---|---|---|---|
x-access-token | header | string | yes | none |
body | body | object | no | none |
» marca | body | string | yes | none |
» modelo | body | string | yes | none |
» ano | body | integer | yes | none |
» placa | body | string | yes | none |
» capacidade_de_passageiros | body | integer | yes | none |
Response Examples
403
{
"status": "Forbidden",
"message": "Token não fornecido."
}
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
403 | Forbidden | 403 | Inline |
HTTP Status Code 403
Name | Type | Required | Restrictions | Title | description |
---|---|---|---|---|---|
» status | string | true | none | none | |
» message | string | true | none | none |
PUT /api/carros/alterar/{id}
Body Parameters
{
"marca": "string",
"modelo": "string",
"ano": 0,
"placa": "string",
"capacidade_de_passageiros": 0
}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | yes | none |
body | body | object | no | none |
» marca | body | string | yes | none |
» modelo | body | string | yes | none |
» ano | body | integer | yes | none |
» placa | body | string | yes | none |
» capacidade_de_passageiros | body | integer | yes | none |
Response Examples
0
null
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
0 | Unknown | 0 | Inline |
DELETE /api/carros/deletar/{id}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | yes | none |
Response Examples
0
null
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
0 | Unknown | 0 | Inline |
GET /api/agendamentos/
Name | Location | Type | Required | Description |
---|---|---|---|---|
x-access-token | header | string | yes | none |
Response Examples
403
{
"status": "Forbidden",
"message": "Token não fornecido."
}
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
403 | Forbidden | 403 | Inline |
HTTP Status Code 403
Name | Type | Required | Restrictions | Title | description |
---|---|---|---|---|---|
» status | string | true | none | none | |
» message | string | true | none | none |
GET /api/agendamentos/{id}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | no | none |
Response Examples
0
null
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
0 | Unknown | 0 | Inline |
POST /api/agendamentos/criar
Body Parameters
{
"aluno_id": "string",
"carro_id": "string",
"data_aula": "string",
"horario_aula": "string"
}
Name | Location | Type | Required | Description |
---|---|---|---|---|
x-access-token | header | string | no | none |
body | body | object | no | none |
» aluno_id | body | string | yes | none |
» carro_id | body | string | yes | none |
» data_aula | body | string | yes | none |
» horario_aula | body | string | yes | none |
Response Examples
0
null
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
0 | Unknown | 0 | Inline |
PUT /api/agendamentos/alterar/{id}
Body Parameters
{
"aluno_id": "string",
"carro_id": "string",
"data_aula": "string",
"horario_aula": "string"
}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | no | none |
body | body | object | no | none |
» aluno_id | body | string | yes | none |
» carro_id | body | string | yes | none |
» data_aula | body | string | yes | none |
» horario_aula | body | string | yes | none |
Response Examples
0
null
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
0 | Unknown | 0 | Inline |
DELETE /api/agendamentos/deletar/{id}
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
x-access-token | header | string | no | none |
Response Examples
0
null
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
0 | Unknown | 0 | Inline |
POST /api/login
Body Parameters
{
"user": "string",
"password": "string"
}
Name | Location | Type | Required | Description |
---|---|---|---|---|
body | body | object | no | none |
» user | body | string | yes | none |
» password | body | string | yes | none |
Response Examples
Success
{
"auth": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyaWQiOjEsIm5pdmVsX3Blcm1pc3NhbyI6MCwiaWF0IjoxNzAxMDE2MTMzLCJleHAiOjE3MDEwMTk3MzN9.-3yzBSETiuHP2MrnTXrSP3-ASyUdXUfWZ12NM5paQLg",
"usuario": {
"id": 1,
"username": "admin",
"password": "admin",
"nivel_perm": 0
}
}
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
HTTP Status Code 200
Name | Type | Required | Restrictions | Title | description |
---|---|---|---|---|---|
» auth | boolean | true | none | none | |
» token | string | true | none | none | |
» usuario | object | true | none | none | |
»» id | integer | true | none | none | |
»» username | string | true | none | none | |
»» password | string | true | none | none | |
»» nivel_perm | integer | true | none | none |