{"swagger":"2.0","info":{"title":"Aneol Apidae API","description":"Apidae like restlet API","version":"1.0.0"},"host":"apidae.millylaforet-tourisme.com","schemes":["http"],"basePath":"","produces":["application\/json"],"paths":{"\/recherche\/":{"get":{"summary":"Recherche dans les objets APIDAE.","parameters":[{"name":"id","in":"query","description":"Filtre les objets sur le champ id.","required":false,"type":"array","items":{"type":"number","format":"int32"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"Filtre les objets sur le champ type.","required":false,"type":"string","enum":["ACTIVITE","COMMERCE_ET_SERVICE","DEGUSTATION","DOMAINE_SKIABLE","EQUIPEMENT","FETE_ET_MANIFESTATION","HEBERGEMENT_COLLECTIF","HEBERGEMENT_LOCATIF","HOTELLERIE","HOTELLERIE_PLEIN_AIR","PATRIMOINE_CULTUREL","PATRIMOINE_NATUREL","RESTAURATION","SEJOUR_PACKAGE","STRUCTURE"]},{"name":"categorie","in":"query","description":"Filtre les objets sur le champ categorie.","required":false,"type":"string","enum":["Evenement","Hebergement","Restaurant"]},{"name":"texte","in":"query","description":"Filtre les objets sur le champ nom et description.","required":false,"type":"string"},{"name":"selection","in":"query","description":"Filtre les objets sur le champ selection.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"territoire","in":"query","description":"Filtre les objets sur le champ selection.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"critere","in":"query","description":"Filtre les objets sur le champ critere.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"reference","in":"query","description":"Filtre les objets sur le champ reference.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"commune","in":"query","description":"Filtre les objets sur le champ commune.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"coordonnees","in":"query","description":"Recherche de rayon m\u00e8tres autour des coordonn\u00e9es (longitude,latitude,rayon).","required":false,"type":"array","items":{"type":"number","format":"float","minItems":3,"maxItems":3}},{"name":"capacite","in":"query","description":"Filtre les objets sur le champ capacite.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"prix","in":"query","description":"Filtre les objets sur le champ prix.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"juridique","in":"query","description":"Filtre pour afficher\/masquer les objets de type juridique","required":false,"type":"boolean","default":false},{"name":"datedebut","in":"query","description":"Objets avec une date d\u0027ouverture \u00e0 cette date ou apr\u00e8s cette date.","required":false,"type":"string","format":"date"},{"name":"datefin","in":"query","description":"Objets avec une date d\u0027ouverture \u00e0 cette date ou avant cette date.","required":false,"type":"string","format":"date"},{"name":"dates","in":"query","description":"Objets avec une date d\u0027ouverture entre ces deux dates.","required":false,"type":"array","items":{"type":"string","format":"date"}},{"name":"_debut","in":"query","description":"D\u00e9buter \u00e0 l\u0027objet _debut.","required":false,"type":"int","default":0},{"name":"_tri","in":"query","description":"Trier sur ce champ.","required":false,"type":"string","default":"nom","enum":["nom","commune","visuel","type","date","tarif_min","tarif_max","capacite"]},{"name":"_croissant","in":"query","description":"Trier par ordre croissant (true) ou d\u00e9croissant (false).","required":false,"type":"boolean","default":true},{"name":"_locale","in":"query","description":"Langue utilis\u00e9e dans ces textes.","required":false,"type":"string","default":"fr"},{"name":"_format","in":"query","description":"Niveau de d\u00e9tails des donn\u00e9es retourn\u00e9es.","required":false,"type":"string","enum":["id","listing","full","json","geo"],"default":"listing"}],"tags":["Objet"],"responses":{"200":{"$ref":"#\/responses\/ResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/facet\/":{"get":{"summary":"Objets touristiques","description":"Retourne un tableau d\u0027objets touristiques\n","parameters":[{"name":"facets","in":"query","description":"Filtre les objets selon les facettes renseign\u00e9es.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"_tri","in":"query","description":"Order result on this field.","required":false,"type":"string","default":"label"},{"name":"_croissant","in":"query","description":"Order asc.","required":false,"type":"boolean","default":true},{"name":"_locale","in":"query","description":"Locale used in the text.","required":false,"type":"string","default":"fr"},{"name":"_format","in":"query","description":"Return objects detail level.","required":false,"type":"string","enum":["id","listing","full","json","geo"],"default":"listing"}],"tags":["Objet"],"responses":{"200":{"$ref":"#\/responses\/ResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/agenda\/":{"get":{"summary":"Objets touristiques","description":"Retourne un tableau d\u0027objets touristiques\n","parameters":[{"name":"id","in":"query","description":"Filtre les objets sur le champ id.","required":false,"type":"array","items":{"type":"number","format":"int32"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"Filtre les objets sur le champ type.","required":false,"type":"string","enum":["ACTIVITE","COMMERCE_ET_SERVICE","DEGUSTATION","DOMAINE_SKIABLE","EQUIPEMENT","FETE_ET_MANIFESTATION","HEBERGEMENT_COLLECTIF","HEBERGEMENT_LOCATIF","HOTELLERIE","HOTELLERIE_PLEIN_AIR","PATRIMOINE_CULTUREL","PATRIMOINE_NATUREL","RESTAURATION","SEJOUR_PACKAGE","STRUCTURE"]},{"name":"texte","in":"query","description":"Filtre les objets sur le champ nom et description.","required":false,"type":"string"},{"name":"selection","in":"query","description":"Filtre les objets sur le champ selection.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"territoire","in":"query","description":"Filtre les objets sur le champ selection.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"critere","in":"query","description":"Filtre les objets sur le champ critere.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"reference","in":"query","description":"Filtre les objets sur le champ reference.","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"commune","in":"query","description":"Filtre les objets sur le champ commune. ","required":false,"type":"array","items":{"type":"number","format":"int32"}},{"name":"coordonnees","in":"query","description":"Recherche autour des coordonn\u00e9es (longitude,latitude).","required":false,"type":"array","items":{"type":"number","format":"float","minItems":2,"maxItems":2}},{"name":"rayon","in":"query","description":"Commune ou coordinn\u00e9es requis. Recherche des objets dans un rayon autour de la commune ou de la coordonn\u00e9e.","required":false,"type":"number","format":"double"},{"name":"debut","in":"query","description":"item beginning or begined at this date.","required":false,"type":"string","format":"date"},{"name":"fin","in":"query","description":"item ending or ended at this date.","required":false,"type":"string","format":"date"},{"name":"tri","in":"query","description":"Order result on this field.","required":false,"type":"string","default":"label"},{"name":"croissant","in":"query","description":"Order asc.","required":false,"type":"boolean","default":true},{"name":"locale","in":"query","description":"Locale used in the text.","required":false,"type":"string","default":"fr"},{"name":"format","in":"query","description":"Return objects detail level.","required":false,"type":"string","enum":["id","listing","full","json","geo"],"default":"listing"}],"tags":["Objet"],"responses":{"200":{"$ref":"#\/responses\/AgendaResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/objet\/{ids}":{"get":{"summary":"Return items","description":"Retourn items with id in ids.\n","parameters":[{"name":"ids","in":"path","description":"item id or id list","required":true,"type":"array","items":{"type":"number","format":"double"},"maxItems":100},{"name":"locale","in":"query","description":"Locale used in the text.","required":false,"type":"string","default":"fr"},{"name":"format","in":"query","description":"Return objects detail level.","required":false,"type":"string","enum":["id","listing","full","json","geo"],"default":"full"}],"tags":["Objet"],"responses":{"200":{"description":"Full items","schema":{"$ref":"#\/definitions\/ResultSet"}},"404":{"description":"Invalid object ids"},"default":{"$ref":"#\/responses\/Error"}}}},"\/selection":{"get":{"summary":"Return available selections","tags":["Selection"],"responses":{"200":{"$ref":"#\/responses\/SelectionResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/selection\/{ids}":{"get":{"summary":"Return available selections","tags":["Selection"],"parameters":[{"name":"ids","in":"path","description":"item id or id list","required":true,"type":"array","items":{"type":"number","format":"double"},"maxItems":100}],"responses":{"200":{"$ref":"#\/responses\/SelectionResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/commune":{"get":{"summary":"Return available cities","parameters":[{"name":"nom","in":"query","description":"Commune name start by","type":"string","required":false},{"name":"codepostal","in":"query","description":"Department or zip code number","required":false,"type":"string","pattern":"\/^[0-9]{2,5}$\/","minLength":2,"maxLength":5},{"name":"objet","in":"query","description":"Filtre ceux avec des objets li\u00e9s (comportement par d\u00e9faut).","required":false,"type":"boolean","default":true}],"tags":["Commune"],"responses":{"200":{"$ref":"#\/responses\/CommuneResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/commune\/{ids}":{"get":{"summary":"Return available commune","parameters":[{"name":"ids","in":"path","description":"item id or id list","required":true,"type":"array","items":{"type":"number","format":"double"},"maxItems":100},{"name":"objet","in":"query","description":"Filtre ceux avec des objets li\u00e9s (comportement par d\u00e9faut).","required":false,"type":"boolean","default":true}],"tags":["Commune"],"responses":{"200":{"$ref":"#\/responses\/CommuneResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/critere":{"get":{"summary":"Return available critere","tags":["Critere"],"responses":{"200":{"$ref":"#\/responses\/CritereResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/critere\/{ids}":{"get":{"summary":"Return available critere","parameters":[{"name":"ids","in":"path","description":"item id or id list","required":true,"type":"array","items":{"type":"number","format":"double"},"maxItems":100},{"name":"objet","in":"query","description":"Filtre ceux avec des objets li\u00e9s (comportement par d\u00e9faut).","required":false,"type":"boolean","default":true}],"tags":["Critere"],"responses":{"200":{"$ref":"#\/responses\/CritereResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/territoire":{"get":{"summary":"Return available territoire","parameters":[{"name":"objet","in":"query","description":"Filtre ceux avec des objets li\u00e9s (comportement par d\u00e9faut).","required":false,"type":"boolean","default":true}],"tags":["Territoire"],"responses":{"200":{"$ref":"#\/responses\/TerritoireResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/territoire\/{ids}":{"get":{"summary":"Return available territoire","parameters":[{"name":"objet","in":"query","description":"Filtre ceux avec des objets li\u00e9s (comportement par d\u00e9faut).","required":false,"type":"boolean","default":true},{"name":"ids","in":"path","description":"territoire id or id list","required":true,"type":"array","items":{"type":"number","format":"double"},"maxItems":100}],"tags":["Territoire"],"responses":{"200":{"$ref":"#\/responses\/TerritoireResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/reference":{"get":{"summary":"Return available reference","parameters":[{"name":"objet","in":"query","description":"Filtre ceux avec des objets li\u00e9s (comportement par d\u00e9faut).","required":false,"type":"boolean","default":true}],"tags":["Reference"],"responses":{"200":{"$ref":"#\/responses\/ReferenceResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/reference\/{ids}":{"get":{"summary":"Renvoi les references","parameters":[{"name":"objet","in":"query","description":"Filtre ceux avec des objets li\u00e9s (comportement par d\u00e9faut).","required":false,"type":"boolean","default":true},{"name":"ids","in":"path","description":"reference id or id list","required":true,"type":"array","items":{"type":"number","format":"double"},"maxItems":100}],"tags":["Reference"],"responses":{"200":{"$ref":"#\/responses\/ReferenceResultSet"},"default":{"$ref":"#\/responses\/Error"}}}},"\/admin\/facet\/{locale}":{"get":{"summary":"Returne l\u0027arbre des facettes.","parameters":[{"name":"locale","in":"path","description":"Langue de l\u0027arbre","required":true,"type":"string"}],"tags":["Facet"],"responses":{"200":{"description":"Facet list","schema":{"type":"array","items":{"$ref":"#\/definitions\/Facet"}}},"default":{"$ref":"#\/responses\/Error"}}},"post":{"summary":"Enregistre une nouvelle version de l\u0027arbre de facettes.","parameters":[{"name":"locale","in":"path","description":"Langue de l\u0027arbre","required":true,"type":"string"},{"name":"facets","in":"formData","description":"L\u0027arbre des facettes","required":true,"type":"array","items":{"$ref":"#\/definitions\/Facet"}}],"tags":["Facet"],"responses":{"201":{"description":"Mise \u00e0 jour r\u00e9ussie.","schema":{"type":"number","format":"int32"}},"default":{"$ref":"#\/responses\/Error"}}}}},"responses":{"ResultSet":{"description":"R\u00e9sultat de la recherche avec la demande, la pagination et les donn\u00e9es.","schema":{"$ref":"#\/definitions\/ResultSet"}},"AgendaResultSet":{"description":"R\u00e9sultat de la recherche avec la demande, la pagination et les donn\u00e9es regroup\u00e9es par 1\u00e8re date d\u0027occurence.","schema":{"$ref":"#\/definitions\/AgendaResultSet"}},"CommuneResultSet":{"description":"R\u00e9sultat de la recherche avec la demande, la pagination et les donn\u00e9es.","schema":{"$ref":"#\/definitions\/CommuneResultSet"}},"CritereResultSet":{"description":"R\u00e9sultat de la recherche avec la demande, la pagination et les donn\u00e9es.","schema":{"$ref":"#\/definitions\/CritereResultSet"}},"SelectionResultSet":{"description":"R\u00e9sultat de la recherche avec la demande, la pagination et les donn\u00e9es.","schema":{"$ref":"#\/definitions\/SelectionResultSet"}},"ReferenceResultSet":{"description":"R\u00e9sultat de la recherche avec la demande, la pagination et les donn\u00e9es.","schema":{"$ref":"#\/definitions\/ReferenceResultSet"}},"TerritoireResultSet":{"description":"R\u00e9sultat de la recherche avec la demande, la pagination et les donn\u00e9es.","schema":{"$ref":"#\/definitions\/TerritoireResultSet"}},"Error":{"description":"Retour en cas d\u0027erreur.","schema":{"$ref":"#\/definitions\/Error"}}},"definitions":{"Objet":{"type":"object","properties":{"id":{"type":"integer","format":"double","description":"item id."},"nom":{"type":"string","description":"item name."},"description":{"type":"string","description":"item description."},"selection":{"type":"array","items":{"$ref":"#\/definitions\/Selection"},"description":"Selections to which item is attached."},"commune":{"$ref":"#\/definitions\/Commune"},"categorie":{"type":"string","description":"item type.","enum":["Evenement","Hebergement","Restaurant"]},"type":{"type":"string","description":"item type.","enum":["ACTIVITE","COMMERCE_ET_SERVICE","DEGUSTATION","DOMAINE_SKIABLE","EQUIPEMENT","FETE_ET_MANIFESTATION","HEBERGEMENT_COLLECTIF","HEBERGEMENT_LOCATIF","HOTELLERIE","HOTELLERIE_PLEIN_AIR","PATRIMOINE_CULTUREL","PATRIMOINE_NATUREL","RESTAURATION","SEJOUR_PACKAGE","STRUCTURE"]},"image":{"type":"string","description":"Image URL."},"latitude":{"type":"number","format":"float","description":"Latitude."},"longitude":{"type":"number","format":"float","description":"Longitude."}}},"Commune":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Commune id."},"nom":{"type":"string","description":"Commune name"},"code_postal":{"type":"string","description":"Code postal"},"code":{"type":"string","description":"Code de la commune"},"code_pays":{"type":"string","description":"Code du pays"}}},"Critere":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Reference id."},"label":{"type":"string","description":"Reference name"}}},"Reference":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Reference id."},"nom":{"type":"string","description":"Reference name"}}},"Selection":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant de la s\u00e9lection."},"label":{"type":"string","description":"Libell\u00e9 de la s\u00e9lection."}}},"Territoire":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Territoire id."},"nom":{"type":"string","description":"Territoire name"}}},"ResultSet":{"type":"object","properties":{"query":{"$ref":"#\/definitions\/Demande"},"pagination":{"$ref":"#\/definitions\/Pagination"},"data":{"description":"Keys are item ids.","type":"array","items":{"$ref":"#\/definitions\/Objet"}}}},"AgendaResultSet":{"type":"object","properties":{"query":{"$ref":"#\/definitions\/Demande"},"pagination":{"$ref":"#\/definitions\/Pagination"},"data":{"description":"Keys are date.","type":"array","items":{"type":"array","description":"Keys are item ids.","items":{"$ref":"#\/definitions\/Objet"}}}}},"CommuneResultSet":{"type":"object","properties":{"query":{"$ref":"#\/definitions\/Demande"},"pagination":{"$ref":"#\/definitions\/Pagination"},"data":{"description":"Keys are item ids.","type":"array","items":{"$ref":"#\/definitions\/Commune"}}}},"CritereResultSet":{"type":"object","properties":{"query":{"$ref":"#\/definitions\/Demande"},"pagination":{"$ref":"#\/definitions\/Pagination"},"data":{"description":"Keys are item ids.","type":"array","items":{"$ref":"#\/definitions\/Critere"}}}},"ReferenceResultSet":{"type":"object","properties":{"query":{"$ref":"#\/definitions\/Demande"},"pagination":{"$ref":"#\/definitions\/Pagination"},"data":{"description":"Keys are item ids.","type":"array","items":{"$ref":"#\/definitions\/Reference"}}}},"SelectionResultSet":{"type":"object","properties":{"query":{"$ref":"#\/definitions\/Demande"},"pagination":{"$ref":"#\/definitions\/Pagination"},"data":{"description":"Keys are item ids.","type":"array","items":{"$ref":"#\/definitions\/Selection"}}}},"TerritoireResultSet":{"type":"object","properties":{"query":{"$ref":"#\/definitions\/Demande"},"pagination":{"$ref":"#\/definitions\/Pagination"},"data":{"description":"Keys are item ids.","type":"array","items":{"$ref":"#\/definitions\/Territoire"}}}},"Demande":{"description":"Summary of the request.","type":"object","properties":{"locale":{"type":"string","description":"Short language definition (fr, en...)."},"tri":{"type":"string","description":"Field name"},"croissant":{"type":"boolean","description":"Order asc or desc"},"debut":{"type":"integer","format":"int32","description":"Position in pagination."},"quantite":{"type":"integer","format":"int32","description":"Number of items to retrieve (100 max)."},"facets":{"type":"array","items":{"$ref":"#\/definitions\/Facet"},"description":"Facet available in this query result."},"filtres":{"type":"array","items":{"$ref":"#\/definitions\/Filtre"},"description":"Applyed request filters."},"erreurs":{"type":"array","items":{"type":"string"},"description":"Applyed request filters."}}},"Filtre":{"description":"Filter used in request propery of ResultSet.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"Pagination":{"description":"Pagination in request propery of ResultSet.","type":"object","properties":{"actuelle":{"type":"integer","description":"Current page."},"precedente":{"type":"integer","description":"Previous page number or null."},"suivante":{"type":"integer","description":"Next page number or null"},"limite":{"type":"integer","description":"Number of items per page."},"quantite":{"type":"integer","format":"int32","description":"Total number of items available."}}},"Facet":{"type":"object","properties":{"key":{"type":"string","description":"Key"},"label":{"type":"string","description":"Key"},"type":{"type":"string","description":"Facet type.","enum":["selection","reference","dates","gratuit","territoire","location"]},"multiple":{"type":"string","description":"Operator for multiselection.","enum":["and","or",false]},"choix":{"description":"Values available for this facet.","type":"array","items":{"$ref":"#\/definitions\/FacetChoix"}}}},"FacetChoix":{"type":"object","properties":{"label":{"type":"string","description":"Choice label"},"valeur":{"type":"string","description":"Choice value"},"type":{"type":"string","description":"Choice type. Available values: selection, reference, dates, gratuit, territoire, location."},"selectionne":{"type":"boolean","description":"Choice is selected."},"quantite":{"type":"number","description":"Quantity of items matching this choice."},"url":{"type":"string","description":"Url to apply this choice."},"min":{"type":"number","description":"Choice min value (range\/numeric types)."},"max":{"type":"number","description":"Choice max value (range\/numeric types)."},"prefix":{"type":"string","description":"String to put before choice value."},"suffix":{"type":"string","description":"String to put after choice value."},"pas":{"type":"number","description":"Choice step modifier (range\/numeric types)."}}},"Error":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"string"}}}}}