POST api/widgets
Crée un nouveau widget
Description de la Requête
Paramètres de l'URI
Aucun.
Paramètres du corps de la requête (BODY)
Widget| Nom | Description | Type | Informations complémentaires |
|---|---|---|---|
| w_id |
Récupère ou définit l'identifiant du widget |
globally unique identifier |
Aucune. |
| w_name |
Récupère ou définit le nom du widget |
string |
Aucune. |
| w_owner_email |
L'identifiant du propriétaire (adresse mail) |
string |
Aucune. |
| w_owner_region |
La région du propriétaire |
string |
Aucune. |
| w_created |
Récupère ou définit la date de création du widget |
date |
Aucune. |
| w_height |
Récupère ou définit la hauteur du widget (en mode IFrame) |
integer |
Aucune. |
| w_width |
Récupère ou définit la largeur du widget (en mode IFrame) |
integer |
Aucune. |
| w_display |
Le type d'affichage du widget |
WidgetDisplayTypeEnum |
Aucune. |
| w_imagesize |
Récupère ou définit la taille d'affichage des images |
integer |
Aucune. |
| w_modesimple |
Affiche uniquement le titre, la date et le lieu |
boolean |
Aucune. |
| w_backgroundcolor |
La couleur d'arrière-plan du widget |
integer |
Aucune. |
| w_bordercolor |
La couleur des bordures du widget |
integer |
Aucune. |
| w_titlecolor |
La couleur du titre |
integer |
Aucune. |
| w_buttoncolor |
La couleur des boutons |
integer |
Aucune. |
| w_rubriquecolor |
La couleur des rubriques |
integer |
Aucune. |
| w_foregroundcolor |
La couleur du texte |
integer |
Aucune. |
| w_items_per_page |
le nombre d'items à afficher par page |
integer |
Aucune. |
| hide_gmap |
Indique si on doit masquer la carte GoogleMap |
boolean |
Aucune. |
| w_language |
La langue d'affichage des offres |
string |
Aucune. |
| w_search |
La configuration de recherche associée au widget |
WidgetSearch |
Aucune. |
Formats de la requête
application/json, text/json
Sample:
{
"w_id": "96a59420-9177-4ba5-9dae-e47b68c7b6f2",
"w_name": "lorem ipsum dolor 2",
"w_owner_email": "lorem ipsum dolor 3",
"w_owner_region": "lorem ipsum dolor 4",
"w_created": "2025-04-30T11:10:36.3451688+02:00",
"w_height": 6,
"w_width": 7,
"w_display": 0,
"w_imagesize": 8,
"w_modesimple": true,
"w_backgroundcolor": 10,
"w_bordercolor": 11,
"w_titlecolor": 12,
"w_buttoncolor": 13,
"w_rubriquecolor": 14,
"w_foregroundcolor": 15,
"w_items_per_page": 16,
"hide_gmap": true,
"w_language": "lorem ipsum dolor 18",
"w_search": {
"tri": "lorem ipsum dolor 1",
"keyword": "lorem ipsum dolor 2",
"periode": 3,
"destination": "lorem ipsum dolor 4",
"dateDebut": "lorem ipsum dolor 5",
"dateFin": "lorem ipsum dolor 6",
"region": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"departement": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"types": "lorem ipsum dolor 7",
"categorie": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"services": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"localisation": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"activites": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"tarifmini": "lorem ipsum dolor 8",
"tarifmaxi": "lorem ipsum dolor 9",
"distance": "lorem ipsum dolor 10",
"capacite": "lorem ipsum dolor 11",
"typehebergement": "lorem ipsum dolor 12",
"destinationRayon": 13,
"destinationGeo": [
{
"value": "lorem ipsum dolor 1",
"lat": "lorem ipsum dolor 2",
"lon": "lorem ipsum dolor 3",
"label": "lorem ipsum dolor 4",
"depId": "lorem ipsum dolor 5"
},
{
"value": "lorem ipsum dolor 1",
"lat": "lorem ipsum dolor 2",
"lon": "lorem ipsum dolor 3",
"label": "lorem ipsum dolor 4",
"depId": "lorem ipsum dolor 5"
}
],
"type": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"cuisine": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
]
}
}
application/xml, text/xml
Sample:
<apiWidget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Widget">
<hide_gmap>true</hide_gmap>
<w_backgroundcolor>10</w_backgroundcolor>
<w_bordercolor>11</w_bordercolor>
<w_buttoncolor>13</w_buttoncolor>
<w_created>2025-04-30T11:10:36.3451688+02:00</w_created>
<w_display>Horizontal</w_display>
<w_foregroundcolor>15</w_foregroundcolor>
<w_height>6</w_height>
<w_id>96a59420-9177-4ba5-9dae-e47b68c7b6f2</w_id>
<w_imagesize>8</w_imagesize>
<w_items_per_page>16</w_items_per_page>
<w_language>lorem ipsum dolor 18</w_language>
<w_modesimple>true</w_modesimple>
<w_name>lorem ipsum dolor 2</w_name>
<w_owner_email>lorem ipsum dolor 3</w_owner_email>
<w_owner_region>lorem ipsum dolor 4</w_owner_region>
<w_rubriquecolor>14</w_rubriquecolor>
<w_search>
<activites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</activites>
<capacite>lorem ipsum dolor 11</capacite>
<categorie xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</categorie>
<cuisine xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</cuisine>
<dateDebut>lorem ipsum dolor 5</dateDebut>
<dateFin>lorem ipsum dolor 6</dateFin>
<departement xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</departement>
<destination>lorem ipsum dolor 4</destination>
<destinationGeo>
<DestinationGeo>
<depId>lorem ipsum dolor 5</depId>
<label>lorem ipsum dolor 4</label>
<lat>lorem ipsum dolor 2</lat>
<lon>lorem ipsum dolor 3</lon>
<value>lorem ipsum dolor 1</value>
</DestinationGeo>
<DestinationGeo>
<depId>lorem ipsum dolor 5</depId>
<label>lorem ipsum dolor 4</label>
<lat>lorem ipsum dolor 2</lat>
<lon>lorem ipsum dolor 3</lon>
<value>lorem ipsum dolor 1</value>
</DestinationGeo>
</destinationGeo>
<destinationRayon>13</destinationRayon>
<distance>lorem ipsum dolor 10</distance>
<keyword>lorem ipsum dolor 2</keyword>
<localisation xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</localisation>
<periode>3</periode>
<region xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</region>
<services xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</services>
<tarifmaxi>lorem ipsum dolor 9</tarifmaxi>
<tarifmini>lorem ipsum dolor 8</tarifmini>
<tri>lorem ipsum dolor 1</tri>
<type xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</type>
<typehebergement>lorem ipsum dolor 12</typehebergement>
<types>lorem ipsum dolor 7</types>
</w_search>
<w_titlecolor>12</w_titlecolor>
<w_width>7</w_width>
</apiWidget>
application/x-www-form-urlencoded
Sample:
Exemple non disponible.
Description de la réponse
Description de la ressource retournée
La liste des widgets
Widget| Nom | Description | Type | Informations complémentaires |
|---|---|---|---|
| w_id |
Récupère ou définit l'identifiant du widget |
globally unique identifier |
Aucune. |
| w_name |
Récupère ou définit le nom du widget |
string |
Aucune. |
| w_owner_email |
L'identifiant du propriétaire (adresse mail) |
string |
Aucune. |
| w_owner_region |
La région du propriétaire |
string |
Aucune. |
| w_created |
Récupère ou définit la date de création du widget |
date |
Aucune. |
| w_height |
Récupère ou définit la hauteur du widget (en mode IFrame) |
integer |
Aucune. |
| w_width |
Récupère ou définit la largeur du widget (en mode IFrame) |
integer |
Aucune. |
| w_display |
Le type d'affichage du widget |
WidgetDisplayTypeEnum |
Aucune. |
| w_imagesize |
Récupère ou définit la taille d'affichage des images |
integer |
Aucune. |
| w_modesimple |
Affiche uniquement le titre, la date et le lieu |
boolean |
Aucune. |
| w_backgroundcolor |
La couleur d'arrière-plan du widget |
integer |
Aucune. |
| w_bordercolor |
La couleur des bordures du widget |
integer |
Aucune. |
| w_titlecolor |
La couleur du titre |
integer |
Aucune. |
| w_buttoncolor |
La couleur des boutons |
integer |
Aucune. |
| w_rubriquecolor |
La couleur des rubriques |
integer |
Aucune. |
| w_foregroundcolor |
La couleur du texte |
integer |
Aucune. |
| w_items_per_page |
le nombre d'items à afficher par page |
integer |
Aucune. |
| hide_gmap |
Indique si on doit masquer la carte GoogleMap |
boolean |
Aucune. |
| w_language |
La langue d'affichage des offres |
string |
Aucune. |
| w_search |
La configuration de recherche associée au widget |
WidgetSearch |
Aucune. |
Formats de réponse
application/json, text/json
Sample:
{
"w_id": "97c3c23e-9c3d-4e67-8289-53de3fcabdf7",
"w_name": "lorem ipsum dolor 2",
"w_owner_email": "lorem ipsum dolor 3",
"w_owner_region": "lorem ipsum dolor 4",
"w_created": "2025-04-30T11:10:36.3471599+02:00",
"w_height": 6,
"w_width": 7,
"w_display": 0,
"w_imagesize": 8,
"w_modesimple": true,
"w_backgroundcolor": 10,
"w_bordercolor": 11,
"w_titlecolor": 12,
"w_buttoncolor": 13,
"w_rubriquecolor": 14,
"w_foregroundcolor": 15,
"w_items_per_page": 16,
"hide_gmap": true,
"w_language": "lorem ipsum dolor 18",
"w_search": {
"tri": "lorem ipsum dolor 1",
"keyword": "lorem ipsum dolor 2",
"periode": 3,
"destination": "lorem ipsum dolor 4",
"dateDebut": "lorem ipsum dolor 5",
"dateFin": "lorem ipsum dolor 6",
"region": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"departement": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"types": "lorem ipsum dolor 7",
"categorie": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"services": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"localisation": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"activites": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"tarifmini": "lorem ipsum dolor 8",
"tarifmaxi": "lorem ipsum dolor 9",
"distance": "lorem ipsum dolor 10",
"capacite": "lorem ipsum dolor 11",
"typehebergement": "lorem ipsum dolor 12",
"destinationRayon": 13,
"destinationGeo": [
{
"value": "lorem ipsum dolor 1",
"lat": "lorem ipsum dolor 2",
"lon": "lorem ipsum dolor 3",
"label": "lorem ipsum dolor 4",
"depId": "lorem ipsum dolor 5"
},
{
"value": "lorem ipsum dolor 1",
"lat": "lorem ipsum dolor 2",
"lon": "lorem ipsum dolor 3",
"label": "lorem ipsum dolor 4",
"depId": "lorem ipsum dolor 5"
}
],
"type": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
],
"cuisine": [
"lorem ipsum dolor 1",
"lorem ipsum dolor 2"
]
}
}
application/xml, text/xml
Sample:
<apiWidget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Widget">
<hide_gmap>true</hide_gmap>
<w_backgroundcolor>10</w_backgroundcolor>
<w_bordercolor>11</w_bordercolor>
<w_buttoncolor>13</w_buttoncolor>
<w_created>2025-04-30T11:10:36.3471599+02:00</w_created>
<w_display>Horizontal</w_display>
<w_foregroundcolor>15</w_foregroundcolor>
<w_height>6</w_height>
<w_id>97c3c23e-9c3d-4e67-8289-53de3fcabdf7</w_id>
<w_imagesize>8</w_imagesize>
<w_items_per_page>16</w_items_per_page>
<w_language>lorem ipsum dolor 18</w_language>
<w_modesimple>true</w_modesimple>
<w_name>lorem ipsum dolor 2</w_name>
<w_owner_email>lorem ipsum dolor 3</w_owner_email>
<w_owner_region>lorem ipsum dolor 4</w_owner_region>
<w_rubriquecolor>14</w_rubriquecolor>
<w_search>
<activites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</activites>
<capacite>lorem ipsum dolor 11</capacite>
<categorie xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</categorie>
<cuisine xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</cuisine>
<dateDebut>lorem ipsum dolor 5</dateDebut>
<dateFin>lorem ipsum dolor 6</dateFin>
<departement xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</departement>
<destination>lorem ipsum dolor 4</destination>
<destinationGeo>
<DestinationGeo>
<depId>lorem ipsum dolor 5</depId>
<label>lorem ipsum dolor 4</label>
<lat>lorem ipsum dolor 2</lat>
<lon>lorem ipsum dolor 3</lon>
<value>lorem ipsum dolor 1</value>
</DestinationGeo>
<DestinationGeo>
<depId>lorem ipsum dolor 5</depId>
<label>lorem ipsum dolor 4</label>
<lat>lorem ipsum dolor 2</lat>
<lon>lorem ipsum dolor 3</lon>
<value>lorem ipsum dolor 1</value>
</DestinationGeo>
</destinationGeo>
<destinationRayon>13</destinationRayon>
<distance>lorem ipsum dolor 10</distance>
<keyword>lorem ipsum dolor 2</keyword>
<localisation xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</localisation>
<periode>3</periode>
<region xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</region>
<services xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</services>
<tarifmaxi>lorem ipsum dolor 9</tarifmaxi>
<tarifmini>lorem ipsum dolor 8</tarifmini>
<tri>lorem ipsum dolor 1</tri>
<type xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>lorem ipsum dolor 1</d3p1:string>
<d3p1:string>lorem ipsum dolor 2</d3p1:string>
</type>
<typehebergement>lorem ipsum dolor 12</typehebergement>
<types>lorem ipsum dolor 7</types>
</w_search>
<w_titlecolor>12</w_titlecolor>
<w_width>7</w_width>
</apiWidget>