Classe qui représente le service Web. C’est avec cette classe que les différentes actions seront effectuées.
Constructeur
Nom du paramètre
|
Type
|
Description
|
binding
|
System.ServiceModel.Channels.Binding
|
Permet de définir la connexion au service Web, ainsi que la sécurité à utiliser.
|
remoteAddress
|
System.ServiceModel.EndpointAddress
|
Permet d’identifier l’adresse distante du service Web. Sur les environnements SaaS de SIGMA–RH : https://www.sigma-rh.net/<client>/webservices/dataimport.svc en remplaçant <client> par votre identifiant.
|
Méthodes
Les méthodes suivantes peuvent être utilisées :
•createBatch •addSection •addRecord •commit •getStatus createBatch(byte[] authenticationLogin, dictionnary importParameters, bool autoCommit)
Cette méthode permet de créer un lot d’import. Cet lot sera ensuite rempli avant d’être exécuté.
Détails
|
Type
|
Description
|
Paramètre : authenticationLogin
|
Byte[]
|
Tableau d’octets représentant le jeton d’authentification.
|
importParameters
|
Dictionnary
|
Liste des paramètres d’import. Dans le dictionnaire, les clés sont les noms de paramètres et les valeurs la valeur du paramètre. Tout en string.
|
autoCommit
|
Bool
|
True si on veut que l’import démarre tout seul en cas de timeout (délai d’attente dépassé depuis la dernière action sur un lot d’import.)
|
Valeur retournée par la méthode
|
string
|
ID du lot d’import créé. Cet ID sert à interroger le statut du lot ou encore alimenter son contenu.
|
addSection(byte[] authenticationLogin, string batchId, string sectionName, dictionary sectionParameters)
Cette méthode permet d’ajouter une section au lot d’import.
Détails
|
Type
|
Description
|
Paramètre : authenticationLogin
|
Byte[]
|
Tableau d’octets représentant le jeton d’authentification.
|
batchId
|
String
|
ID du lot.
|
sectionName
|
String
|
Nom de la section d’import.
|
sectionParameters
|
Dictionnary
|
Liste de paramètre de la section d’import. Dans le dictionnaire, les clés sont les noms de paramètres et les valeurs la valeur du paramètre. Tout en string
|
Valeur retournée par la méthode
|
Void
|
Aucune valeur retournée.
|
addRecord(byte[] authenticationLogin, string batchId, string sectionName, dictionary values)
Cette méthode permet d’ajouter des items à importer dans une section. Il est important que tous les items de la même section aient les mêmes champs définis.
Détails
|
Type
|
Description
|
Paramètre : authenticationLogin
|
Byte[]
|
Tableau d’octets représentant le jeton d’authentification.
|
batchId
|
String
|
ID du lot.
|
sectionName
|
String
|
Nom de la section d’import
|
Values
|
Dictionnary
|
Liste des valeurs à importer pour un item. Dans le dictionnaire, les clés sont les noms de champs et les valeurs la valeur du champ. Tout en string.
|
Valeur retournée par la méthode
|
String
|
ID de l’élément ajouté. Sert à retracer dans le journal d’erreur.
|
commit(byte[] authenticationLogin, string batchId)
Cette méthode permet de démarrer l’import d’un lot.
Détails
|
Type
|
Description
|
Paramètre : authenticationLogin
|
Byte[]
|
Tableau d’octets représentant le jeton d’authentification.
|
batchId
|
String
|
ID du lot.
|
Valeur retournée par la méthode
|
Void
|
Aucune valeur retournée.
|
getStatus(byte[] authenticationLogin, string batchId)
Cette méthode permet de récupérer le statut d’un lot d’import.
Détails
|
Type
|
Description
|
Paramètre : authenticationLogin
|
Byte[]
|
Tableau d’octets représentant le jeton d’authentification.
|
batchId
|
String
|
ID du lot.
|
Valeur retournée par la méthode
|
BatchStatus
|
Objet de statut du lot.
|
|
