4.Operações de Entrada

Criar Solicitação

Nesta operação, o método cria uma solicitação no sistema da Exati. Após a requisição, a Exati retorna uma resposta indicando conformidade da operação. Para detalhes mais específicos da operação, verifique Criar Solicitação

Método	POST
Endpoint	/clients/:idInstance/tickets
Content-Type	application/json

Exemplo Corpo da Requisição

{
  "cod_external_ticket_origin": "tg",
  "ticket_origin_type_id": 1,
  "id_external_protocol": 1,
  "external_protocol": "string",
  "service_code": "string",
  "justification": "string",
  "description": "string",
  "id_worksite": 1,
  "state_abbreviation": "AC",
  "municipality": "string",
  "neighborhood": "string",
  "address": "string",
  "address_number": 0,
  "zip_code": "65903-350",
  "latitude": "45.123",
  "longitude": "76.486",
  "reference_point": "string",
  "reporter": "string",
  "reporter_phone": "84968718020",
  "reporter_birth_date": "01/01/1900",
  "nameplate_num": "string",
  "age_majority_checkbox": 1
}

Exemplo Corpo da Resposta

201 - Created

{
    "id_demanda": 12348,
    "operacao": "cria",
    "data_recebido": 1711217789710,
    "status": "ok",
}

Dica
Para mais detalhes sobre o uso deste endpoint, assista ao vídeo mostrando a operação sendo feita pelo Postman aqui.

Cancelar Solicitação

Nesta operação, o método cancela a solicitação no sistema da Exati. Após a requisição, a Exati retorna uma resposta indicando conformidade da operação. Para detalhes mais específicos da operação, verifique
Cancelar Solicitação

Método	DELETE
Endpoint	/clients/:idInstance/tickets
Content-Type	application/json

Exemplo Corpo da Requisição

{
  "cod_external_ticket_origin": "tg",
  "id_external_protocol": 1,
  "justification": "string"
}

Exemplo Corpo da Resposta

200 - OK

{
    "id_protocolo": 12348,
    "operacao": "cancela",
    "data_recebido": 1711217789710,
    "status": "ok",
}

Dica
Para mais detalhes sobre o uso deste endpoint, assista ao vídeo mostrando a operação sendo feita pelo Postman aqui.

Atualizar Atributos de Dispositivos

Nesta operação, o método atualiza os atributos de um vetor de dispositivos. Os atributos a serem atualizados são location e energyConsumption. Para detalhes mais específicos da operação, verifique Atualizar Atributos de Dispositivos

Método	PATCH
Endpoint	/clients/:idInstance/devices
Content-Type	application/json

Exemplo Corpo da Requisição

[
  {
    "idNox": "string",
    "location": {
      "latitude": 90,
      "longitude": 180,
      "altitude": -430
    },
    "energyConsumption": 1
  }
]

Exemplo Corpo da Resposta

200 - OK

[
  {
    "idNox": "string",
    "location": {
      "latitude": 90,
      "longitude": 180,
      "altitude": -430
    },
    "energyConsumption": 1
  }
]

Atualizar Atributos de um Dispositivo

Nesta operação, atualiza-se os atributos de um único dispositivo especificado pelo id do Nox. No momento, os atributos disponíveis são location e energyConsumption. Para detalhes mais específicos do endpoint, como parâmetros e outras respostas HTTP, Atualizar Atributos de Dispositivos

Método	PATCH
Endpoint	/clients/:idInstance/devices/:idNox
Content-Type	application/json

Parâmetros da URI

Campo	Tipo	Descrição
idNox	String	Identificador do Nox

Exemplo Corpo da Requisição

{
  "idNox": "string",
  "location": {
    "latitude": 90,
    "longitude": 180,
    "altitude": -430
  },
  "energyConsumption": 1
}

Exemplo Corpo da Resposta

200 - OK

{
  "idNox": "string",
  "location": {
    "latitude": 90,
    "longitude": 180,
    "altitude": -430
  },
  "energyConsumption": 1
}

4.Operações de Entrada

Criar Solicitação#

Exemplo Corpo da Requisição#

Exemplo Corpo da Resposta#

Dica#

Cancelar Solicitação#

Exemplo Corpo da Requisição#

Exemplo Corpo da Resposta#

Dica#

Atualizar Atributos de Dispositivos#

Exemplo Corpo da Requisição#

Exemplo Corpo da Resposta#

Atualizar Atributos de um Dispositivo#

Parâmetros da URI#

Exemplo Corpo da Requisição#

Exemplo Corpo da Resposta#

Criar Solicitação

Exemplo Corpo da Requisição

Exemplo Corpo da Resposta

Dica

Cancelar Solicitação

Exemplo Corpo da Requisição

Exemplo Corpo da Resposta

Dica

Atualizar Atributos de Dispositivos

Exemplo Corpo da Requisição

Exemplo Corpo da Resposta

Atualizar Atributos de um Dispositivo

Parâmetros da URI

Exemplo Corpo da Requisição

Exemplo Corpo da Resposta