Equipamentos do Grupo

Listar

Endpoint que lista todos os equipamentos asssociados a um grupo.

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

Parameters

apportionment_group_id: 1 (integer) - "Id do Grupo de Rateio."
_q: 'texto' (string) - "Busca a * DESCREVER ENTIDADE * pelos campos * LISTAR CAMPOS DE BUSCA *."
_sort: 'id' (string) ('id') - "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."

Response

{success} Response 200 (application/json)

{
   "items": [
      {
         "id": 1,
         "apportionment_group_id": 6,
         "equipment_id": 1,
         "equipment": {
            "id": 1,
            "nome": "Equipamento 1 ",
         }
      },
      {
         "id": 2,
         "apportionment_group_id": 6,
         "equipment_id": 2,
         "equipment": {
            "id": 2,
            "nome": "Equipamento 2",
         }
      },
      {
         "id": 3,
         "apportionment_group_id": 6,
         "equipment_id": 3,
         "equipment": {
            "id": 3,
            "nome": "Equipamento 3",
         }
      }
   ],
   "total": 3,
   "per_page": 10,
   "current_page": 1
}

{warning} Response 422 (application/json)

{
    "apportionment_group_id": [
        "O campo apportionment group id selecionado é inválido.",
        "O campo apportionment group id deve ser um número inteiro."
    ],
    "_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.

Pegar

Endpoint que pega uma associação entre grupo e equipamento específico.

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

Parameters

id: 1 (integer) - "Id da associação entre grupo e equipamento"

Response

{success} Response 200 (application/json)

{
   "id": 1,
   "apportionment_group_id": 6,
   "equipment_id": 1,
   "equipment": {
      "id": 1,
      "nome": "Equipamento 1 ",
   }
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Criar

Endpoint que cria ou atualiza uma associação entre equipamento e um grupo.

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

Attributes

apportionment_group_id: 7 (integer, required) - "Id do Grupo de Rateio",
equipment_id: 6 (integer, required) - "Id do Equipamento"

Response

{success} Response 201 (application/json)

{
   "id": 1,
   "apportionment_group_id": 6,
   "equipment_id": 1,
   "equipment": {
      "id": 1,
      "nome": "Equipamento 1 ",
   }
}

{warning} Response 422 (application/json)

{
   "apportionment_group_id": [
      "O campo apportionment group id selecionado é inválido."
   ],
   "equipment_id": [
      "O campo equipment id selecionado é inválido."
   ]
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Deletar

Endpoint que deleta um associação entre grupo e equipamento.

Method URI Headers Authorization
DELETE /api/v3/apportionments-groups-equipments/{id} Content-Type:application/json Authorization: Bearer {token}

Parameters

id: 1 (integer) - "Id da associação entre grupo e equipamento"

Response

{primary} Response 204 (application/json)

Quando o registro for excluído com sucesso.