Le service createSession

Plateformes E.T.A.I

 

Adapté à toutes les plateformes E-T-A-I,
le service createSession demande la création d’une session.

 

 

 

[Voir ici la description fonctionnelle de ce service]

Par exemple, envoi du message suivant en méthode POST :

 

<xat2 xmlns="http://xat2.etai.fr" version="2.0">
  <session-context>
    <!-- Déclaration obligatoire du quadruplet d'identifiants XAT2 -->
    <application-id>{identifiant unique de l’application Partenaire}</application-id>
    <dms-login>{identifiant de l’application Partenaire dans le garage}</dms-login>
    <user-shared-id>{identifiant de l’utilisateur}</user-shared-id>
    <garage-shared-id>{identifiant du garage}</garage-shared-id>
  </session-context>
  <shuttle>
    <transport>
      <action-list>
        <!-- Déclaration obligatoire du verbe -->
        <action>
          <verb>createSession</verb>
            <option-list>
              <!-- Option pour obtenir systématiquement la connexion -->
              <option>force</option>
            </option-list>
        </action>
      </action-list>
    </transport>
  </shuttle>
</xat2>

Cliquer ici, pour plus d’infos sur les éléments :
<session-context>
<action-list>

 

La réponse en retour (sans initialisation d’un autre message POST) pourrait être la suivante :

 

<xat2 xmlns="http://xat2.etai.fr" version="2.0">
  <date-list>
    <!-- Dates d'arrivée du message et de son traitement -->
    <explicit-date source="xat2">
      <breakdown-list>
        <classification dictionary="ETAI:date" ref="receive" source="xat2">Receive date</classification>
      </breakdown-list>
      <date format="dd.MM.yyyy HH:mm:ss:S Z">18.01.2017 08:53:10:869 +0100</date>
    </explicit-date>
    <explicit-date source="xat2">
      <breakdown-list>
        <classification dictionary="ETAI:date" ref="dispatch" source="xat2">Completion date</classification>
      </breakdown-list>
      <date format="dd.MM.yyyy HH:mm:ss:S Z">18.01.2017 08:53:11:159 +0100</date>
    </explicit-date>
  </date-list>
  <message-list>
    <!-- Statut de la requête. Ici, accusé de réception "ack" indiquant le bon déroulement du service -->
    <message source="xat2">
      <message-category>ack</message-category>
      <user-description dictionary="Xat2:message" ref="complete">session creation OK</user-description>
      <technical-description>session creation OK</technical-description>
    </message>
    <message source="xat2">
      <message-category>ack</message-category>
      <user-description dictionary="Xat2:message" ref="complete">createSession processing complete</user-description>
      <technical-description>createSession processing complete</technical-description>
      <classification-list>
        <classification dictionary="Xat2:message" ref="complete" />
      </classification-list>
    </message>
  </message-list>
  <session-context>
    <!-- Rappel facultatif des identifiants de connexion -->
    <dms-login>{identifiant de l’application Partenaire dans le garage}</dms-login>
    <user-shared-id>{identifiant de l’utilisateur}</user-shared-id>
    <garage-shared-id>{identifiant du garage}</garage-shared-id>
    <!-- Déclaration obligatoire de l'identifiant unique de la session -->
    <session-id>{identifiant unique de la session,jusqu'à 64 caractères alphanumériques}</session-id>
    <!-- Date du dernier accès -->
    <last-accessed-time format="dd.MM.yyyy HH:mm:ss:S Z">18.01.2017 08:53:10:968 +0100</last-accessed-time>
    <!-- Déclaration de la durée maximale d'une session, en milli-secondes -->
    <max-session-duration>1800</max-session-duration>
  </session-context> 
  <shuttle />
</xat2>

Cliquer ici, pour plus d’infos sur les éléments :
<date-list>
<message-list>
<session-context>

Retour à la liste de toutes les cartes d’identités techniques des services