GET api/vit/offres/search
Permet de rechercher sur les offres avec un critère sur le nom et la commune
Description de la Requête
Paramètres de l'URI
| Nom | Description | Type | Informations complémentaires |
|---|---|---|---|
| RegionId |
Identifiant de la région |
string |
Aucune. |
| MetaOiId |
Identifiant du bordereau |
string |
Aucune. |
| Nom |
Nom de l'offre |
string |
Aucune. |
| Commune |
Commune de l'offre |
string |
Aucune. |
Paramètres du corps de la requête (BODY)
Aucun.
Description de la réponse
Description de la ressource retournée
Collection of OffreCommuneVit| Nom | Description | Type | Informations complémentaires |
|---|---|---|---|
| commune | string |
Aucune. |
|
| hasConnexionVit | boolean |
Aucune. |
|
| id |
L'identifiant de l'offre |
string |
Aucune. |
| defaut |
Le nom de l'offre |
string |
Aucune. |
| metaOiId |
L'identifiant du bordereau de l'offre |
string |
Aucune. |
| metaOiNom |
Le nom du bordereau de l'offre |
string |
Aucune. |
| clientId |
Identifiant du client |
globally unique identifier |
Aucune. |
| clientNom |
Nom du client |
string |
Aucune. |
| structureId |
L'identifiant de la structure propriétaire de l'offre |
globally unique identifier |
Aucune. |
| structureRacineId |
L'identifiant de la structure racine de l'offre |
globally unique identifier |
Aucune. |
| profilId |
L'identifiant du profil de consultation de l'offre |
globally unique identifier |
Aucune. |
| profilTradId |
L'identifiant du profil de consultation de l'offre |
globally unique identifier |
Aucune. |
| cguValidated |
Indique si les CGU sont validées |
boolean |
Aucune. |
| principales |
Liste des offres principales sur chaque structure |
Collection of OffrePrincpaleVit |
Aucune. |
| infos |
Les informations de l'offre |
OffreInfosVit |
Aucune. |
Formats de réponse
application/json, text/json
Sample:
[
{
"commune": "lorem ipsum dolor 1",
"hasConnexionVit": true,
"id": "lorem ipsum dolor 3",
"defaut": "lorem ipsum dolor 4",
"metaOiId": "lorem ipsum dolor 5",
"metaOiNom": "lorem ipsum dolor 6",
"clientId": "ecaa01b9-f48d-4e7f-b02a-789ae02ec51e",
"clientNom": "lorem ipsum dolor 7",
"structureId": "72e84d46-2ed5-4163-a723-8dfc542bb0b3",
"structureRacineId": "2a674a36-515b-4dc1-8bae-1547dddc22ac",
"profilId": "f7beaaf9-d8e2-4648-a57a-912cce2d82c8",
"profilTradId": "1d8f325a-4f8a-4675-9166-55856e145cd1",
"cguValidated": true,
"principales": [
{
"valeur": true,
"structureId": "3a9edd71-9c56-426c-a754-b36875a6f257"
},
{
"valeur": true,
"structureId": "3a9edd71-9c56-426c-a754-b36875a6f257"
}
],
"infos": {
"adresse1": "lorem ipsum dolor 1",
"adresse2": "lorem ipsum dolor 2",
"adresse3": "lorem ipsum dolor 3",
"codePostal": "lorem ipsum dolor 4",
"commune": "lorem ipsum dolor 5",
"photos": [
{
"url": "lorem ipsum dolor 1",
"titre": "lorem ipsum dolor 2",
"credit": "lorem ipsum dolor 3",
"width": 4,
"height": 5
},
{
"url": "lorem ipsum dolor 1",
"titre": "lorem ipsum dolor 2",
"credit": "lorem ipsum dolor 3",
"width": 4,
"height": 5
}
],
"categories": [
{
"picto": "lorem ipsum dolor 1",
"libelle": "lorem ipsum dolor 2"
},
{
"picto": "lorem ipsum dolor 1",
"libelle": "lorem ipsum dolor 2"
}
]
}
},
{
"commune": "lorem ipsum dolor 1",
"hasConnexionVit": true,
"id": "lorem ipsum dolor 3",
"defaut": "lorem ipsum dolor 4",
"metaOiId": "lorem ipsum dolor 5",
"metaOiNom": "lorem ipsum dolor 6",
"clientId": "ecaa01b9-f48d-4e7f-b02a-789ae02ec51e",
"clientNom": "lorem ipsum dolor 7",
"structureId": "72e84d46-2ed5-4163-a723-8dfc542bb0b3",
"structureRacineId": "2a674a36-515b-4dc1-8bae-1547dddc22ac",
"profilId": "f7beaaf9-d8e2-4648-a57a-912cce2d82c8",
"profilTradId": "1d8f325a-4f8a-4675-9166-55856e145cd1",
"cguValidated": true,
"principales": [
{
"valeur": true,
"structureId": "3a9edd71-9c56-426c-a754-b36875a6f257"
},
{
"valeur": true,
"structureId": "3a9edd71-9c56-426c-a754-b36875a6f257"
}
],
"infos": {
"adresse1": "lorem ipsum dolor 1",
"adresse2": "lorem ipsum dolor 2",
"adresse3": "lorem ipsum dolor 3",
"codePostal": "lorem ipsum dolor 4",
"commune": "lorem ipsum dolor 5",
"photos": [
{
"url": "lorem ipsum dolor 1",
"titre": "lorem ipsum dolor 2",
"credit": "lorem ipsum dolor 3",
"width": 4,
"height": 5
},
{
"url": "lorem ipsum dolor 1",
"titre": "lorem ipsum dolor 2",
"credit": "lorem ipsum dolor 3",
"width": 4,
"height": 5
}
],
"categories": [
{
"picto": "lorem ipsum dolor 1",
"libelle": "lorem ipsum dolor 2"
},
{
"picto": "lorem ipsum dolor 1",
"libelle": "lorem ipsum dolor 2"
}
]
}
}
]
application/xml, text/xml
Sample:
<ArrayOfOffreCommuneVit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Vit">
<OffreCommuneVit>
<cguValidated>true</cguValidated>
<clientId>ecaa01b9-f48d-4e7f-b02a-789ae02ec51e</clientId>
<clientNom>lorem ipsum dolor 7</clientNom>
<defaut>lorem ipsum dolor 4</defaut>
<id>lorem ipsum dolor 3</id>
<infos>
<Adresse1>lorem ipsum dolor 1</Adresse1>
<Adresse2>lorem ipsum dolor 2</Adresse2>
<Adresse3>lorem ipsum dolor 3</Adresse3>
<Categories>
<OffreCategorieVit>
<Libelle>lorem ipsum dolor 2</Libelle>
<Picto>lorem ipsum dolor 1</Picto>
</OffreCategorieVit>
<OffreCategorieVit>
<Libelle>lorem ipsum dolor 2</Libelle>
<Picto>lorem ipsum dolor 1</Picto>
</OffreCategorieVit>
</Categories>
<CodePostal>lorem ipsum dolor 4</CodePostal>
<Commune>lorem ipsum dolor 5</Commune>
<Photos>
<OffreFileInfoVit>
<Credit>lorem ipsum dolor 3</Credit>
<Height>5</Height>
<Titre>lorem ipsum dolor 2</Titre>
<Url>lorem ipsum dolor 1</Url>
<Width>4</Width>
</OffreFileInfoVit>
<OffreFileInfoVit>
<Credit>lorem ipsum dolor 3</Credit>
<Height>5</Height>
<Titre>lorem ipsum dolor 2</Titre>
<Url>lorem ipsum dolor 1</Url>
<Width>4</Width>
</OffreFileInfoVit>
</Photos>
</infos>
<metaOiId>lorem ipsum dolor 5</metaOiId>
<metaOiNom>lorem ipsum dolor 6</metaOiNom>
<principales>
<OffrePrincpaleVit>
<StructureId>3a9edd71-9c56-426c-a754-b36875a6f257</StructureId>
<Valeur>true</Valeur>
</OffrePrincpaleVit>
<OffrePrincpaleVit>
<StructureId>3a9edd71-9c56-426c-a754-b36875a6f257</StructureId>
<Valeur>true</Valeur>
</OffrePrincpaleVit>
</principales>
<profilId>f7beaaf9-d8e2-4648-a57a-912cce2d82c8</profilId>
<profilTradId>1d8f325a-4f8a-4675-9166-55856e145cd1</profilTradId>
<structureId>72e84d46-2ed5-4163-a723-8dfc542bb0b3</structureId>
<structureRacineId>2a674a36-515b-4dc1-8bae-1547dddc22ac</structureRacineId>
<commune>lorem ipsum dolor 1</commune>
<hasConnexionVit>true</hasConnexionVit>
</OffreCommuneVit>
<OffreCommuneVit>
<cguValidated>true</cguValidated>
<clientId>ecaa01b9-f48d-4e7f-b02a-789ae02ec51e</clientId>
<clientNom>lorem ipsum dolor 7</clientNom>
<defaut>lorem ipsum dolor 4</defaut>
<id>lorem ipsum dolor 3</id>
<infos>
<Adresse1>lorem ipsum dolor 1</Adresse1>
<Adresse2>lorem ipsum dolor 2</Adresse2>
<Adresse3>lorem ipsum dolor 3</Adresse3>
<Categories>
<OffreCategorieVit>
<Libelle>lorem ipsum dolor 2</Libelle>
<Picto>lorem ipsum dolor 1</Picto>
</OffreCategorieVit>
<OffreCategorieVit>
<Libelle>lorem ipsum dolor 2</Libelle>
<Picto>lorem ipsum dolor 1</Picto>
</OffreCategorieVit>
</Categories>
<CodePostal>lorem ipsum dolor 4</CodePostal>
<Commune>lorem ipsum dolor 5</Commune>
<Photos>
<OffreFileInfoVit>
<Credit>lorem ipsum dolor 3</Credit>
<Height>5</Height>
<Titre>lorem ipsum dolor 2</Titre>
<Url>lorem ipsum dolor 1</Url>
<Width>4</Width>
</OffreFileInfoVit>
<OffreFileInfoVit>
<Credit>lorem ipsum dolor 3</Credit>
<Height>5</Height>
<Titre>lorem ipsum dolor 2</Titre>
<Url>lorem ipsum dolor 1</Url>
<Width>4</Width>
</OffreFileInfoVit>
</Photos>
</infos>
<metaOiId>lorem ipsum dolor 5</metaOiId>
<metaOiNom>lorem ipsum dolor 6</metaOiNom>
<principales>
<OffrePrincpaleVit>
<StructureId>3a9edd71-9c56-426c-a754-b36875a6f257</StructureId>
<Valeur>true</Valeur>
</OffrePrincpaleVit>
<OffrePrincpaleVit>
<StructureId>3a9edd71-9c56-426c-a754-b36875a6f257</StructureId>
<Valeur>true</Valeur>
</OffrePrincpaleVit>
</principales>
<profilId>f7beaaf9-d8e2-4648-a57a-912cce2d82c8</profilId>
<profilTradId>1d8f325a-4f8a-4675-9166-55856e145cd1</profilTradId>
<structureId>72e84d46-2ed5-4163-a723-8dfc542bb0b3</structureId>
<structureRacineId>2a674a36-515b-4dc1-8bae-1547dddc22ac</structureRacineId>
<commune>lorem ipsum dolor 1</commune>
<hasConnexionVit>true</hasConnexionVit>
</OffreCommuneVit>
</ArrayOfOffreCommuneVit>
text/csv
Sample:
Commune;HasConnexionVit;Id;Defaut;MetaOiId;MetaOiNom;ClientId;ClientNom;StructureId;StructureRacineId;ProfilId;ProfilTradId;CguDate;CguValidated;Principales;Infos lorem ipsum dolor 1;True;lorem ipsum dolor 3;lorem ipsum dolor 4;lorem ipsum dolor 5;lorem ipsum dolor 6;ecaa01b9-f48d-4e7f-b02a-789ae02ec51e;lorem ipsum dolor 7;72e84d46-2ed5-4163-a723-8dfc542bb0b3;2a674a36-515b-4dc1-8bae-1547dddc22ac;f7beaaf9-d8e2-4648-a57a-912cce2d82c8;1d8f325a-4f8a-4675-9166-55856e145cd1;30/04/2025 10:50:04;True;System.Collections.Generic.List`1[ApiModels.v3.Vit.OffrePrincpaleVit];ApiModels.v3.Vit.OffreInfosVit lorem ipsum dolor 1;True;lorem ipsum dolor 3;lorem ipsum dolor 4;lorem ipsum dolor 5;lorem ipsum dolor 6;ecaa01b9-f48d-4e7f-b02a-789ae02ec51e;lorem ipsum dolor 7;72e84d46-2ed5-4163-a723-8dfc542bb0b3;2a674a36-515b-4dc1-8bae-1547dddc22ac;f7beaaf9-d8e2-4648-a57a-912cce2d82c8;1d8f325a-4f8a-4675-9166-55856e145cd1;30/04/2025 10:50:04;True;System.Collections.Generic.List`1[ApiModels.v3.Vit.OffrePrincpaleVit];ApiModels.v3.Vit.OffreInfosVit