Documentação da API
POST /update_project
Resumo
Este endpoint permite atualizar os dados de um projeto existente em uma unidade específica.
Descrição
Utilize este endpoint para modificar informações de um projeto, como nome, orçamento ou observações. O projeto deve existir e estar associado à unidade informada.
Requisição
Body da Requisição
O corpo deve ser um objeto JSON com os seguintes parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
access_token | string | Sim | Token de autenticação do usuário. | b31643fc-a45f-448c-99ee-736a547f6989 |
unit_token | string | Sim | Token identificador da unidade. | e6988e9e-b0c1-410c-ae08-aed7c64ac71f |
token | string | Sim | Token identificador do projeto a ser atualizado. | a6927665-6d56-4839-ad23-37d48717da13 |
name | string | Não | Nome do projeto. | Projeto Alpha Atualizado |
budget | number | Não | Orçamento do projeto (deve ser um número positivo). | 20000.75 |
observation | string | Não | Observação ou descrição do projeto. | Atualizado para novo escopo do projeto |
Exemplo de Requisição
Curl
curl -X POST 'https://portal.fipli.pro/api/v1/update_project' \
-H 'Content-Type: application/json' \
-d '{
"access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
"unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
"token": "a6927665-6d56-4839-ad23-37d48717da13",
"name": "Projeto Alpha Atualizado",
"budget": 20000.75,
"observation": "Atualizado para novo escopo do projeto"
}'
Resposta
200 OK
Atualização realizada com sucesso.
{
"success": true,
"message": "Project updated successfully",
"data": {
"token": "a6927665-6d56-4839-ad23-37d48717da13"
}
}
Erros Comuns
| Status | Mensagem | Descrição |
|---|---|---|
400 | "Missing required parameters" | Algum parâmetro obrigatório (access_token, unit_token, token) não foi enviado. |
400 | "Invalid parameter: budget must be a positive number" | O parâmetro budget não é um número positivo válido. |
400 | "No fields provided to update" | Nenhum campo válido foi fornecido para atualização. |
403 | "Invalid data" | Token de autenticação inválido ou não autorizado. |
404 | "Unit not found" | A unidade com o unit_token fornecido não foi encontrada. |
404 | "Project not found or not updated" | O projeto com o token fornecido não foi encontrado ou não foi atualizado. |
500 | "Something went wrong. Please try again later." | Erro interno no servidor. |
Observações
- Pelo menos um dos campos opcionais (
name,budget,observation) deve ser fornecido para realizar a atualização. - O campo
budgetdeve ser um número positivo, caso seja fornecido. Valores não numéricos ou negativos resultarão em erro. - A atualização é realizada de forma transacional, garantindo a consistência dos dados no banco.
- Certifique-se de que os tokens estejam válidos e que a unidade e o projeto existam no sistema.