SWS_ValideCleDossier
- 02 Jan 2024
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
SWS_ValideCleDossier
- Mis à jour le 02 Jan 2024
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
Fonction API
SWS_ValideCleDossier
Description
Permet de déverrouiller l'accès à un dossier protégé par un mot de passe, pour la durée de la session.
Si la session reste inactive plus de 5 minutes, il sera nécessaire de lancer à nouveau cette fonction.Tenir compte également du temps de validité du token.
Groupe de fonctions API
Code API : A10 / BAS001
Paramètres de la requête
| Paramètre | Type | Description |
|---|---|---|
| Token | string | Token d'authentification renvoyé en réponse à l'authentification via SWS_SiteLogin |
| NumeroDossier | string | Numéro du dossier concerné par la requête |
| Cle | string | Le mot de passe du dossier |
Paramètres de la réponse
| Paramètre | Type | Description |
|---|---|---|
| SWS_ValideCleDossierResult | SWS_ValideCleDossierResult | Élément structuré contenant la réponse à la requête (Détail ci-dessous) |
SWS_ValideCleDossierResult
| Paramètre | Type | Description |
|---|---|---|
| Error | string | Vide s'il n'y a pas d'erreur, sinon contient la description de l'erreur rencontrée |
Requête
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SWS_ValideCleDossier xmlns="http://www.silae.fr/">
<Token>string</Token>
<NumeroDossier>string</NumeroDossier>
<Cle>string</Cle>
</SWS_ValideCleDossier>
</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_ValideCleDossierResponse xmlns="http://www.silae.fr/">
<SWS_ValideCleDossierResult>
<Error>string</Error>
</SWS_ValideCleDossierResult>
</SWS_ValideCleDossierResponse>
</soap12:Body>
</soap12:Envelope>
Messages d'erreur
| Message | Description |
|---|---|
| unknown | "Clé d'accès incorrecte" |
| unknown | "La clé comporte plus de 10 caractères" |
| unknown | "Clé non décrite" |
Cet article vous a-t-il été utile ?