{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"64ea9732-99a8-4eaf-9643-fc1752fd0552","name":"OpenAgenda API","description":"Le OpenAgenda API offrono l'accesso in lettura e scrittura di eventi ed associazioni.\n\n# Accesso alle API\nE' possibile accedere alle API attraverso una richiesta HTTP al server API. Il server restituirà la risorsa richiesta con uno status code HTTP coerente con il risultato della richiesta fatta.\nIl formato di default della risposta dei moduli content è JSON.\n\n# Autenticazione\nAlcune richieste richiedono che il client effettui l'autenticazione. \nAl momento è disponibile l'autenticazione Basic.\nLe credenziali per utilizzare le risorse protette possono essere create dall'ambiente di amministrazione del sito ospitante: le ACL ivi definite sono valide anche per le richieste via API.\n\n# Codici di errore\n\n| Errori  |\n|:------------- |\n| 401 Unauthorized |\n| 403 Forbidden |\n| 404 Not Found |\n| 405 Method Not Allowed |\n| 500 Internal Server Error |\n\n# Infrastruttura dell'informazione\n\nLe OpenAgenda API espongono un livello REST specializzato del content model di eZ Publish Legacy (vedi https://doc.ez.no/eZ-Publish/Technical-manual/4.x/Concepts-and-basics/Content-management).\n\nPer lavorare con i contenuti di tipo Evento ed Associazione attraverso le API è necessario perciò conoscere l'architettura dell'informazione del sito ospitante (attraverso l'esplorazione delle API di classe) e coniugarla nei contenuti sui cui si intende lavorare.\nIl formato dei contenuti restituiti dalle API, pur avendo una struttura di base identica, varia a seconda della classe di contenuto che istanzia.\n\n## Attributi e datatype\n\nL'elemento minimo del content model di eZ Publish è l'attributo.\nLa classe è infatti la collezione di un determinato numero di attributi di classe (class attributes) e in ciascun contenuto di conseguenza vengono rappresentati gli attributi di oggetto.\n\nCiascun attributo è caratterizzato da un datatype: la tipologia di contenuto che rappresenza. \nAd esempio un attributo con datatype `ezstring` rappresenta una stringa, uno con datatype `ezinteger` un numero intero.\n\nLa risorsa contenuto viene esposta come un oggetto composto da due proprietà che ne rappresentano i metadati e i dati veri e propri.\n\n\n| Identificatore| Tipo di dato  | Descrizione                                 |\n|:------------- |:---------------|:--------------------------------------------|\n| metadata      | object        | Rappresentazione dei metadati del contenuto |\n| data          | object        | Rappresentazione dei dati del contenuto     |\n\n### Metadata\n\nI metadati sono informazioni non riferibili al contentuto vero e proprio dell'oggetto ma al suo contesto. Attraverso i metadati è possibile raggiungere informazioni utili per la ricerca quali l'identificativo unico della risorsa, la classe di contenuto utilizzata, le date di pubblicazione e di modifica, la sezione e gli stati in cui il contenuto è classificato, l'autore, gli id dei nodi in cui il contenuto è collocato nell'alberatura\nun numero intero.\n\n| Identificatore| Tipo di dato  | Descrizione                                 | Note |\n|:------------- |:---------------|:-----------------------------------------|:----|\n| id            | integer       | Id univoco del contenuto nel server API     | Sola lettura |\n| remoteId      | string        | Id univoco del contenuto nel server API impostato dal redattore o dal processo di importazione automatica: per design la sua lunghezza non può superare i 100 caratteri     | |\n| classIdentifier  | string       | Identificatore della classe di contenuto utilizzata dalla risorsa esposta     | |\n| class  | uri       | Url di accesso alla risorsa classe utilizzata dalla risorsa esposta     | Sola lettura |\n| sectionIdentifier            | string       | Identificatore della sezione utilizzata dalla risorsa esposta     | |\n| stateIdentifiers            | array       | Array degli identificatori di stato (nel formato <stategroup_identifier>.<state_identifier>  utilizzati dalla risorsa esposta   | |\n| published            | Date ISO 8601   | Data di pubblicazione del contenuto     | Sola lettura |\n| modified            | Date ISO 8601   | Data di ultima modifica del contenuto     | Sola lettura |\n| languages            | array   | Array degli identificatori di lingua delle traduzioni disponibili della risorsa esposta     | Sola lettura |\n| name | hash | Array associativo del nome della risorsa per ciascuna traduzione disponibile | Sola lettura |\n| parentNodes            | array       | Array dei Id dei Nodi in cui è collocato l'oggetto informativo     | |\n| link            | uri       | Url di accesso alla risorsa richiesta     | Sola lettura |\n\n### Data\n\n| Identificatore| Tipo di dato  | Descrizione                                 |\n|:------------- |:---------------|:--------------------------------------------|\n| (Identificatore di lingua)      | object        | Rappresentazione degli attributi del contenuto |\n\nLa risorsa Data espone il contenuto informativo del content per ciascuna traduzione disponibile. Ad ogni identificatore di lingua corrisponde da un oggetto chiave-valore dove ciascuna chiave è l'identificatore dell'attributo e ciascun valore è rappresentato da un tipo di dato primitivo o strutturato ).\nData la natura flessibile del content model di eZPublish è necessario ricavare la struttura della risorsa Data attravero la definizione della classe raggiungibile dall'url esposto in ```content.metadata.class```.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7046499","team":542636,"collectionId":"64ea9732-99a8-4eaf-9643-fc1752fd0552","publishedId":"S17tPncK","public":true,"publicUrl":"https://documenter-api.postman.tech/view/7046499/S17tPncK","privateUrl":"https://go.postman.co/documentation/7046499-64ea9732-99a8-4eaf-9643-fc1752fd0552","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2019-03-25T20:50:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"OpenAgenda API","id":"2dc474d5-98f1-4121-9d8e-d58e784a12ec","owner":"7046499","values":[{"key":"base-api-url","value":"https://openagenda.openpa.opencontent.io/","description":"","enabled":true},{"key":"content-id","value":"da5c2ed8e77eae4169d434486fdd8865","description":"","enabled":true},{"key":"api-user","value":"apiuser","description":"","enabled":true},{"key":"api-password","value":"apipassword","description":"","enabled":true},{"key":"class-identifier","value":"avviso","description":"","enabled":true},{"key":"query","value":"classes [event]","description":"","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/27d12ea8b0bc8924d15c5dd250128b5397f17e907654873f9536e0307d731f9c","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"OpenAgenda API","value":"7046499-2dc474d5-98f1-4121-9d8e-d58e784a12ec"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S17tPncK"}