SWS_ExtraListeManifestations
  • 03 Feb 2023
  • 1 Minute à lire
  • Sombre
    Lumière
  • PDF

SWS_ExtraListeManifestations

  • Sombre
    Lumière
  • PDF

Résumé de l’article

Fonction API

SWS_ExtraListeManifestations

Description

Permet de lister les manifestations d'un dossier à partir d'une date donnée

Groupe de fonctions API

Code API : H10 / CTCD01

Paramètres de la requête

ParamètreTypeDescription
Tokenstring

Token d'authentification renvoyé en réponse à l'authentification via SWS_SiteLogin

NumeroDossierstring

Numéro du dossier concerné par la requête

CategoriestringPermet de déterminer sur quel module s'appuiera l'API pour la recherche de manifestations. Peut valoir "HCR" ou "CTCD"
DateDebutMindateTimeLes manifestations qui remonteront dans la réponse seront celles avec une date de début supérieure à la date renseignée dans ce paramètre

Paramètres de la réponse

ParamètreTypeDescription
SWS_ExtraListeManifestationsResultSWS_ExtraListeManifestationsResult

Élément structuré contenant la réponse à la requête (Détail ci-dessous)

SWS_ExtraListeManifestationsResult

ParamètreTypeDescription
Errorstring

Vide s'il n'y a pas d'erreur, sinon contient la description de l'erreur rencontrée

ManifestationsCPAISWSExtraManifestation[]Liste d'éléments structurés contenant les informations des manifestations trouvées (cf. détail ci-dessous)

CPAISWSExtraManifestation

ParamètreTypeDescription
NomInterneEtablissementstringNom interne de l'établissement auquel est rattachée la manifestation
AxeAnalytiquestringIl est possible de rattacher la manifestation à 2 axes analytiques. Ce paramètre définit le premier axe analytique
ValeurAxeAnalytiquestringIndique à quelle valeur de l'axe analytique 1 est rattachée la manifestation
AxeAnalytique2stringIl est possible de rattacher la manifestation à 2 axes analytiques. Ce paramètre définit le premier axe analytique
ValeurAxeAnalytique2stringIndique à quelle valeur de l'axe analytique 2 est rattachée la manifestation
ReferenceExterneManifestationstringIdentifiant externe de la manifestation trouvée
IntituleManifestationstringNom de la manifestation
DateDebutdateTimeDate de début de la manifestation
DateFindateTimeDate de fin de la manifestation

Requête

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SWS_ExtraListeManifestations xmlns="http://www.silae.fr/">
      <Token>string</Token>
      <NumeroDossier>string</NumeroDossier>
      <Categorie>string</Categorie>
      <DateDebutMin>yyyy-mm-ddThh:mm:ss</DateDebutMin>
    </SWS_ExtraListeManifestations>
  </soap12:Body>
</soap12:Envelope>

Réponse

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SWS_ExtraListeManifestationsResponse xmlns="http://www.silae.fr/">
      <SWS_ExtraListeManifestationsResult>
        <Error>string</Error>
        <Manifestations>
          <CPAISWSExtraManifestation>
            <NomInterneEtablissement>string</NomInterneEtablissement>
            <AxeAnalytique>string</AxeAnalytique>
            <ValeurAxeAnalytique>string</ValeurAxeAnalytique>
            <AxeAnalytique2>string</AxeAnalytique2>
            <ValeurAxeAnalytique2>string</ValeurAxeAnalytique2>
            <ReferenceExterneManifestation>string</ReferenceExterneManifestation>
            <IntituleManifestation>string</IntituleManifestation>
            <DateDebut>yyyy-mm-ddThh:mm:ss</DateDebut>
            <DateFin>yyyy-mm-ddThh:mm:ss</DateFin>
          </CPAISWSExtraManifestation>
          <CPAISWSExtraManifestation>
            <NomInterneEtablissement>string</NomInterneEtablissement>
            <AxeAnalytique>string</AxeAnalytique>
            <ValeurAxeAnalytique>string</ValeurAxeAnalytique>
            <AxeAnalytique2>string</AxeAnalytique2>
            <ValeurAxeAnalytique2>string</ValeurAxeAnalytique2>
            <ReferenceExterneManifestation>string</ReferenceExterneManifestation>
            <IntituleManifestation>string</IntituleManifestation>
            <DateDebut>yyyy-mm-ddThh:mm:ss</DateDebut>
            <DateFin>yyyy-mm-ddThh:mm:ss</DateFin>
          </CPAISWSExtraManifestation>
        </Manifestations>
      </SWS_ExtraListeManifestationsResult>
    </SWS_ExtraListeManifestationsResponse>
  </soap12:Body>
</soap12:Envelope>

Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.