Medições - Posto Tarifário

• Listar
• Pegar
• Criar
• Atualizar
• Remover

Listar

Endpoint que lista postos tarifários da Medição.

Parameters

_sort: id (string) ("id", "start_hour", "final_hour") - "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."
equipment_id: 1 (required, integer) - "Id do Equipamento"

Response

{success} Response 200 (application/json)

{
  "items": [
      {
          "id": 1,
          "equipment_id": 1,
          "start_hour": "10:00:00",
          "final_hour": "19:00:00",
          "day_week": [
              0,
              1,
              2,
              3,
              4
          ]
      },
      {
          "id": 2,
          "equipment_id": 1,
          "start_hour": "09:00:00",
          "final_hour": "18:00:00",
          "day_week": [
              0,
              1,
              2,
              3,
              4,
              5
          ]
      }
  ],
  "total": 2,
  "per_page": 10,
  "current_page": 1
}

{primary} Response 204 (application/json)

Quando os critérios de parâmetros não contiver registros a serem retornados.

{warning} Response 422 (application/json)

{
    "equipment_id": [
        "O campo medição selecionada é inválida."
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.

Pegar

Endpoint que pega os dados de um posto tarifário específico da medição.

Parameters

tariffPostId: 1 - (integer, required) - "Id do posto tarifário"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "equipment_id": 1,
    "start_hour": "04:04:40",
    "final_hour": "10:45:13",
    "days_week": [
        1,
        2,
        3,
        4,
        5
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.

Criar

Endpoint que cria um posto tarifário para a medição.

Attributes

equipment_id: (required, integer) - "Id do Equipamento",
start_hour: (required, string) - "Hora de inicio do posto tarifário",
final_hour:  (required,string) = "Hora de término do posto tarifário",
days_week:  [0,1,2,3,4] (required, array) - "Dias da semana que o posto tarifário é válido"

Response

{success} Response 201 (application/json)

{
    "id": 25,
    "equipment_id": 1,
    "start_hour": "09:00",
    "final_hour": "18:00",
    "days_week": [
        0,
        1,
        2,
        3,
        4,
        5
    ]
}

{warning} Response 422 (application/json)

{
    "equipment_id": [
        "O campo medição é obrigatório."
    ],
    "start_hour": [
        "O campo start hour é obrigatório."
    ],
    "final_hour": [
        "O campo final hour é obrigatório."
    ],
    "days_week": [
        "O campo days week é obrigatório."
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.

Atualizar

Endpoint que atualiza um posto tarifário para a medição.

Attributes

equipment_id: (integer) - "Id do Equipamento",
start_hour: (string) - "Hora de inicio do posto tarifário",
final_hour:  (string) = "Hora de término do posto tarifário",
days_week:  [0,1,2,3,4] (array) - "Dias da semana que o posto tarifário é válido"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "equipment_id": 1,
    "start_hour": "10:00:00",
    "final_hour": "19:00:00",
    "day_week": [
        0,
        1,
        2,
        3,
        4
    ]
}

{warning} Response 422 (application/json)

{
    "equipment_id": [
        "O campo medição deve ser um número inteiro.",
        "Permissões insuficientes para esse grupo econômico"
    ],
    "start_hour": [
        "O campo start hour deve ser uma string."
    ],
    "final_hour": [
        "O campo final hour deve ser uma string."
    ],
    "days_week": [
        "O campo days week deve ser uma matriz."
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.

Deletar

Endpoint que deleta um posto tarifário da medição.

Response

{primary} Response 204 (application/json)

Quando o registro for excluido com sucesso.

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.