GET api/vit/structures
Permet de récupérer les structures associés à l'utilisateur Extranet.
Description de la Requête
Paramètres de l'URI
| Nom | Description | Type | Informations complémentaires |
|---|---|---|---|
| regionId |
L'identifiant de région |
string |
Required |
Paramètres du corps de la requête (BODY)
Aucun.
Description de la réponse
Description de la ressource retournée
La liste des structures
Collection of StructureVit| Nom | Description | Type | Informations complémentaires |
|---|---|---|---|
| zoneId |
L'identifiant de la zone |
integer |
Aucune. |
| logo |
L'url du logo |
string |
Aucune. |
| id |
L'identifiant de la structure |
globally unique identifier |
Aucune. |
| nom |
Le nom de la structure |
string |
Aucune. |
| nomCommercial |
Le nom commercial de la structure |
string |
Aucune. |
| parent |
L'identifiant de la structure parente |
globally unique identifier |
Aucune. |
| adresse1 |
Adresse 1 |
string |
Aucune. |
| adresse1Suite |
Adresse 1 suite |
string |
Aucune. |
| adresse2 |
Adresse 2 |
string |
Aucune. |
| adresse3 |
Adresse 3 |
string |
Aucune. |
| codePostal |
Code postal |
string |
Aucune. |
| commune |
Commune |
string |
Aucune. |
|
|
string |
Aucune. |
|
| url |
URL |
string |
Aucune. |
| telephone |
Téléphone |
string |
Aucune. |
Formats de réponse
application/json, text/json
Sample:
[
{
"zoneId": 1,
"logo": "lorem ipsum dolor 2",
"id": "9d64b88c-fa87-41e1-8ce5-7e6bd0d71e2d",
"nom": "lorem ipsum dolor 4",
"nomCommercial": "lorem ipsum dolor 5",
"parent": "e40b60da-4c6c-4554-b062-76e2d6ef1522",
"adresse1": "lorem ipsum dolor 6",
"adresse1Suite": "lorem ipsum dolor 7",
"adresse2": "lorem ipsum dolor 8",
"adresse3": "lorem ipsum dolor 9",
"codePostal": "lorem ipsum dolor 10",
"commune": "lorem ipsum dolor 11",
"email": "lorem ipsum dolor 12",
"url": "lorem ipsum dolor 13",
"telephone": "lorem ipsum dolor 14"
},
{
"zoneId": 1,
"logo": "lorem ipsum dolor 2",
"id": "9d64b88c-fa87-41e1-8ce5-7e6bd0d71e2d",
"nom": "lorem ipsum dolor 4",
"nomCommercial": "lorem ipsum dolor 5",
"parent": "e40b60da-4c6c-4554-b062-76e2d6ef1522",
"adresse1": "lorem ipsum dolor 6",
"adresse1Suite": "lorem ipsum dolor 7",
"adresse2": "lorem ipsum dolor 8",
"adresse3": "lorem ipsum dolor 9",
"codePostal": "lorem ipsum dolor 10",
"commune": "lorem ipsum dolor 11",
"email": "lorem ipsum dolor 12",
"url": "lorem ipsum dolor 13",
"telephone": "lorem ipsum dolor 14"
}
]
application/xml, text/xml
Sample:
<ArrayOfStructureVit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Vit">
<StructureVit>
<adresse1 xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 6</adresse1>
<adresse1Suite xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 7</adresse1Suite>
<adresse2 xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 8</adresse2>
<adresse3 xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 9</adresse3>
<codePostal xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 10</codePostal>
<commune xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 11</commune>
<email xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 12</email>
<id xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">9d64b88c-fa87-41e1-8ce5-7e6bd0d71e2d</id>
<nom xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 4</nom>
<nomCommercial xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 5</nomCommercial>
<parent xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">e40b60da-4c6c-4554-b062-76e2d6ef1522</parent>
<telephone xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 14</telephone>
<url xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 13</url>
<logo>lorem ipsum dolor 2</logo>
<zoneId>1</zoneId>
</StructureVit>
<StructureVit>
<adresse1 xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 6</adresse1>
<adresse1Suite xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 7</adresse1Suite>
<adresse2 xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 8</adresse2>
<adresse3 xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 9</adresse3>
<codePostal xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 10</codePostal>
<commune xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 11</commune>
<email xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 12</email>
<id xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">9d64b88c-fa87-41e1-8ce5-7e6bd0d71e2d</id>
<nom xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 4</nom>
<nomCommercial xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 5</nomCommercial>
<parent xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">e40b60da-4c6c-4554-b062-76e2d6ef1522</parent>
<telephone xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 14</telephone>
<url xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Structure">lorem ipsum dolor 13</url>
<logo>lorem ipsum dolor 2</logo>
<zoneId>1</zoneId>
</StructureVit>
</ArrayOfStructureVit>
text/csv
Sample:
ZoneId;Logo;Id;Nom;NomCommercial;Parent;Adresse1;Adresse1Suite;Adresse2;Adresse3;CodePostal;Commune;Email;Url;Telephone 1;lorem ipsum dolor 2;9d64b88c-fa87-41e1-8ce5-7e6bd0d71e2d;lorem ipsum dolor 4;lorem ipsum dolor 5;e40b60da-4c6c-4554-b062-76e2d6ef1522;lorem ipsum dolor 6;lorem ipsum dolor 7;lorem ipsum dolor 8;lorem ipsum dolor 9;lorem ipsum dolor 10;lorem ipsum dolor 11;lorem ipsum dolor 12;lorem ipsum dolor 13;lorem ipsum dolor 14 1;lorem ipsum dolor 2;9d64b88c-fa87-41e1-8ce5-7e6bd0d71e2d;lorem ipsum dolor 4;lorem ipsum dolor 5;e40b60da-4c6c-4554-b062-76e2d6ef1522;lorem ipsum dolor 6;lorem ipsum dolor 7;lorem ipsum dolor 8;lorem ipsum dolor 9;lorem ipsum dolor 10;lorem ipsum dolor 11;lorem ipsum dolor 12;lorem ipsum dolor 13;lorem ipsum dolor 14