SWS_EtatDeclarations
- 03 Feb 2023
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
SWS_EtatDeclarations
- Mis à jour le 03 Feb 2023
- 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_EtatDeclarations
Description
Permet de récupérer des informations sur les déclarations d'un dossier, notamment leur état
Groupe de fonctions API
Code API : I40 / EDI002
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 |
| TypeDeclaration | string | Type de déclaration recherchée. Peut valoir : "DECLARATION", "DADSU", "DUE, "DN-AC-AE" ou "DSIJ" |
| Periode | dateTime | Période de paie pour laquelle rechercher une déclaration. Obligatoire uniquement pour les recherches sur le type "DECLARATION" |
Paramètres de la réponse
| Paramètre | Type | Description |
|---|---|---|
| SWS_EtatDeclarationsResult | SWS_EtatDeclarationsResult | Élément structuré contenant la réponse à la requête (Détail ci-dessous) |
SWS_EtatDeclarationsResult
| Paramètre | Type | Description |
|---|---|---|
| Error | string | Vide s'il n'y a pas d'erreur, sinon contient la description de l'erreur rencontrée |
| EtatDeclarations | CPAISWSEtatDeclaration[] | Liste d'éléments structurés contenant les informations des déclarations trouvées (cf. détail ci-dessous) |
CPAISWSEtatDeclaration
| Paramètre | Type | Description |
|---|---|---|
| NumeroADS | string | Numéro ADS de la déclaration |
| Date | dateTime | Date de la déclaration |
| TypeDeclaration | string | Type de déclaration |
| NomInterneEtablissement | string | Nom interne de l'établissement auquel est rattachée la déclaration |
| Destinataire | string | Destinataire de la déclaration |
| Obsolete | boolean | Permet d'indiquer si la déclaration est obsolète (true) ou pas (false) |
| Test | boolean | Permet d'indiquer s'il s'agit d'une déclaration test (true) ou pas (false) |
| Retour | CPAISWSEtatDeclarationRetour[] | Liste d'éléments structurés contenant les informations des retours reçus suite aux déclarations (cf. détail ci-dessous) |
CPAISWSEtatDeclarationRetour
| Paramètre | Type | Description |
|---|---|---|
| Date | dateTime | Date du retour |
| Nature | string | Nature du retour (pas exemple "ADS", "ARS" ou "ACS" |
| Etat | string | Statut du retour (accepté, accepté avec anomalie, ...) |
Requête
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SWS_EtatDeclarations xmlns="http://www.silae.fr/">
<Token>string</Token>
<NumeroDossier>string</NumeroDossier>
<TypeDeclaration>string</TypeDeclaration>
<Periode>yyyy-mm-ddThh:mm:ss</Periode>
</SWS_EtatDeclarations>
</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_EtatDeclarationsResponse xmlns="http://www.silae.fr/">
<SWS_EtatDeclarationsResult>
<Error>string</Error>
<EtatDeclarations>
<CPAISWSEtatDeclaration>
<NumeroADS>string</NumeroADS>
<Date>yyyy-mm-ddThh:mm:ss</Date>
<TypeDeclaration>string</TypeDeclaration>
<NomInterneEtablissement>string</NomInterneEtablissement>
<Destinataire>string</Destinataire>
<Obsolete>boolean</Obsolete>
<Test>boolean</Test>
<Retour>
<CPAISWSEtatDeclarationRetour>
<Date>yyyy-mm-ddThh:mm:ss</Date>
<Nature>string</Nature>
<Etat>string</Etat>
</CPAISWSEtatDeclarationRetour>
<CPAISWSEtatDeclarationRetour>
<Date>yyyy-mm-ddThh:mm:ss</Date>
<Nature>string</Nature>
<Etat>string</Etat>
</CPAISWSEtatDeclarationRetour>
</Retour>
</CPAISWSEtatDeclaration>
<CPAISWSEtatDeclaration>
<NumeroADS>string</NumeroADS>
<Date>yyyy-mm-ddThh:mm:ss</Date>
<TypeDeclaration>string</TypeDeclaration>
<NomInterneEtablissement>string</NomInterneEtablissement>
<Destinataire>string</Destinataire>
<Obsolete>boolean</Obsolete>
<Test>boolean</Test>
<Retour>
<CPAISWSEtatDeclarationRetour>
<Date>yyyy-mm-ddThh:mm:ss</Date>
<Nature>string</Nature>
<Etat>string</Etat>
</CPAISWSEtatDeclarationRetour>
<CPAISWSEtatDeclarationRetour>
<Date>yyyy-mm-ddThh:mm:ss</Date>
<Nature>string</Nature>
<Etat>string</Etat>
</CPAISWSEtatDeclarationRetour>
</Retour>
</CPAISWSEtatDeclaration>
</EtatDeclarations>
</SWS_EtatDeclarationsResult>
</SWS_EtatDeclarationsResponse>
</soap12:Body>
</soap12:Envelope>
Cet article vous a-t-il été utile ?