Integração com histórico de Medições

Listar

Endpoint que lista todos os registros cadastrados.

Method URI Headers Authorization
GET /api/v3/integrations-equipments-history Content-Type:application/json Authorization: Bearer {token}

Parameters

_sort: 'current_date' (string) ('integration_equipment_id', 'active', 'start_date', 'final_date', 'current_date') - "Define o campo de ordenação da lista."
_order: 'desc' (string) ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."
integration_equipment_id: 1 (integer) - "Id do integration equipment."
active: true (bool) - "Status do registro (ativo ou inativo indicados com booleano)."
start_date: '2024-08-01' (string) - "Data de início do intervalo de busca de histórico."
final_date: '2024-08-20' (string) - "Data de fim do intervalo de busca de histórico."
current_date: '2024-08-20' (string) - "Data atual do intervalo de busca de histórico."

{info} Observações:

Apenas o Super Admin que poderá listar todas os historicos que estejam ou não vinculados ao grupo econômico do mesmo, caso contrário será listado apenas os historicos vinculados no grupo econômico do usuário.

Response

{success} Response 200 (application/json)

{
  "items": [
    {
      "id": 1,
      "integration_equipment_id": 1,
      "active": true,
      "start_date": 1706756400,
      "final_date": 1709089200,
      "current_date": 1707879600
    },
    {
      "id": 2,
      "integration_equipment_id": 2,
      "active": true,
      "start_date": 1706756400,
      "final_date": 1709089200,
      "current_date": 1707879600
    }
  ],
  "total": 1,
  "per_page": 10,
  "current_page": 1
}

{warning} Response 403 (application/json)

"Permissões insuficientes!"

Detalhes

Endpoint que retorna um registro específico.

Method URI Headers Authorization
GET /api/v3/integrations-equipments-history/{id} Content-Type: application/json Authorization: Bearer {token}

Parameters

id: 1 (integer, required) - "Id do integration equipment history."

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "integration_equipment_id": 1,
    "active": true,
    "start_date": 1706756400,
    "final_date": 1709089200,
    "current_date": null
}

{warning} Response 403 (application/json)

["Permissões insuficientes!"]
["Permissões insuficientes ou equipamento não existente."]

Criar

Endpoint que cria um registro.

Method URI Headers Authorization
POST /api/v3/integrations-equipments-history Content-Type: application/json Authorization: Bearer {token}

Attributes

integration_equipment_id: 99 (required, integer) - "Id do integration equipment."
start_date: '2024-08-01' (required, integer) - "Data de inicio do intervalo de busca de histórico."

{info} Observações:

Campo integration_equipment_id só poderá ser informada de diferentes grupos econômicos apenas pelo Super Admin, caso contrário terá que ser o grupo econômico do usuário logado.

Response

{success} Response 201 (application/json)

{
  "id": 1,
  "integration_equipment_id": 1,
  "start_date": 1706756400,
  "final_date": 1709089200,
  "active": false,
  "current_date": null,
  "created_at": "2023-08-18 15:43:14",
  "updated_at": "2023-08-18 15:43:14"
}

{warning} Response 422 (application/json)

{
  "integration_equipment_id": [
    "O campo integration equipment id selecionado é inválido."
  ]
}
["Já existe um registro para este integration_equipment_id."]

{warning} Response 403 (application/json)

["Permissões insuficientes!"]
["Permissões insuficientes ou equipamento não existente."]

Atualizar

Endpoint que atualiza um registro específico.

Method URI Headers Authorization
PUT /api/v3/integrations-equipments-history/1 Content-Type: application/json Authorization: Bearer {token}

Parameters

id: 1 (integer, required) - "Id do registro de integration equipment history."

Attributes

integration_equipment_id: 1 (integer) - "Id do integration equipment."
start_date: '2024-01-10' (integer) - "Data de inicio do intervalo de busca de histórico."
active: true (boolean) - "Campo para informar se está ativo ou inativo."

{info} Observações:

Campo integration_equipment_id só poderá ser informada de diferentes grupos econômicos apenas pelo Super Admin, caso contrário terá que ser o grupo econômico do usuário logado.

Para atualizar o apenas o campo active basta informar o mesmo no payload.

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "integration_equipment_id": 1,
    "active": true,
    "start_date": 1706756400,
    "final_date": 1709089200,
    "current_date": null
}

{warning} Response 422 (application/json)

{
  "id": [
    "O campo ID do registro selecionado é inválido."
  ],
  "integration_equipment_id": [
    "O campo integration equipment id selecionado é inválido."
  ],
  "equipment_id": [
    "Permissões insuficientes para esse grupo econômico"
  ]
}

{warning} Response 403 (application/json)

"Permissões insuficientes!"
"Permissões insuficientes para esse equipamento"

Deletar

Endpoint que deleta um registro específico.

Method URI Headers Authorization
DELETE /api/v3/integrations-equipments-history/1 Content-Type: application/json Authorization: Bearer {token}

Parameters

id: 1 (integer, required) - "Id do integration equipment history."

Response

{success} Response 200 (application/json)

{warning} Response 403 (application/json)

"Permissões insuficientes!"
"Permissões insuficientes ou equipamento não existente."