Torna alla lista

Collezione v1

Restituisce una collezione con tutti i suoi item. Le collezioni pubblicate (stato=1) sono accessibili pubblicamente. Le bozze richiedono autenticazione.

Endpoint

GET /api/v1/collezione/{id}

Autenticazione

Autenticazione: none

Ogni richiesta deve includere la chiave API nell'header HTTP X-API-Key.

X-API-Key: <api_key>

Se la chiave è assente o non valida l'API risponde con HTTP 401.

Parametri

Parametro Tipo Obbligatorio Descrizione
id integer Obbligatorio ID della collezione (segmento path).

Note

  • Gli item includono risorse di piattaforme diverse (app + stringa_id + id_risorsa).
  • Il campo vista_default suggerisce la modalità di visualizzazione consigliata: 0=Griglia, 1=Lista, 2=Mappa, 3=Slideshow.
  • Il campo tipo indica la natura della collezione: 0=Galleria, 1=Tour360, 2=Ipermediale, 3=Mappa.
  • Gli item sono ordinati per il campo ordine.

Esempio richiesta

GET https://lexiper.it/api/v1/collezione/5

Esempio risposta

{
    "status": "success",
    "data": {
        "id": 5,
        "titolo": "Luoghi dei Malavoglia",
        "descrizione": "Raccolta fotografica dei luoghi verghiani.",
        "tipo": 0,
        "vista_default": 2,
        "stato": 1,
        "items": [
            {
                "app": "lexiper",
                "stringa_id": "fotografia",
                "id_risorsa": 120,
                "ruolo": 1,
                "ordine": 1,
                "nota": null
            },
            {
                "app": "verga",
                "stringa_id": "luogo",
                "id_risorsa": 7,
                "ruolo": 0,
                "ordine": 2,
                "nota": null
            }
        ]
    }
}