GET api/vit/offres

Permet de récupérer les offres VIT. Si l'utilisateur vient de l'Extranet, le paramètre login est ignoré

Description de la Requête

Paramètres de l'URI

NomDescriptionTypeInformations complémentaires
login

Login VIT

string

Default value is

regionId

Identifiant de la région

string

Default value is

Paramètres du corps de la requête (BODY)

Aucun.

Description de la réponse

Description de la ressource retournée

La liste des offres VIT

Collection of OffreVit
NomDescriptionTypeInformations complémentaires
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:
[
  {
    "id": "lorem ipsum dolor 1",
    "defaut": "lorem ipsum dolor 2",
    "metaOiId": "lorem ipsum dolor 3",
    "metaOiNom": "lorem ipsum dolor 4",
    "clientId": "214e616c-3e18-4104-b143-f45fc5499e88",
    "clientNom": "lorem ipsum dolor 5",
    "structureId": "1e8e8639-d73c-405a-b73b-ccbd0f3401d4",
    "structureRacineId": "33750c06-59ce-4051-b972-1d3e106d15a7",
    "profilId": "73f7430e-b799-44df-a51a-25c7aaf48d1d",
    "profilTradId": "db74abc9-a2f5-45b4-baef-502d022109ab",
    "cguValidated": true,
    "principales": [
      {
        "valeur": true,
        "structureId": "773d51af-3f43-4374-9d08-d661140f2743"
      },
      {
        "valeur": true,
        "structureId": "773d51af-3f43-4374-9d08-d661140f2743"
      }
    ],
    "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"
        }
      ]
    }
  },
  {
    "id": "lorem ipsum dolor 1",
    "defaut": "lorem ipsum dolor 2",
    "metaOiId": "lorem ipsum dolor 3",
    "metaOiNom": "lorem ipsum dolor 4",
    "clientId": "214e616c-3e18-4104-b143-f45fc5499e88",
    "clientNom": "lorem ipsum dolor 5",
    "structureId": "1e8e8639-d73c-405a-b73b-ccbd0f3401d4",
    "structureRacineId": "33750c06-59ce-4051-b972-1d3e106d15a7",
    "profilId": "73f7430e-b799-44df-a51a-25c7aaf48d1d",
    "profilTradId": "db74abc9-a2f5-45b4-baef-502d022109ab",
    "cguValidated": true,
    "principales": [
      {
        "valeur": true,
        "structureId": "773d51af-3f43-4374-9d08-d661140f2743"
      },
      {
        "valeur": true,
        "structureId": "773d51af-3f43-4374-9d08-d661140f2743"
      }
    ],
    "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:
<ArrayOfOffreVit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels.v3.Vit">
  <OffreVit>
    <cguValidated>true</cguValidated>
    <clientId>214e616c-3e18-4104-b143-f45fc5499e88</clientId>
    <clientNom>lorem ipsum dolor 5</clientNom>
    <defaut>lorem ipsum dolor 2</defaut>
    <id>lorem ipsum dolor 1</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 3</metaOiId>
    <metaOiNom>lorem ipsum dolor 4</metaOiNom>
    <principales>
      <OffrePrincpaleVit>
        <StructureId>773d51af-3f43-4374-9d08-d661140f2743</StructureId>
        <Valeur>true</Valeur>
      </OffrePrincpaleVit>
      <OffrePrincpaleVit>
        <StructureId>773d51af-3f43-4374-9d08-d661140f2743</StructureId>
        <Valeur>true</Valeur>
      </OffrePrincpaleVit>
    </principales>
    <profilId>73f7430e-b799-44df-a51a-25c7aaf48d1d</profilId>
    <profilTradId>db74abc9-a2f5-45b4-baef-502d022109ab</profilTradId>
    <structureId>1e8e8639-d73c-405a-b73b-ccbd0f3401d4</structureId>
    <structureRacineId>33750c06-59ce-4051-b972-1d3e106d15a7</structureRacineId>
  </OffreVit>
  <OffreVit>
    <cguValidated>true</cguValidated>
    <clientId>214e616c-3e18-4104-b143-f45fc5499e88</clientId>
    <clientNom>lorem ipsum dolor 5</clientNom>
    <defaut>lorem ipsum dolor 2</defaut>
    <id>lorem ipsum dolor 1</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 3</metaOiId>
    <metaOiNom>lorem ipsum dolor 4</metaOiNom>
    <principales>
      <OffrePrincpaleVit>
        <StructureId>773d51af-3f43-4374-9d08-d661140f2743</StructureId>
        <Valeur>true</Valeur>
      </OffrePrincpaleVit>
      <OffrePrincpaleVit>
        <StructureId>773d51af-3f43-4374-9d08-d661140f2743</StructureId>
        <Valeur>true</Valeur>
      </OffrePrincpaleVit>
    </principales>
    <profilId>73f7430e-b799-44df-a51a-25c7aaf48d1d</profilId>
    <profilTradId>db74abc9-a2f5-45b4-baef-502d022109ab</profilTradId>
    <structureId>1e8e8639-d73c-405a-b73b-ccbd0f3401d4</structureId>
    <structureRacineId>33750c06-59ce-4051-b972-1d3e106d15a7</structureRacineId>
  </OffreVit>
</ArrayOfOffreVit>

text/csv

Sample:
Id;Defaut;MetaOiId;MetaOiNom;ClientId;ClientNom;StructureId;StructureRacineId;ProfilId;ProfilTradId;CguDate;CguValidated;Principales;Infos
lorem ipsum dolor 1;lorem ipsum dolor 2;lorem ipsum dolor 3;lorem ipsum dolor 4;214e616c-3e18-4104-b143-f45fc5499e88;lorem ipsum dolor 5;1e8e8639-d73c-405a-b73b-ccbd0f3401d4;33750c06-59ce-4051-b972-1d3e106d15a7;73f7430e-b799-44df-a51a-25c7aaf48d1d;db74abc9-a2f5-45b4-baef-502d022109ab;30/04/2025 10:24:29;True;System.Collections.Generic.List`1[ApiModels.v3.Vit.OffrePrincpaleVit];ApiModels.v3.Vit.OffreInfosVit
lorem ipsum dolor 1;lorem ipsum dolor 2;lorem ipsum dolor 3;lorem ipsum dolor 4;214e616c-3e18-4104-b143-f45fc5499e88;lorem ipsum dolor 5;1e8e8639-d73c-405a-b73b-ccbd0f3401d4;33750c06-59ce-4051-b972-1d3e106d15a7;73f7430e-b799-44df-a51a-25c7aaf48d1d;db74abc9-a2f5-45b4-baef-502d022109ab;30/04/2025 10:24:29;True;System.Collections.Generic.List`1[ApiModels.v3.Vit.OffrePrincpaleVit];ApiModels.v3.Vit.OffreInfosVit