Consultar
POST {{url}}/api/v1/integracao/ordem_servico/consultar
Endpoint (Rota)
Neste endpoint, será possível consultar ordens de serviço, obtendo o retorno no formato JSON como resposta. Os seguintes parâmetros podem/devem ser utilizados:
| Atributo | Descrição | Obrigatório |
|---|---|---|
| consulta | Parametro que será utilizado para encontrar uma O.S. pelo seu número | Sim |
| relacoes | Carrega os relacionamentos especificados | Não |
Os atributos podem conter os seguintes valores:
| Atributo | Descrição | Valor Default |
|---|---|---|
| consulta | Campo Inteiro (integer) | Nenhum |
| relacoes | tecnicos, motivosfechamento, cobrancasdisponiveis | Nenhum |
Request Body
{"consulta"=>"2921", "relacoes"=>["tecnicos", "motivos_fechamento", "cobrancas_disponiveis"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | Bearer Token obtido na autenticação |
RESPONSES
status: OK
{"status":"success","msg":"Dados consultados com sucesso","ordens_servico":[{"cliente":"(2131) IASMIN TESTE 2 - (INATIVO)","servico":"(2) TESTE ANA","endereco_instalacao":"AVENIDA JK, 180 - CENTRO, SANTO ANTÔNIO DO MONTE/MG | CEP: 35560-000","pop":null,"id_ordem_servico":4036,"numero":2921,"tipo":"ATIVAÇÃO FIBRA","id_tipo_ordem_servico":95,"data_inicio_programado":"2023-12-18 06:00:00","data_termino_programado":"2023-12-18 07:00:00","data_inicio_executado":"2024-02-07 08:00:00","data_termino_executado":"2024-02-07 08:25:41","data_cadastro":"2023-12-12 14:37:54","descricao_abertura":"O serviço estava com status Suspenso por Débito há 48 dias, por esse motivo foi cancelado automaticamente pelo sistema, de acordo com as configurações atuais.","descricao_servico":"Executar a retirada dos equipamentos instalados no cliente.","descricao_fechamento":"teste","motivo_fechamento":[{"id_motivo_fechamento":27,"descricao":"TESTE MOTIVO"}],"status":"Finalizado","disponibilidade":"Não Informada","tecnicos":[{"id":4897,"name":"Iasmin"}]}]}