Relações

Relações

Nas requisições do tipo Listar é possível adicionar as relações de dados nas respostas, essas relações serão possíveis somente se existir um campo do tipo id na resposta e esse fizer referência a outro registro, por exemplo:

Resposta original.

JSON

{
    "id": 2,
    "group_id": 1, <-- Faz referência ao grupo com id 1
    "name": "Mensalidades",
    "is_operational": true,
    "is_active": true
}

Na resposta com relações, é adicionado um objeto contendo os dados mais relevantes do grupo

JSON

{
    "id": 2,
    "group_id": 1,
    "name": "Mensalidades",
    "is_operational": true,
    "is_active": true,
    "group": { <-- Grupo adicionado ao habilitar as relações
        "id": 1,
        "name": " Receitas de Cursos",
        "type": "credit",
        "is_operational": true
    }
}

Para que sejam retornadas as relações, adicione o parâmetro relations na url da requisição, por exemplo https://api.webdanca.com/legacy/v1/students?relations.

⚠️ Atenção

habilitar relações impacta consideravelmente na performance das respostas, mas ainda assim em alguns casos é mais vantajoso que efetuar diversas requisições em endpoints diferentes.