Skip to main content

🌐 Rotas

📂 Criar

Método HTTP: POST

/api/v1/scale

Header: Content-Type

application/json

Header: KEY

{chave_de_api}

Corpo da Requisição
{
"value": "Valor da Escala de Trabalho"
}
Resposta (Sucesso)
{
"success": true,
"data": {
"id": "ID da Escala de Trabalho",
"value": "Valor da Escala de Trabalho",
"createdAt": "Data de Criação",
"updatedAt": "Data de Atualização"
}
}
Resposta (Erro)
{
"success": false,
"message": "Não foi possível criar a escala de trabalho.",
"error": { ... }
}

📂 Atualizar

Método HTTP: PUT

/api/v1/scale/{id}

Header: Content-Type

application/json

Header: KEY

{chave_de_api}

Corpo da Requisição
{
"value": "Valor da escala de trabalho"
}
Resposta (Sucesso)
{
"success": true,
"data": {
"id": "ID da Escala de Trabalho",
"value": "Valor da Escala de Trabalho",
"createdAt": "Data de Criação",
"updatedAt": "Data de Atualização"
}
}
Resposta (Erro)
{
"success": false,
"message": "Não foi possível atualizar a escala de trabalho.",
"error": { ... }
}

📂 Procurar

Método HTTP: GET

/api/v1/scale/{id}

Header: KEY

{chave_de_api}

Resposta (Sucesso)
{
"success": true,
"data": {
"id": "ID da Escala de Trabalho",
"value": "Valor da Escala de Trabalho",
"createdAt": "Data de Criação",
"updatedAt": "Data de Atualização"
}
}
Resposta (Erro)
{
"success": false,
"message": "Não foi possível retornar a escala de trabalho.",
"error": { ... }
}

📂 Listar

Método HTTP: GET

/api/v1/scales

/api/v1/scales/{limit}

/api/v1/scales/{skip}/{limit}

Header: KEY

{chave_de_api}

Resposta (Sucesso)
{
"success": true,
"data": [
{
"id": "ID da Escala de Trabalho",
"value": "Valor da Escala de Trabalho",
"createdAt": "Data de Criação",
"updatedAt": "Data de Atualização"
}
]
}
Resposta (Erro)
{
"success": false,
"message": "Não foi possível retornar as escalas de trabalho.",
"error": { ... }
}

📂 Deletar

Método HTTP: DELETE

/api/v1/scale/{id}

Header: KEY

{chave_de_api}

Resposta (Sucesso)
{ "success": true }
Resposta (Erro)
{
"success": false,
"message": "Não foi possível deletar a escala de trabalho.",
"error": { ... }
}