Atualizar um medidor

put

https://app.fracttal.com/api/meters/{code}

Atualiza a descrição e o número de série de um medidor existente e habilitado.

Por meio deste endpoint é possível atualizar a descrição e o número de série de um medidor existente e habilitado. Os demais campos do medidor não são modificados por este serviço.

Parâmetros de entrada

Parâmetro	Tipo	Obrigatório	Descrição
`code` (na URL)	texto	Sim	Código do medidor a ser atualizado, enviado como segmento da URL. Exemplo: `/api/meters/456-fd3`.
`code`	texto	Sim	Código do medidor, enviado também no body.
`isAccumulatorCounter`	booleano	Sim	Indica se o medidor é um contador acumulador. Deve coincidir com o valor registrado no medidor.
`unit`	texto	Sim	Unidade de medida do medidor (ex. `Kilómetros`, `kWh`). Deve coincidir com a unidade registrada no medidor.
`description`	texto	Condicional	Nova descrição do medidor. Não pode estar vazia nem ultrapassar 500 caracteres.
`serial`	texto	Condicional	Novo número de série do medidor. Não pode estar vazio nem ultrapassar 100 caracteres.

Regras de atualização

É necessário enviar pelo menos um dos campos description ou serial. Se apenas um for enviado, o outro mantém seu valor atual.

Os parâmetros code, isAccumulatorCounter e unit são sempre obrigatórios, mesmo que não sejam modificados.

Não é possível atualizar um medidor desabilitado.

Nesta versão, somente description e serial podem ser modificados.

Parâmetros de saída

Parâmetro	Tipo	Descrição
`code`	texto	Código do medidor.
`description`	texto	Descrição do medidor.
`serial`	texto	Número de série do medidor.
`unit`	texto	Unidade de medida do medidor.
`isAccumulatorCounter`	booleano	Indica se o medidor é um contador acumulador.
`enabled`	booleano	Indica se o medidor está habilitado.
`lastReading`	número	Última leitura registrada do medidor.
`readingDate`	texto	Data da última leitura.

Erros

Código	Causa
`400`	Falta algum dos parâmetros obrigatórios (`code`, `isAccumulatorCounter` ou `unit`).
`400`	Nenhum dos campos `description` ou `serial` foi enviado.
`400`	`description` ou `serial` estão vazios, ou ultrapassam o comprimento máximo permitido (500 e 100 caracteres, respectivamente).
`400`	`isAccumulatorCounter` ou `unit` não coincidem com os valores registrados no medidor.
`400`	O formato do código do medidor é inválido.
`401`	Não autenticado: a autenticação falhou ou não foi encontrada a informação necessária para autenticar a requisição.
`403`	O usuário não tem permissão para realizar a ação.
`404`	O medidor solicitado não foi encontrado.
`405`	Operação não permitida: não é possível editar um medidor desabilitado.

Exemplo

Request body

{
    "code": "456-fd3",
    "isAccumulatorCounter": true,
    "unit": "Kilómetros",
    "description": "Kilómetros - COMPACTADOR ACTUALIZADO",
    "serial": "Compactador_v2"
}

Response `200`

{
    "success": true,
    "message": "200",
    "data": [
        {
            "code": "456-fd3",
            "description": "Kilómetros - COMPACTADOR ACTUALIZADO",
            "serial": "Compactador_v2",
            "unit": "Kilómetros",
            "isAccumulatorCounter": true,
            "enabled": true,
            "lastReading": 15230.5,
            "readingDate": "2026-09-30T14:20:00.000000+00:00"
        }
    ],
    "total": 1
}

Response — Medidor desabilitado (`405`)

{
    "success": false,
    "message": "405",
    "data": null
}

Response — Medidor não encontrado (`404`)

{
    "success": false,
    "message": "404",
    "data": null
}

OpenAPI definition

{
  "openapi": "3.1.0",
  "info": {
    "title": "medidores",
    "version": "3-pt"
  },
  "servers": [
    { "url": "https://app.fracttal.com/api/meters" }
  ],
  "security": [{}],
  "paths": {
    "/{code}": {
      "put": {
        "summary": "Atualizar um medidor",
        "description": "",
        "operationId": "atualizar-um-medidor",
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}s

Responses

Language

Loading…

Response

Choose an example:

application/json