Endpoint que lista todas as constantes.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| GET | /api/v4/device-constants | Content-Type:application/json | Authorization: Bearer {token} |
device_id: 1 (integer) - "id do dispositivo para filtrar as constantes"
_sort: 'id' (string) - "Define o campo de ordenação da lista. (id,initial_date)"
_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."{success} Response 200 (application/json)
{
"items": [
{
"id": 1,
"device_id": 11,
"potential_relation": 11,
"current_relation": 24,
"meter_constant": 3.14,
"loss_factor": 2,
"initial_date": "2020-08-04 20:56:58"
},
{
"id": 2,
"device_id": 12,
"potential_relation": 175,
"current_relation": 40,
"meter_constant": 0.3,
"loss_factor": 0.3,
"initial_date": "2020-08-05 18:55:00"
}
],
"total": 2,
"per_page": 10,
"current_page": 1,
"last_page": 1
}{warning} Response 422 (application/json)
{
"device_id": [
"O campo device id selecionado é inválido."
],
"_sort": [
"O campo sort selecionado é inválido."
],
"_order": [
"O campo order selecionado é inválido."
],
"_limit": [
"O campo limit deve ser um número inteiro."
],
"_page": [
"O campo page deve ser um número inteiro."
]
}{primary} Response 204 (application/json).
Quando os critérios de parâmetros não contiver registros a serem retornados.
Endpoint que pega uma constante específica.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| GET | /api/v4/device-constants/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (required, integer) - "Id da constante"{success} Response 200 (application/json)
{
"id": 1,
"device_id": 11,
"potential_relation": 11,
"current_relation": 24,
"meter_constant": 3.14,
"loss_factor": 2,
"initial_date": "2020-08-04 20:56:58"
}{primary} Response 404 (application/json)
Quando o registro não existir ou o usuário não tiver permissão de visualização.
Endpoint que cria uma constante.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v4/device-constants | Content-Type:application/json | Authorization: Bearer {token} |
device_id: 1 (int, required) - "Id do dispositivo"
current_relation: 1 (float, required) - "Valor de relação corrente. Deve ser diferente de 0"
potential_relation: 1 (float, required) - "Valor de relação potencial. Deve ser diferente de 0"
meter_constant: 1 (float, required) - "Valor de constante medidor. Deve ser diferente de 0"
loss_factor: 1 (float) - "Valor de fator de perda. Deve ser diferente de 0"
initial_date: '2024-01-01 00:00:00' (string) - "Data de início da validade da constante. Se não informada a data de inicio será a data e hora atuais"{success} Response 201 (application/json)
{
"id": 46,
"device_id": 11,
"potential_relation": 4,
"current_relation": 5,
"meter_constant": 2,
"loss_factor": 2,
"initial_date": "2021-08-04 20:56:58"
}{warning} Response 422 (application/json)
{
"device_id": [
"O campo device id selecionado é inválido."
],
"current_relation": [
"O campo current relation selecionado é inválido."
],
"potential_relation": [
"O campo potential relation selecionado é inválido."
],
"meter_constant": [
"O campo meter constant selecionado é inválido."
],
"loss_factor": [
"O campo loss factor selecionado é inválido."
],
"initial_date": [
"O campo data inicial não corresponde ao formato Y-m-d H:i:s.",
"O campo data inicial já está sendo utilizado para este equipamento"
]
}{primary} Response 204 (application/json)
Quando o registro não existir ou o usuário não tiver permissão de visualização.
Endpoint que atualiza uma constante específica.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| PUT | /api/v4/device-constants/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (required, integer) - "Id da constante"device_id: 1 (int) - "Id do dispositivo"
current_relation: 1 (float, null) - "Valor de relação corrente. Deve ser diferente de 0"
potential_relation: 1 (float, null) - "Valor de relação potencial. Deve ser diferente de 0"
meter_constant: 1 (float, null) - "Valor de constante medidor. Deve ser diferente de 0"
loss_factor: 1 (float) - "Valor de fator de perda. Deve ser diferente de 0"
initial_date: '2024-01-01 00:00:00' (string, null) - "Data de início da validade da constante."{success} Response 200 (application/json)
{
"id": 46,
"device_id": 11,
"potential_relation": 4,
"current_relation": 5,
"meter_constant": 2,
"loss_factor": 2,
"initial_date": "2021-08-04 20:56:58"
}{warning} Response 422 (application/json)
{
"device_id": [
"O campo device id selecionado é inválido."
],
"current_relation": [
"O campo current relation selecionado é inválido."
],
"potential_relation": [
"O campo potential relation selecionado é inválido."
],
"meter_constant": [
"O campo meter constant selecionado é inválido."
],
"loss_factor": [
"O campo loss factor selecionado é inválido."
],
"initial_date": [
"O campo data inicial não corresponde ao formato Y-m-d H:i:s.",
"O campo data inicial já está sendo utilizado para este equipamento"
]
}{primary} Response 204 (application/json)
Quando o registro não existir ou o usuário não tiver permissão de visualização.
Endpoint que deleta uma constante específica.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| DELETE | /api/v4/device-constants/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (required, integer) - "Id da constante"{primary} Response 204 (application/json)
Quando o registro for excluído com sucesso.