## Favourites and related andpoints

All the requests associated with the favorited require the presence of the JWT token.
See  [auth_and_requests.md](../auth_and_requests.md) 

Pagination:
see [PagingAndSorting.md](../PagingAndSorting.md) 

## Add Favorite ##

### POST - api/v1/favourite

Body parameters parameters:
* favourite_id - The id of the item that is being added to the favourites
* favourite_type - the type of favourite that is being added (artist, exhibition or collection)


##### Response:
```json
{
    "id": 8,
    "favourite": {
        "id": 2,
        "name": "Coleção Berardo",
        "description": "A exposição permanente da Coleção Berardo articula-se em dois pisos do espaço do museu, apresentando uma sequência de obras que percorre a arte século XX e termina na atualidade. O piso 2 centra-se na arte moderna; inicia-se no dealbar do século XX com Pablo Picasso e a criação do Cubismo e com Marcel Duchamp e as questões do ready-made, evoluindo até ao Neodadaísmo, ao Nouveau Réalisme e à Pop Art. O piso -1 é dedicado ao período posterior (de 1960 até aos nossos dias), seguindo uma ordem cronológica e agrupando os movimentos mais significativos das neo-vanguardas (minimalismo; concetualismo; Land Art; Arte Povera; etc.).[2]",
        "address_name": "Museu Coleção Berardo",
        "address": "Centro Cultural de Belém,\r\nPraça do Império\r\nLisboa, Portugal Portugal",
        "website": "https://www.museuberardo.pt/",
        "image_label": "Vista aérea do CCB",
        "image": {
            "750x750": {
                "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/ccb_750x750.jpeg"
            },
            "1500x1500": {
                "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/ccb_1500x1500.jpeg"
            }
        },
        "city": {
            "id": 1,
            "name": "Lisboa",
            "mapPositionLat": 38.744109384274,
            "mapPositionLng": -9.1612243652344,
            "mapPositionZoom": 10,
            "description": ""
        },
        "highlight": 0,
        "artists": [
            {
                "id": 2,
                "name": "Joana Vasconcelos",
                "description": "<p></p><p><b>Joana Baptista Vasconcelos</b><sup class=\"reference\"><a href=\"https://pt.wikipedia.org/wiki/Joana_Vasconcelos#cite_note-1\">[1]</a></sup>&nbsp;<a href=\"https://pt.wikipedia.org/wiki/Ordem_do_Infante_D._Henrique\" title=\"Ordem do Infante D. Henrique\">ComIH</a>&nbsp;(<a href=\"https://pt.wikipedia.org/wiki/Paris\" title=\"Paris\">Paris</a>,&nbsp;<a href=\"https://pt.wikipedia.org/wiki/8_de_novembro\" title=\"8 de novembro\">8 de novembro</a>&nbsp;de&nbsp;<a href=\"https://pt.wikipedia.org/wiki/1971\" title=\"1971\">1971</a>) é uma artista plástica portuguesa.</p>\r\n<p>Representa Portugal na&nbsp;<a href=\"https://pt.wikipedia.org/wiki/Bienal_de_Veneza\" title=\"Bienal de Veneza\">Bienal de Veneza</a>&nbsp;de 2013, depois de se afirmar internacionalmente na exposição que fez no&nbsp;<a href=\"https://pt.wikipedia.org/wiki/Palácio_de_Versalhes\" title=\"Palácio de Versalhes\">Palácio de Versalhes</a>, por convite feito em 2012 pelo Presidente da instituição, Jean-Jacques Aillagon, dando seguimento ao programa de arte contemporânea iniciado em 2008.&nbsp;<sup class=\"reference\"><a href=\"https://pt.wikipedia.org/wiki/Joana_Vasconcelos#cite_note-2\">[2]</a></sup><sup class=\"reference\"><a href=\"https://pt.wikipedia.org/wiki/Joana_Vasconcelos#cite_note-3\">[3]</a></sup></p>\r\n<p>Depois do americano&nbsp;<a href=\"https://pt.wikipedia.org/wiki/Jeff_Koons\" title=\"Jeff Koons\">Jeff Koons</a>, dos franceses Xavier Veilhan e Bernar Venet e do japonês&nbsp;<a href=\"https://pt.wikipedia.org/wiki/Takashi_Murakami\" title=\"Takashi Murakami\">Takashi Murakami</a>, Joana Vasconcelos será a primeira mulher e a mais jovem artista contemporânea a expor em Versalhes, exposição essa que teve o maior número de visitantes dos últimos cinquenta anos à sua data.&nbsp;<sup class=\"reference\"><a href=\"https://pt.wikipedia.org/wiki/Joana_Vasconcelos#cite_note-4\">[4]</a></sup></p>",
                "image": {
                    "750x750": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/200px-joana-vasconcelos_750x750.png"
                    },
                    "1500x1500": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/200px-joana-vasconcelos_1500x1500.png"
                    }
                }
            }
        ]
    }
}

```


## Get The user favorites ##

### GET - api/v1/favourites



#### Example request: 
api/v1/favourites

##### Response:

```json
{
    "data": [
        {
            "id": 4,
            "favourite": {
                "id": 2,
                "type": "artist",
                "name": "Joana Vasconcelos",
                "image": {
                    "750x750": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/200px-joana-vasconcelos_750x750.png"
                    },
                    "1500x1500": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/200px-joana-vasconcelos_1500x1500.png"
                    }
                }
            }
        },
        {
            "id": 6,
            "favourite": {
                "id": 1,
                "type": "exhibition",
                "name": "Picasso na ZDB",
                "image": {
                    "750x750": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/deep-blue-sea-shutterstock-1512728810_750x750.jpeg"
                    },
                    "1500x1500": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/deep-blue-sea-shutterstock-1512728810_1500x1500.jpeg"
                    }
                },
                "dateStatus": "ongoing",
                "dateFrom": "2022-05-29 16:15:12",
                "dateTo": "2022-10-30 16:15:17"
            }
        },
        {
            "id": 7,
            "favourite": {
                "id": 3,
                "type": "collection",
                "name": "Coleção Gulbenkian",
                "image": {
                    "750x750": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/gulbenkian_750x750.jpeg"
                    },
                    "1500x1500": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/gulbenkian_1500x1500.jpeg"
                    }
                }
            }
        },
        {
            "id": 8,
            "favourite": {
                "id": 2,
                "type": "collection",
                "name": "Coleção Berardo",
                "image": {
                    "750x750": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/ccb_750x750.jpeg"
                    },
                    "1500x1500": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/ccb_1500x1500.jpeg"
                    }
                }
            }
        },
        {
            "id": 9,
            "favourite": {
                "id": 1,
                "type": "artist",
                "name": "Picasso",
                "image": {
                    "750x750": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/atreides-1_750x750.jpg"
                    },
                    "1500x1500": {
                        "url": "http://contemporanea.lndo.site/storage/uploads/thumbs/atreides-1_1500x1500.jpg"
                    }
                }
            }
        }
    ],
    "pagination": {
        "current_page": 1,
        "total_items": 5,
        "per_page": 10,
        "total_pages": 1
    }
}
```



## Remove Favorite ##

### DELETE - api/v1/favourite/{id}

* id - ❗required

##### Response:
```json
{
    "message": "O registo foi removido"
}
```