Documentação da API - Hidrômetro Sysmar

Versão 1.2 — Integração via REST para ordens de serviço de hidrômetro.

Atualizado em Agosto/2025 — Desenvolvido por Sysmar

Sumário

• GET /auth/login-token/{cpfcnpj}/{senha}
• POST /api/hidrometro/ordem-servico-trocahd-completa
• POST /api/hidrometro/ordem-servico-abertura-completa
• GET /api/hidrometro/has-remessa-leitura-andamento/{numeroUnidade}
• GET /api/hidrometro/rotas-em-remessa-nao-concluida
...
• Códigos de Erro
• Tabelas

GET /auth/login-token/{cpfcnpj}/{senha}

Resposta:

Exemplo Resposta 200:

{
  "token": "...",
  "duration": 12000,
  "pessoa": {
    "nome": "Luiz Henrique Padilha",
    "acessarResourceDebitoApi": false,
    "acessarResourceHidrometroApi": true
  }
}

Exemplo Resposta 401:

{
    "status": 401,
    "message": "usuário ou senha inválidos"
}

POST /api/hidrometro/ordem-servico-trocahd-completa

Headers:

Body:

Exemplo de Body:

{
    "numeroUnidadeConsumidora": 123456,
    "matriculaFuncionarioAbertura": "1234",
    "observacaoTexto": "Troca para telemetria",
    "matriculaFuncionarioExecucao": "311",
    "dataRetiradaHD": "05/06/2025",
    "dataInstalacaoHD": "05/06/2025",
    "leituraAtualRetirada": 1,
    "leituraAtualInstalacao": 2,
    "numeroHidrometroRetirada": "Y15L890783",
    "parecerTexto": "Substituição necessária",
    "hidrometroInstalado": {
      "numero": "Y15L8907831",
      "diametro": null,
      "vazao": null,
      "codigoRadioTelemetria": null,
      "leituraPorTelemetria": true
    }
}

Resposta:

Exemplo Resposta 200:

{
    "result": 1001,
    "mensagem": "Processado com sucesso",
    "erros": [],
    "errosCodigo": []
}

Exemplo Resposta 400:

{
    "result": null,
    "mensagem": "Erro ao processar a requisição",
    "erros": [
            Já existe uma ordem de serviço com os seguintes filtros: unidade consumidora e hidrômetro instalação,
            Não é permitida a troca de hidrômetro. A unidade consumidora está vinculada a uma remessa de leitura não concluída,
            Funcionário não encontrado para a matrícula informada,
            Leitura anterior não encontrada com os seguintes filtros: unidade consumidora e data de retirada,
            Não é permitida a conclusão da troca de hidrômetro, pois a última leitura indica que o hidrômetro atual é igual ao novo,
            Unidade consumidora não encontrada para o número informado,
            Padrão data inválido, deve ser informado com padrão: dd/MM/yyyy,
            Serviço de abertura não encontrado no sistema,
            Já existe uma ordem de serviço aberta com os seguintes filtros: unidade consumidora e serviço,
            JSON inválido, verifique se todos os campos obrigatórios estão informados,
            Leitura de retirada inválida, leitura de retirada deve ser maior que a leitura anterior

    ],
    "errosCodigo": [2, 3, 4, 5, 6, 7, 8, 9, 11, 13, 14]
}

POST /api/hidrometro/ordem-servico-abertura-completa

Headers:

Body:

Exemplo de Body:

{
    "numeroUnidadeConsumidora": 123456,
    "matriculaFuncionarioAbertura": "1234",
    "observacaoTexto": "Troca para telemetria",
    "matriculaFuncionarioExecucao": "311",
    "dataInstalacaoHD": "05/06/2025",
    "leituraAtualInstalacao": 2,
    "parecerTexto": "Substituição necessária",
    "hidrometroInstalado": {
      "numero": "Y15L8907831",
      "diametro": null,
      "vazao": null,
      "codigoRadioTelemetria": null,
      "leituraPorTelemetria": true
    }
}

Resposta:

Exemplo Resposta 200:

{
    "result": 1001,
    "mensagem": "Processado com sucesso",
    "erros": [],
    "errosCodigo": []
}

Exemplo Resposta 400:

{
    "result": null,
    "mensagem": "Erro ao processar a requisição",
    "erros": [
            Já existe uma ordem de serviço com os seguintes filtros: unidade consumidora e hidrômetro instalação,
            Não é permitida a troca de hidrômetro. A unidade consumidora está vinculada a uma remessa de leitura não concluída,
            Funcionário não encontrado para a matrícula informada,
            Não é permitida a conclusão da troca de hidrômetro, pois a última leitura indica que o hidrômetro atual é igual ao novo,
            Unidade consumidora não encontrada para o número informado,
            Padrão data inválido, deve ser informado com padrão: dd/MM/yyyy,
            Serviço de abertura não encontrado no sistema,
            Já existe uma ordem de serviço aberta com os seguintes filtros: unidade consumidora e serviço,
            JSON inválido, verifique se todos os campos obrigatórios estão informados

    ],
    "errosCodigo": [2, 3, 4, 6, 7, 9, 10, 11, 13]
}

GET /api/hidrometro/has-remessa-leitura-andamento/{numeroUnidade}

Headers:

Resposta:

Exemplo Resposta 200:

{
    "result": true,
    "mensagem": "Processado com sucesso",
    "erros": [],
    "errosCodigo": []
}

Exemplo Resposta 400:

{
    "result": null,
    "mensagem": "Erro ao processar a requisição",
      "erros": [
              Unidade consumidora não encontrada para o número informado
    ],
    "errosCodigo": [7]
}

GET /api/hidrometro/rotas-em-remessa-nao-concluida

Headers:

Resposta:

Exemplo Resposta 200:

{
    "result": [
      {
        "codigo": 10,
        "descricao": "ROTA 10"
      },
      {
        "codigo": 90,
        "descricao": "ROTA 90"
      }
    ],
    "mensagem": "Processado com sucesso",
    "erros": [],
    "errosCodigo": []
}

Códigos de Erro

Tabelas

OrdemServicoTrocaHDCompletaVO

OrdemServicoAberturaCompletaVO

HidrometroVO

ResponseHidrometroVO

ResponseAuth

User

RotaSaneamentoVO