SOAP WebServices API v3
The SOAP WebServices API v3 is used to interface a "client" information system to the e-Attestations platform using the SOAP protocol.
This WebServices API presents a set of methods to manage (import, track, archive, etc.) third-party compliance monitoring files for the client account and retrieve information. Most operations are synchronous.
Documentation Objectives
This documentation aims to:
- Document the SOAP v3 Web Services offered by e-Attestations.com
- Provide information about the security of available environments
- Clarify support mechanisms
- Describe each method, associated models and related errors
- Provide code examples to facilitate development
Standards
WebServices are based on SOAP 1.1 standards:
| Standard | Source |
|---|---|
| SOAP 1.1 | http://www.w3.org/TR/2000/NOTE-SOAP-20000508/ |
| WSDL 1.1 | http://www.w3.org/TR/2001/NOTE-wsdl-20010315 |
| WS-I Basic Profile 1.1 | http://www.ws-i.org/Profiles/BasicProfile-1.1.html |
L'implémentation inclut WS-Security pour l'identification de l'appelant.
Namespaces
| Prefix | Namespace |
|---|---|
S11 | http://schemas.xmlsoap.org/soap/envelope/ |
wsse | http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd |
wsu | http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd |
srv | http://srv.v3.ws.ea.com/ |
Setup
Subscription requires contacting your account manager at e-Attestations.com. A prior discussion about compliance document configuration is recommended.
Your account manager will inform the technical team for organization creation, and technical contacts will receive Tech'Desk invitations.
e-Attestations Tech'Desk Support
This ticketing system provides technical support dedicated to APIs and WebServices. Submit your requests by email:
The secure platform allows sharing support tickets within your organization.
Postman Collection
A Postman collection is provided for quick integration and API exploration. Required variables: wsuser, wspassword, wsurl, plus a test SIRET and folder name.
Usage with newman
npx newman run "EA_WebServices_v3.postman_collection.json" \
--global-var wsuser="<user>" \
--global-var wspassword="<password>"Download Postman via getpostman.com or newman via GitHub.
Environments
Test
https://ws.test-e-attestations.com/v3.0/EAttestationsWS?wsdlShared infrastructure identical to production. Email sending is disabled to avoid test interference.
Production
https://ws.e-attestations.com/v3.0/EAttestationsWS?wsdlFor use with your live account.
Security
Credentials (username/password) are transmitted for request authentication. IP whitelist filtering ensures legitimate access from the client system.
SSL/TLS encryption supports TLS 1.1 and TLS 1.2. Only TLS 1.2 is considered secure by e-Attestations.
Flow Security - IP Trust
Communicate the IP addresses of servers consuming WebServices during subscription. Each IP must be added to the trust list.
Format: CIDR notation (example: 34.56.78.90/32)
HTTP 403 Error
Indicates that the calling server's IP is not in the trust list. Verify IP declaration with e-Attestations via Tech'Desk.
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<html>
<head>
<title>403 Forbidden</title>
</head>
<body>
<h1>Forbidden</h1>
<p>You don't have permission to access [...] on this server.</p>
</body>
</html>Authentication
Each WebServices call requires valid username/password credentials provided at account opening. Insert them in the SOAP header as UsernameToken.
Password type can be PasswordDigest (recommended — more secure, using a hash of password, date and random number) or PasswordText.
<S11:Envelope xmlns:S11="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<S11:Header>
<wsse:Security>
<wsse:UsernameToken>
<wsse:Username>myUsername</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">
weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==
</wsse:Password>
<wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">
WScqanjCEAC4mQoBE07sAQ==
</wsse:Nonce>
<wsu:Created>2003-07-16T01:24:32Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</S11:Header>
<S11:Body>
<!-- Contenu de la requête -->
</S11:Body>
</S11:Envelope>Erreur d'authentification
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Authentication failure</faultstring>
<detail/>
</soap:Fault>
</soap:Body>
</soap:Envelope>Checks on Failure
- Credentials present in SOAP header
- Password type correctly specified
- Credentials matching the called platform
Reference: OASIS WS Security Documentation
Available Methods
The SOAP v3 API offers 11 methods to manage your third-parties and dossiers:
| Method | Description | Type |
|---|---|---|
importDossier | Import a monitoring dossier | Asynchronous |
getImportDossierResult | Result of an asynchronous import | Synchronous |
getSupplierIdentifierList | List of supplier identifiers | Synchronous |
getDossier | Dossier information | Synchronous |
getSupplierAccountInformation | Supplier account information | Synchronous |
getGlobalInformation | Global account statistics | Synchronous |
getAvailableDocuments | Available documents | Synchronous |
updateDossier | Update a dossier | Synchronous |
stopDossier | Stop dossier monitoring | Synchronous |
updateRequiredDocuments | Update required documents | Synchronous |
reactivateDossier | Reactivate a dossier | Synchronous |
Standard Response Format
All methods return a Result object:
| Attribute | Type | Description |
|---|---|---|
complete | Boolean | True when processing is finished |
success | Boolean | True on success, False otherwise |
listErrors | List<Error> | List of errors on failure |
Error Structure
| Attribute | Type | Description |
|---|---|---|
code | String | Error code |
additional | String | Additional context |
Active le suivi de conformité pour un dossier fournisseur. Le traitement est asynchrone, retournant un processId pour suivre le résultat via getImportDossierResult. La création de codes de dossier en doublon est interdite.
Flux de traitement asynchrone
→ retourne processId
avec processId
success=true
success=false
Paramètres - DossierImport
| Attribut | Type | Requis | Description |
|---|---|---|---|
supplierImport | SupplierImport | Oui | Informations d'identification du fournisseur |
dossierReference | String | Oui | Référence unique du dossier par fournisseur |
expirationDate | Date | Non | Date d'expiration du dossier |
description | String | Non | Description du dossier |
purchasingCategory | String | Non | Catégorie d'achat |
requiredDocuments | String[] | Non | Codes des documents requis (défaut si vide) |
supplierEmail | String | Non | Email(s) de contact du fournisseur |
userInCharge | String | Non | Email(s) du gestionnaire interne |
Paramètres - SupplierImport
| Attribut | Type | Requis | Description |
|---|---|---|---|
companyIDType | String | Oui | Type d'identifiant (CIT001, CIT002, CIT003) |
companyIDValue | String | Oui | Valeur de l'identifiant |
supplierCode | String | Non | Code fournisseur interne |
Requête
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header />
<soapenv:Body>
<srv:importDossier>
<dossierImport>
<supplierImport>
<companyIDType>CIT001</companyIDType>
<companyIDValue>50382936800037</companyIDValue>
<supplierCode>SC_001</supplierCode>
</supplierImport>
<dossierReference>REF_001</dossierReference>
<expirationDate>2015-12-31</expirationDate>
<description>This is my description</description>
<purchasingCategory>Category n°1</purchasingCategory>
<requiredDocuments>ATT_VIGI</requiredDocuments>
<requiredDocuments>JUSTIF_IMM</requiredDocuments>
<requiredDocuments>ASSUR_RCPRO</requiredDocuments>
<supplierEmail>test@e-attestations.com</supplierEmail>
<userInCharge>test@mydomain.com</userInCharge>
</dossierImport>
</srv:importDossier>
</soapenv:Body>
</soapenv:Envelope>Réponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:importDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
ff8081814f6e43ab014f6e4571630004
</return>
</ns1:importDossierResponse>
</soap:Body>
</soap:Envelope>Récupère le statut d'un import en attente en utilisant le processId retourné par importDossier.
Paramètres
| Attribut | Type | Requis | Description |
|---|---|---|---|
processId | String | Oui | Identifiant de la requête d'import |
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:getImportDossierResult>
<processId>ff8081814f6e43ab014f6e4571630004</processId>
</srv:getImportDossierResult>
</soapenv:Body>
</soapenv:Envelope>Réponse - En cours
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getImportDossierResultResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<complete>false</complete>
<success>false</success>
</return>
</ns1:getImportDossierResultResponse>
</soap:Body>
</soap:Envelope>Réponse - Succès
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getImportDossierResultResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<complete>true</complete>
<success>true</success>
</return>
</ns1:getImportDossierResultResponse>
</soap:Body>
</soap:Envelope>Réponse - Échec
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getImportDossierResultResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<complete>true</complete>
<listErrors>
<additional>REF_001</additional>
<code>E202</code>
</listErrors>
<success>false</success>
</return>
</ns1:getImportDossierResultResponse>
</soap:Body>
</soap:Envelope>Retourne tous les identifiants du référentiel fournisseur avec filtrage optionnel.
Paramètres - supplierIdentifierSearch
| Attribut | Type | Requis | Description |
|---|---|---|---|
monitoredSupplier | Boolean | Non | Filtrer fournisseurs suivis (true) ou non suivis (false) |
stateLastChangeDate | Date | Non | Filtrer par date de changement d'état |
supplierGlobalState | Boolean | Non | Filtrer par état de complétude |
subscriptionState | Boolean | Non | Filtrer par état d'inscription |
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:getSupplierIdentifierList>
<supplierIdentifierSearch>
<monitoredSupplier>true</monitoredSupplier>
</supplierIdentifierSearch>
</srv:getSupplierIdentifierList>
</soapenv:Body>
</soapenv:Envelope>Réponse - Succès
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getSupplierIdentifierListResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<supplierIdentifier>
<companyIDType>CIT001</companyIDType>
<companyIDValue>50382936800037</companyIDValue>
<supplierCode>SC_001</supplierCode>
</supplierIdentifier>
</return>
</ns1:getSupplierIdentifierListResponse>
</soap:Body>
</soap:Envelope>Récupère les informations de dossier pour un ou plusieurs fournisseurs avec options de filtrage flexibles.
Paramètres - DossierSearch
| Attribut | Type | Requis | Description |
|---|---|---|---|
supplierSearch | SupplierSearch | Oui | Identification du fournisseur |
dossierReference | String | Non | Filtre par référence de dossier |
monitoredDossier | Boolean | Non | Filtrer dossiers actifs (true) ou inactifs (false) |
stateLastChangeDate | Date | Non | Filtrer par date de changement d'état |
Paramètres - SupplierSearch
| Attribut | Type | Requis | Description |
|---|---|---|---|
companyIDType | String | Non* | Type d'identifiant |
companyIDValue | String | Non* | Valeur de l'identifiant |
supplierCode | String | Non* | Code fournisseur interne |
*Utilisez soit companyIDType+companyIDValue OU supplierCode
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:getDossier>
<dossierSearch>
<supplierSearch>
<companyIDType>CIT001</companyIDType>
<companyIDValue>48088206700014</companyIDValue>
</supplierSearch>
<dossierReference>REF001</dossierReference>
</dossierSearch>
</srv:getDossier>
</soapenv:Body>
</soapenv:Envelope>Réponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<result>
<complete>true</complete>
<success>true</success>
</result>
<supplier>
<companyCountryCode>FRA</companyCountryCode>
<companyIDType>CIT001</companyIDType>
<companyIDValue>48088206700014</companyIDValue>
<listDossiers>
<description>Ma description</description>
<dossierGlobalState>false</dossierGlobalState>
<dossierGlobalStateLastChangeDate>2016-02-11T11:57:40.094+01:00</dossierGlobalStateLastChangeDate>
<dossierId>57512</dossierId>
<dossierReference>REF001</dossierReference>
<listDocuments>
<askingDate>2016-02-11T11:57:40.270+01:00</askingDate>
<documentCode>JUSTIF_IMM</documentCode>
<listFileInformation>
<downloadLink>https://ws-test.e-attestations.com/webservices/download/[...]</downloadLink>
<expirationDate>2018-08-02T23:59:59.999+02:00</expirationDate>
<uploadDate>2018-02-02T01:30:17.634+01:00</uploadDate>
</listFileInformation>
<name>Justificatif d'immatriculation</name>
<present>true</present>
</listDocuments>
<listDocuments>
<askingDate>2016-02-11T11:57:40.515+01:00</askingDate>
<documentCode>ATT_VIGI</documentCode>
<name>Attestation de vigilance (6 mois)</name>
<present>false</present>
</listDocuments>
<listIndicators>
<indicatorCode>I001</indicatorCode>
<lastChangeDate>2016-02-11T11:57:40.094+01:00</lastChangeDate>
<state>false</state>
</listIndicators>
<monitoredDossier>true</monitoredDossier>
<purchasingCategory/>
<startingDate>2016-02-11T11:57:40.092+01:00</startingDate>
</listDossiers>
<monitoredSupplier>true</monitoredSupplier>
<supplierCode>A-GRAPH</supplierCode>
<supplierGlobalState>false</supplierGlobalState>
<supplierGlobalStateLastChangeDate>2016-02-11T11:57:40.257+01:00</supplierGlobalStateLastChangeDate>
</supplier>
</return>
</ns1:getDossierResponse>
</soap:Body>
</soap:Envelope>Structure de la réponse - Supplier
| Attribut | Type | Description |
|---|---|---|
companyIDType | String | Type d'identifiant |
companyIDValue | String | Valeur de l'identifiant |
companyCountryCode | String | Code pays ISO 3166-1 alpha-3 |
supplierCode | String | Code fournisseur interne |
monitoredSupplier | Boolean | Suivi si au moins un dossier actif |
supplierGlobalState | Boolean | Tous documents présents sur tous dossiers |
supplierGlobalStateLastChangeDate | Date | Dernier changement de complétude |
listDossiers | List<Dossier> | Dossiers correspondant aux filtres |
Structure de la réponse - Dossier
| Attribut | Type | Description |
|---|---|---|
dossierReference | String | Référence unique par fournisseur |
dossierId | String | ID système immutable |
startingDate | Date | Date de création/début de suivi |
expirationDate | Date | Date d'expiration (null si aucune) |
stoppingDate | Date | Date de désactivation (si inactif) |
stoppingReason | String | OUTOFBUSINESS, EXPIRATION, STOPREQUEST, UNKNOWN |
description | String | Description du dossier |
purchasingCategory | String | Catégorie d'achat |
monitoredDossier | Boolean | Dossier actif |
dossierGlobalState | Boolean | Tous documents demandés présents |
dossierGlobalStateLastChangeDate | Date | Dernier changement de complétude |
listIndicators | List<Indicator> | Indicateurs du dossier |
listDocuments | List<Document> | Documents demandés |
Structure - Document
| Attribut | Type | Description |
|---|---|---|
documentCode | String | Identifiant unique du document |
name | String | Nom du document |
askingDate | Date | Date de demande |
present | Boolean | Document valide et présent |
listFileInformation | List<FileInformation> | Détails des fichiers soumis |
Structure - FileInformation
| Attribut | Type | Description |
|---|---|---|
downloadLink | String | URL de téléchargement (restriction IP) |
uploadDate | Date | Date de soumission |
expirationDate | Date | Date d'expiration du document |
uploadUser | UserInformation | Utilisateur ayant soumis |
Retourne les informations d'identité du compte fournisseur et les utilisateurs enregistrés sur la plateforme.
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:getSupplierAccountInformation>
<supplierSearch>
<!--<companyIDType></companyIDType>-->
<!--<companyIDValue></companyIDValue>-->
<supplierCode>SC_001</supplierCode>
</supplierSearch>
</srv:getSupplierAccountInformation>
</soapenv:Body>
</soapenv:Envelope>Réponse - Succès
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getSupplierAccountInformationResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<result>
<complete>true</complete>
<success>true</success>
</result>
<supplierAccountInformation>
<addressCity>PARIS 14</addressCity>
<addressCountryCode>FRA</addressCountryCode>
<addressPostCode>75014</addressPostCode>
<addressStreet>VLA DE LOURCINE</addressStreet>
<companyCountryCode>FRA</companyCountryCode>
<companyIDType>CIT001</companyIDType>
<companyIDValue>50382936800037</companyIDValue>
<monitoredSupplier>false</monitoredSupplier>
<name>E-ATTESTATIONS.COM</name>
<outOfBusiness>false</outOfBusiness>
<subscriptionDate>2010-11-24T10:38:32.224+01:00</subscriptionDate>
<subscriptionState>true</subscriptionState>
<subscriptionKey>SXBQNTXKK6VM</subscriptionKey>
<supplierCode>SC_001</supplierCode>
<supplierUsers>
<email>contact@e-attestations.com</email>
<firstName>Jean</firstName>
<internationalPhone>+33 1 58 06 00 23</internationalPhone>
<lastName>Dupont</lastName>
</supplierUsers>
</supplierAccountInformation>
</return>
</ns1:getSupplierAccountInformationResponse>
</soap:Body>
</soap:Envelope>Structure - SupplierAccountInformation
| Attribut | Type | Description |
|---|---|---|
name | String | Dénomination sociale |
addressStreet | String | Adresse |
addressCity | String | Ville |
addressPostCode | String | Code postal |
addressCountryCode | String | Code pays |
supplierUsers | List<UserInformation> | Utilisateurs enregistrés |
subscriptionState | Boolean | Compte enregistré (true) ou non (false) |
subscriptionDate | Date | Date d'inscription |
subscriptionKey | String | Clé d'inscription pour l'enrôlement |
outOfBusiness | Boolean | Établissement fermé |
Retourne les statistiques au niveau du compte couvrant les fournisseurs actuellement suivis. Aucun paramètre requis.
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:getGlobalInformation/>
</soapenv:Body>
</soapenv:Envelope>Réponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getGlobalInformationResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<listIndicatorsStatistics>
<indicatorCode>I001</indicatorCode>
<numberOfCompleteDossier>244</numberOfCompleteDossier>
<numberOfCompleteSupplier>153</numberOfCompleteSupplier>
<numberOfDossier>447</numberOfDossier>
<numberOfSupplier>316</numberOfSupplier>
<numberOfSubscribedSupplier>252</numberOfSubscribedSupplier>
</listIndicatorsStatistics>
<numberOfCompleteDossier>222</numberOfCompleteDossier>
<numberOfCompleteSupplier>139</numberOfCompleteSupplier>
<numberOfDossier>448</numberOfDossier>
<numberOfSupplier>317</numberOfSupplier>
<numberOfSubscribedSupplier>252</numberOfSubscribedSupplier>
</return>
</ns1:getGlobalInformationResponse>
</soap:Body>
</soap:Envelope>Retourne les types de documents configurés pour le compte : documents autorisés (disponibles à la demande) et documents par défaut (demandés par défaut si aucun n'est spécifié).
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:getAvailableDocuments/>
</soapenv:Body>
</soapenv:Envelope>Réponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getAvailableDocumentsResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<availableDocuments>
<documentCode>ASSUR_RCPRO</documentCode>
<name>Attestation d'assurance RC Pro</name>
</availableDocuments>
<availableDocuments>
<documentCode>ASSUR_DECENNALE</documentCode>
<name>Attestation d'assurance décennale</name>
</availableDocuments>
<availableDocuments>
<documentCode>JUSTIF_IMM</documentCode>
<name>Justificatif d'immatriculation</name>
</availableDocuments>
<availableDocuments>
<documentCode>LST_SAL_ETR</documentCode>
<name>Déclaration des salariés</name>
</availableDocuments>
<availableDocuments>
<documentCode>ATT_MARCHE_PUBLIC</documentCode>
<name>Attestation de marché public</name>
</availableDocuments>
<availableDocuments>
<documentCode>ATT_VIGI</documentCode>
<name>Attestation de vigilance (6 mois)</name>
</availableDocuments>
<defaultDocuments>
<documentCode>JUSTIF_IMM</documentCode>
<name>Justificatif d'immatriculation</name>
</defaultDocuments>
<defaultDocuments>
<documentCode>LST_SAL_ETR</documentCode>
<name>Déclaration des salariés</name>
</defaultDocuments>
<defaultDocuments>
<documentCode>ATT_VIGI</documentCode>
<name>Attestation de vigilance (6 mois)</name>
</defaultDocuments>
</return>
</ns1:getAvailableDocumentsResponse>
</soap:Body>
</soap:Envelope>Modifie les informations d'un dossier actif : référence, description, expiration, catégorie, code fournisseur et invitations par email.
Paramètres - DataToUpdate (au moins 1 requis)
| Attribut | Type | Description |
|---|---|---|
newDescription | String | Nouvelle description |
newDossierReference | String | Nouvelle référence (non vide, espaces supprimés, majuscules) |
newExpirationDate | Date | Nouvelle date d'expiration |
nilExpirationDate | Boolean | Supprimer la date d'expiration si true |
newPurchasingCategory | String | Nouvelle catégorie d'achat |
newSupplierCode | String | Nouveau code fournisseur |
newSupplierEmail | String | Inviter un nouveau contact fournisseur (envoi email) |
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:updateDossier>
<dossierUpdate>
<dataToUpdate>
<newDescription>This is my updated description</newDescription>
<newDossierReference>NEW_REF_001</newDossierReference>
<newExpirationDate>2016-12-31</newExpirationDate>
</dataToUpdate>
<dossierReference>REF_001</dossierReference>
<supplierSearch>
<supplierCode>SC_001</supplierCode>
</supplierSearch>
</dossierUpdate>
</srv:updateDossier>
</soapenv:Body>
</soapenv:Envelope>Réponse - Succès
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:updateDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<complete>true</complete>
<success>true</success>
</return>
</ns1:updateDossierResponse>
</soap:Body>
</soap:Envelope>Désactive un ou tous les dossiers d'un fournisseur.
Paramètres - DossierStop
| Attribut | Type | Requis | Description |
|---|---|---|---|
supplierSearch | SupplierSearch | Oui | Identification du fournisseur |
dossierReference | String | Non | Dossier spécifique (tous si omis) |
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:stopDossier>
<dossierStop>
<dossierReference>NEW_REF_001</dossierReference>
<supplierSearch>
<companyIDType>CIT001</companyIDType>
<companyIDValue>50382936800037</companyIDValue>
</supplierSearch>
</dossierStop>
</srv:stopDossier>
</soapenv:Body>
</soapenv:Envelope>Réponse - Succès
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:stopDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<complete>true</complete>
<success>true</success>
</return>
</ns1:stopDossierResponse>
</soap:Body>
</soap:Envelope>Remplace la liste des documents demandés pour un dossier actif. Les documents doivent être préalablement configurés.
Paramètres - RequiredDocumentsUpdate
| Attribut | Type | Requis | Description |
|---|---|---|---|
supplierSearch | SupplierSearch | Oui | Identification du fournisseur |
dossierReference | String | Oui | Référence du dossier |
newRequiredDocuments | List<String> | Non | Nouveaux codes documents (remplace les précédents) |
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:updateRequiredDocuments>
<requiredDocumentsUpdate>
<dossierReference>NEW_REF_001</dossierReference>
<!-- Documents actuellement demandés-->
<newRequiredDocuments>ATT_VIGI</newRequiredDocuments>
<newRequiredDocuments>JUSTIF_IMM</newRequiredDocuments>
<newRequiredDocuments>ASSUR_RCPRO</newRequiredDocuments>
<!-- Nouveaux documents à demander -->
<newRequiredDocuments>ATT_MARCHE_PUBLIC</newRequiredDocuments>
<newRequiredDocuments>LST_SAL_ETR</newRequiredDocuments>
<supplierSearch>
<companyIDType>CIT001</companyIDType>
<companyIDValue>50382936800037</companyIDValue>
</supplierSearch>
</requiredDocumentsUpdate>
</srv:updateRequiredDocuments>
</soapenv:Body>
</soapenv:Envelope>Réponse - Succès
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:updateRequiredDocumentsResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<complete>true</complete>
<success>true</success>
</return>
</ns1:updateRequiredDocumentsResponse>
</soap:Body>
</soap:Envelope>Réactive un dossier désactivé avec modification optionnelle de la date d'expiration.
Paramètres - DossierReactivate
| Attribut | Type | Requis | Description |
|---|---|---|---|
supplierSearch | SupplierSearch | Oui | Identification du fournisseur |
dossierReference | String | Non | Référence du dossier à réactiver |
expirationDate | Date | Non | Nouvelle expiration (conserve précédente si omis) |
nilExpirationDate | Boolean | Non | Supprimer expiration si true (priorité sur expirationDate) |
Requête
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:srv="http://srv.v3.ws.ea.com/">
<soapenv:Header/>
<soapenv:Body>
<srv:reActivateDossier>
<dossierReActivate>
<dossierReference>SUP008183</dossierReference>
<supplierSearch>
<companyIDType>CIT001</companyIDType>
<companyIDValue>50879531700017</companyIDValue>
</supplierSearch>
</dossierReActivate>
</srv:reActivateDossier>
</soapenv:Body>
</soapenv:Envelope>Réponse - Succès
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:reActivateDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
<return xmlns:ns2="http://srv.v3.ws.ea.com/">
<complete>true</complete>
<success>true</success>
</return>
</ns1:reActivateDossierResponse>
</soap:Body>
</soap:Envelope>Nomenclature
Company Identifier Types (companyIDType)
| Code | Description | Format |
|---|---|---|
CIT001 | SIRET (French establishment identifier) | 14 digits passing the Luhn algorithm |
CIT002 | VAT Number (EU company identifier) | According to VAT identification standard |
CIT003 | DUNS (Dun & Bradstreet) | International commercial identifier |
Indicator Codes
| Code | Name | Description |
|---|---|---|
I001 | Hidden Labor | Document completeness according to account configuration |
Error Codes
HTTP Codes
| Code | Meaning |
|---|---|
400 | Bad Request (protocole SOAP invalide) |
401 | Unauthorized (clé API invalide) |
403 | Forbidden (identifiants incorrects ou IP non trustée) |
418 | I'm a teapot |
500 | Internal Server Error |
503 | Service Unavailable |
Common Errors
| Code | Description | Additional Info |
|---|---|---|
E001 | Paramètre manquant | Nom du paramètre |
E002 | Paramètre inconnu | Nom/valeur du paramètre |
E003 | Paramètre vide | Nom du paramètre |
E010 | Format incorrect | Nom/valeur du paramètre |
E011 | Taille maximale dépassée | Nom du paramètre / taille max |
E021 | Date dans le passé (newExpirationDate) | Nom du paramètre |
E022 | Date dans le futur | Nom du paramètre |
E030 | Domaine email invalide | Valeur du paramètre |
Supplier/Entity Errors
| Code | Description | Additional Info |
|---|---|---|
E100 | Aucun fournisseur ne correspond aux critères | — |
E101 | Erreur de qualification établissement | — |
E102 | Établissement inexistant | Identifiant (companyIDType/companyIDValue) |
E103 | Établissement fermé | Identifiant |
E104 | Plusieurs fournisseurs correspondent | Identifiant |
E111 | SupplierCode différent de l'existant | Code existant |
E112 | SupplierCode déjà utilisé ailleurs | Autre identifiant fournisseur |
E113 | Compte fournisseur désactivé | — |
E121 | Impossible d'importer fournisseur FR avec TVA | Identifiant |
E122 | Fournisseurs étrangers désactivés | — |
Dossier Errors
| Code | Description | Additional Info |
|---|---|---|
E200 | Aucun dossier ne correspond aux critères | — |
E201 | Dossier désactivé | Référence du dossier |
E202 | Référence déjà existante pour ce fournisseur | Référence du dossier |
E203 | Aucun dossier avec cette référence | Référence du dossier |
E204 | Dossier déjà actif | Référence du dossier |
E205 | Date de réactivation dans le passé | Date d'expiration |
Document Errors
| Code | Description | Additional Info |
|---|---|---|
E301 | Document désactivé (non demandable) | Code du document |
E302 | Document non autorisé (pas dans la bibliothèque) | Code du document |
Support & Resources
Best Practices
- Compose supplier searches via:
(companyIDType + companyIDValue)ORsupplierCode - Handle asynchronous
importDossierviaprocessIdwith polling - Analyze
ResultandErrorin each response - Use
PasswordDigestfor authentication (more secure) - Implement a proxy/cache for file downloads (IP whitelist required)
- Use TLS 1.2 only
- Configure URLs and credentials in configuration