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

SWS_EditionHistorique

  • Sombre
    Lumière
  • PDF

Résumé de l’article

Fonction API

SWS_EditionHistorique

Description

Permet de générer et récupérer une édition historique configurée dans le dossier

Note : Seules les éditions avec l'export activé pourront être appelées par cette fonction (export.actif = true) :
SWS_EditionHistorique_exportactif

Plus d'informations sur les éditions historiques dans l'aide en ligne : Editions historiques : Guide des fiches à consulter

Groupe de fonctions API

Code API : J20 / EDT002

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

CodeEditionHistoriquestringNom de l'édition historique à générer
MotDePassestringMot qui pourrait éventuellement protéger l'accès à l'édition historique
PeriodeDebutdateTimeDate de début de la période pour laquelle génrérer l'édition historique
PeriodeFindateTimeDate de début de la période pour laquelle génrérer l'édition historique

Paramètres de la réponse

ParamètreTypeDescription
SWS_EditionHistoriqueResultSWS_EditionHistoriqueResult

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

SWS_EditionHistoriqueResult

ParamètreTypeDescription
Errorstring

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

Documentbase64BinaryFichier de l'édition historique encodé en base64

Requête

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SWS_EditionHistorique xmlns="http://www.silae.fr/">
      <Token>string</Token>
      <NumeroDossier>string</NumeroDossier>
      <CodeEditionHistorique>string</CodeEditionHistorique>
      <MotDePasse>string</MotDePasse>
      <PeriodeDebut>yyyy-mm-ddThh:mm:ss</PeriodeDebut>
      <PeriodeFin>yyyy-mm-ddThh:mm:ss</PeriodeFin>
    </SWS_EditionHistorique>
  </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_EditionHistoriqueResponse xmlns="http://www.silae.fr/">
      <SWS_EditionHistoriqueResult>
        <Error>string</Error>
        <Document>base64Binary</Document>
      </SWS_EditionHistoriqueResult>
    </SWS_EditionHistoriqueResponse>
  </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.