Modalidades Tarifárias

• Listar
• Detalhes

Listar

Endpoint que lista todos as modalidades tarifárias.

Parameters

_q: 'Nome' (string) ('name') - "Busca a modalidade tarifária pelo nome."
_sort: 'id' (string) ('id', 'name') - "Define o campo de ordenação da lista."
_order: 'desc' (string) ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
voltage_classes: [1] (array) - "Ids das classes de voltagem."
tariff_posts: [1] (array) - "Ids dos postos tarifários."

Response

{success} Response 200 (application/json)

{
  "items": [
    {
      "id": 2,
      "name": "Azul",
      "voltage_classes": [
        {
          "id": 1,
          "name": "A1"
        }
      ],
      "tariff_posts": [
        {
          "id": 2,
          "name": "off_peak",
          "description": "fora ponta"
        },
        {
          "id": 1,
          "name": "peak",
          "description": "ponta"
        }
      ]
    }
  ],
  "total": 1,
  "per_page": 20,
  "current_page": 1,
  "last_page": 1
}

{primary} Response 204 (application/json).

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

Detalhes

Endpoint que pega um registro de modalidade tarifária.

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "name": "Verde",
    "voltage_classes": [
        {
          "id": 4,
          "name": "A3A"
        },
        {
          "id": 5,
          "name": "A4"
        },
        {
          "id": 6,
          "name": "AS"
        }
        ],
        "tariff_posts": [
        {
          "id": 2,
          "name": "off_peak",
          "description": "fora ponta"
        }
    ]
}

{primary} Response 204 (application/json).

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