You are here:
< Retour

Damaris Web Services

Introduction Web Services Damaris RM

Les Web Services de Damaris RM proposent une palette assez large de fonctions les plus couramment utilisées.

Ces Web Services sont déjà implémentés dans Damaris Printer, Damaris Mobile et Damaris Scan Manager.

Le principe général

Les Web Services de Damaris RM sont implémentés en utilisant le protocole RESTFull.

Il existe plusieurs classes et dans chaque classe vous avez la possibilité d’utiliser des méthodes http, https POST pour les appeler.

Au retour, les données vous sont renvoyées sous au format JSON.

Comment tester les Web Services Damaris RM ?

Nous vous proposons une plate-forme en ligne pour vous permettre de tester vos commandes Web Services.

Contactez votre interlocuteur Damaris pour vous créer un compte sur cette plate-forme.

La liste des fonctions

Cette première fonction vous permet de vous authentifier dans Damaris RM.

En cas de succès, un numéro unique de session vous est retourné. Cette information vous servira pour les autres fonctions Web Service.

Si l’utilisateur est lié à plusieurs services, la liste des services vous est retourné.

Voici un exemple d’appel de cette méthode :

http://localhost:8080/DamarisRM/dgs3g-ws/auth/login/username/password/departmentID

localhost:8080 : Adresse du serveur
DamarisRM : Nom de l’application
dgs3g-ws : Nom du Web Service REST
auth : Nom de la classe d’authentification
login : Nom de la méthode
username/password : Informations de connexion de l’utilisateur
departmentID : Nom du service, si l’utilisateur est lié à plusieurs services. Cette valeur peut être “null”.

Voici la liste des informations retournées par cette méthode :

“success” : “1”
“uniqueKey”: “abcdef_123456”
“userInfo”: “userID;firstName;lastName”
“userDepartments”: “user’s departments…”
“userRoles”: “permissions_of_the_user”

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/auth/login/LOGIN/MOT_DE_PASSE/CODE_SERVICE"

Au retour, voici un exemple de flux JSON :

Web Service auth login JSON

Par la suite, c’est la valeur uniqueKey qui va vous servir pour lancer les autres fonctions.

Attention : Vérifiez bien si l’utilisateur est connecté à plus d’un Service. Dans ce cas, pour la suite des opérations vous devez impérativement lancer une fonction chooseDepartment.

Dans le cas où un utilisateur soit lié à plusieurs services de la société, cette fonction vous permet de sélectionner le service approprié.

http://localhost:8080/DamarisRM/dgs3g-ws/auth/chooseDepartment/uniqueKey/departmentID

Où :

departmentID : Nom du service, si l’utilisateur est lié à plusieurs services. Attention : cette variable correspond à une des valeurs récupérées dans le JSON de login. departmentID est une valeur numérique (Exemple : 1019).

Informations retournées :

“success” : “1”
“uniqueKey”: “abcdef_123456”
“userInfo”: “userID;firstName;lastName”
“userDepartments”: “user’s departments…”
“userRoles”: “permissions_of_the_user”

Exemple avec cURL :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/auth/chooseDepartment/NXIBYYEZ08RPPFSZBKG2_20195885324355/1019"

Au retour, voici un exemple de flux JSON :

Web Service login chooseDepartment

Ferme une session préalablement ouverte par une action login.

Après cette opération, la clé unique ne pourra plus être utilisée.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/auth/logout/uniqueKey

Où :

uniqueKey : Jeton de la session ouverte précédemment

Voici la liste des informations retournées par cette méthode :

“success” : “1”

Cette fonction permet d’effectuer une réception d’une boite physique déclarée.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/receiveBox/uniqueKey/boxCode

Où :

uniqueKey : Jeton de la session ouverte précédemment
boxCode : Code de la boite à recevoir

Voici la liste des informations retournées par cette méthode :

“success” : “1”

Cette variable peut prendre les valeurs suivantes :

“-1” : Erreur lors de la réception de la boite

“-2” : Boite non-trouvée dans la base

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/receiveBox/7FFMNNNFNYOSK9UKHHWY_2019589751664/BT1100"

Au retour, voici un exemple de flux JSON :

{"success":"1"}

Cette fonction permet d’effectuer une réception d’un article physique déclaré.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/receiveFile/uniqueKey/fileCode

Où :

uniqueKey : Jeton de la session ouverte précédemment
fileCode : Code article à recevoir

Voici la liste des informations retournées par cette méthode :

“success” : “1”

Cette variable peut prendre les valeurs suivantes :

“-1” : Erreur lors de la réception de l’article

“-2” : Article non-trouvé dans la base

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/receiveFile/7FFMNNNFNYOSK9UKHHWY_2019589751664/AA8877"

Au retour, voici un exemple de flux JSON :

{"success":"1"}

Cette fonction permet de localiser une boite physique reçue.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/localizeBox/uniqueKey/boxCode/storageAddressBarcode

Où :

uniqueKey : Jeton de la session ouverte précédemment
boxCode : Code boite à localiser
storageAddressBarcode : Adresse de stockage complet composé du code site et de l’adresse dans le site

Voici la liste des informations retournées par cette méthode :

“success” : “1”

Cette variable peut prendre les valeurs suivantes :

“-1” : Erreur lors de la localisation de la boite

“-2” : Code Boite introuvable

“-3” : Adresse de stockage introuvable

“-4” : Pas assez de place à l’adresse de stockage

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H “Content-Type: application/json” “https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/localizeBox/K5WFQFCPE6GQ41430DSE_20195814558878/123456/SS01-A14”

Au retour, voici un exemple de flux JSON :

{"success":"1"}

Cette fonction permet de localiser un article physique reçu.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/localizeFile/uniqueKey/fileCode/storageAddressBarcode

Où :

uniqueKey : Jeton de la session ouverte précédemment
fileCode : Code Article à localiser
storageAddressBarcode : Adresse de stockage complet composé du code site et de l’adresse dans le site

Voici la liste des informations retournées par cette méthode :

“success” : “1”

Cette variable peut prendre les valeurs suivantes :

“-1” : Erreur lors de la localisation de la boite

“-2” : Code Article introuvable

“-3” : Adresse de stockage introuvable

“-4” : Pas assez de place à l’adresse de stockage

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/localizeFile/K5WFQFCPE6GQ41430DSE_20195814558878/AA8877/SS01-A14"

Au retour, voici un exemple de flux JSON :

{"success":"1"}

Cette fonction permet de localiser une boite physique déjà localisée.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/relocalizeBox/uniqueKey/boxCode/storageAddressBarcode

Où :

uniqueKey : Jeton de la session ouverte précédemment
boxCode : Code boite à localiser
storageAddressBarcode : Adresse de stockage complet composé du code site et de l’adresse dans le site

Voici la liste des informations retournées par cette méthode :

“success” : “1”

Cette variable peut prendre les valeurs suivantes :

“-1” : Erreur lors de la localisation de la boite

“-2” : Code Boite introuvable

“-3” : Adresse de stockage introuvable

“-4” : Pas assez de place à l’adresse de stockage

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/relocalizeBox/K5WFQFCPE6GQ41430DSE_20195814558878/123456/SS01-B11"

Au retour, voici un exemple de flux JSON :

{"success":"1"}

Cette fonction permet de localiser un article physique déjà localisé.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/relocalizeFile/uniqueKey/fileCode/storageAddressBarcode

Où :

uniqueKey : Jeton de la session ouverte précédemment
fileCode : Code Article à localiser
storageAddressBarcode : Adresse de stockage complet composé du code site et de l’adresse dans le site

Voici la liste des informations retournées par cette méthode :

“success” :

“1” : Opération effectuée avec succès
“-1” : Erreur lors de la localisation de la boite
“-2” : Code Article introuvable
“-3” : Adresse de stockage introuvable
“-4” : Pas assez de place à l’adresse de stockage

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/relocalizeFile/K5WFQFCPE6GQ41430DSE_20195814558878/AA8877/SS01-B12"

Au retour, voici un exemple de flux JSON :

{"success":"1"}

Retourne la liste de tous les type de boites existants dans la solution.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/getBoxTypes/uniqueKey

Où :

uniqueKey : Jeton de la session ouverte précédemment

Voici la liste des informations retournées par cette méthode :

“boxTypes” : “liste des types de boites”

“success” :

“1” : Liste renvoyée avec succès
“0” : Aucun type de boite disponible
“-1” : Erreur lors de la lecture des types de boites

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/getBoxTypes/K5WFQFCPE6GQ41430DSE_20195814558878"

Au retour, voici un exemple de flux JSON :

JSON getBoxTypes

Cette fonction vous permet de conditionner un article dans une boite.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/packageFile/uniqueKey/fileCode/destinationBoxCode/boxTypeID

Où :

uniqueKey : Jeton de la session ouverte précédemment
fileCode : Code Article à conditionner
destinationBoxCode : Code boite de destination dans laquelle l’article va être conditionné
boxTypeID : Type de boite destination

Voici la liste des informations retournées par cette méthode :

“success” :

“1” : Conditionnement effectué avec succès
“-1” : Erreur lors de l’opération de conditionnement
“-2” : Code article introuvable
“-3” : Code boite destination introuvable
“-4” : Type de boite destination inexistant
“-5” : Impossible de déplacer l’article dans la boite

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/packageFile/K5WFQFCPE6GQ41430DSE_20195814558878/AA8877/NEWBOX001/1004"

Au retour, voici un exemple de flux JSON :

{"success":"1"}

Cette fonction vous permet de conditionner une boite dans un autre contenant, de type conteneur par exemple.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/packageBox/uniqueKey/boxCode/destinationBoxCode/boxTypeID

Où :

uniqueKey : Jeton de la session ouverte précédemment
boxCode : Code Boite à conditionner
destinationBoxCode : Code boite de destination dans laquelle l’article va être conditionné
boxTypeID : Type de boite destination

Voici la liste des informations retournées par cette méthode :

“success” :

“1” : Conditionnement effectué avec succès
“-1” : Erreur lors de l’opération de conditionnement
“-2” : Code boite à conditionner introuvable
“-3” : Code boite destination introuvable
“-4” : Type de boite destination inexistant
“-5” : Impossible de déplacer la boite à conditionner dans la boite destination

Cette fonction archive un nouveau document numérique dans Damaris RM.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/archiveElectronicDocument/uniqueKey/docID/indexValues/fileBytes

Où :

uniqueKey : Jeton de la session ouverte précédemment
docID : Code typologie de document défini dans Damaris RM
indexValues : Objet JSON contenant les index et leur valeur. (e.g. {[“1” , “1000”] , [“2” , “test”]})
fileBytes : Chaîne de caractères binaire de l’objet à archiver codé en Base64

Voici la liste des informations retournées par cette méthode :

“success” :

“1” : Archivage effectué avec succès
“-1” : Erreur lors de l’archivage du document
“-2” : Code typologie de document inexistant
“-3” : L’utilisateur n’a pas les droits pour cette opération

Cette fonction vous permet d’archiver un nouveau document numérique dans la base Damaris RM. Elle vérifie la conformité des données saisies par rapport aux contrôles qualité paramétrés dans le système.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/archiveElectronicDocument_2/uniqueKey/docID/indexValues/forceArchive/fileBytes

Où :

uniqueKey : Jeton de la session ouverte précédemment
docID : Code typologie de document défini dans Damaris RM
indexValues : Objet JSON contenant les index et leur valeur. (e.g. {[“1” , “1000”] , [“2” , “test”]})
forceArchive : Si la valeur est “T” (true) le système force l’archivage du document, même si les contrôles qualité ne passent pas. Si la valeur est “F” (false) le système suit le retour des contrôles qualité et bloque ou non l’archivage
fileBytes : matrice binaire de l’objet à archiver codé en Base64

Voici la liste des informations retournées par cette méthode :

“boxCode” , “articleCode” et “imageID” : Triplet unique indiquant le code du document archivé.

“success” :

“1” : Archivage effectué avec succès
“-1” : Erreur lors de l’archivage du document
“-2” : Code typologie de document inexistant
“-3” : L’utilisateur n’a pas les droits pour cette opération
“-4” : Le contrôle qualité n’est pas passé. Dans ce cas, vous pouvez récupérer d’autres informations comme par exemple : “QCErrors” , “docLevelQCErrors”.

Renvoie la liste des typologies de documents dont l’utilisateur connecté a un droit d’accès en vue de téléchargement de nouveaux documents.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/getDocumentTypesForUpload/uniqueKey/archiveType

Où :

uniqueKey : Jeton de la session ouverte précédemment
archiveType : Type d’archives :
“1” : Archives numériques
“2” : Archives physiques
“3” : Archives mixtes, numériques et physiques (Archives communes)

Voici la liste des informations retournées par cette méthode :

“docTypes”: { [“1”,”docCode”,”docName”,”companyID”] , [“2”,”docCode”,”docName”,”companyID”] }.

“success” :

“1” : Liste des typologies effectuée avec succès
“0” : Aucune typologie de documents trouvée
“-1” : Erreur lors de la récupération de la liste des typologies de documents

Renvoie la liste des typologies de documents dont l’utilisateur connecté a un droit d’accès.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/getDocumentTypes/uniqueKey/archiveType

Où :

uniqueKey : Jeton de la session ouverte précédemment
archiveType : Type d’archives :
“1” : Archives numériques
“2” : Archives physiques
“3” : Archives mixtes, numériques et physiques (Archives communes)

Voici la liste des informations retournées par cette méthode :

“docTypes”: { [“1”,”docCode”,”docName”,”companyID”] , [“2”,”docCode”,”docName”,”companyID”] }.

“success” :

“1” : Liste des typologies effectuée avec succès
“0” : Aucune typologie de documents trouvée
“-1” : Erreur lors de la récupération de la liste des typologies de documents

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

Dans cet exemple, nous souhaitons récupérer la liste des types de documents pour les archives numériques.

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/getDocumentTypes/K5WFQFCPE6GQ41430DSE_20195814558878/1"

Au retour, voici un exemple de flux JSON :

JSON getDocumentTypes

Renvoie la liste des critères d’indexation pour chaque typologie de documents dont l’utilisateur connecté a un accès.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/getDocumentTypeIndexes/uniqueKey/docID

Où :

uniqueKey : Jeton de la session ouverte précédemment
docID : Code typologie de documents

Voici la liste des informations retournées par cette méthode :

“indexes”: { [“1”,”indexName”,”indexType”,”sequence”] , [“2”,” indexName”,” indexType”,” sequence”] }.

“success” :

“1” : Opération effectuée avec succès
“0” : Aucun critère d’indexation trouvé
“-1” : Erreur lors de la récupération de la liste des index
“-2” : Code typologie de documents introuvable
“-3” : L’utilisateur n’a pas les droits sur cette typologie de documents

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/getDocumentTypeIndexes/K5WFQFCPE6GQ41430DSE_20195814558878/1003"

 

Les valeurs de indexType

Ce champ peut prendre les valeurs suivantes :

  • 1 : Numérique
  • 2 : Alphanumérique
  • 3 : Monétaire
  • 4 : Date
  • 5 : Horodatage
  • 6 : Liste Fermée (Avec auto-complétion)
  • 7 : Liste Ouverte (Avec auto-complétion)
  • 9 : Email
  • 10 : Virtual Folder
  • 11 : Dictionnaire
  • 12 : Liste Fermée Simple (Sans auto-complétion)

Au retour, voici un exemple de flux JSON :

JSON archiving getDocumentTypeIndexes

Renvoie le contenu d’une  liste pour les index de type liste ouverte, liste fermée, liste fermée simple.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/getOpenListByPrefix/uniqueKey/documenTypeID/indexID/prefix

Où :

uniqueKey : Jeton de la session ouverte précédemment
docmentTypeID : Code typologie de documents

indexID : Code de l’index concerné (Doit être de type Liste)

prefix : Valeur contenue dans les lignes

Voici la liste des informations retournées par cette méthode :

“indexValues”: { [“Sequence” : “Valeur”, “Seq2” : “Valeur2, …] }.

“success” :

“1” : Données retournées avec succès
“-1” : Erreur lors de la récupération de la liste des données

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/getOpenListByPrefix/ASESLCA4HXQ7AWF8ILXM_201961833949485/1061/3776/A"

 

Au retour, voici un exemple de flux JSON :

Renvoie les entrées dans la liste pour les index de type Dictionnaire (indexType=11).

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/getDictionaryByPrefix/uniqueKey/documenTypeID/indexID/prefix

Où :

uniqueKey : Jeton de la session ouverte précédemment
docmentTypeID : Code typologie de documents

indexID : Code de l’index concerné (Doit être de type Dictionaire)

prefix : La valeur recherchée. Remonte toutes les lignes contenant cette valeur. Par exemple si vous recherchez la chaîne ABC, il remontera ABCDEF et XYZABC.

Voici la liste des informations retournées par cette méthode :

“indexValues”: { [“Sequence” : “Valeur”, “Seq2” : “Valeur2, …] }.

“success” :

“1” : Données retournées avec succès
“-1” : Erreur lors de la récupération de la liste des données

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/archiving/getDictionaryListByPrefix/ASESLCA4HXQ7AWF8ILXM_201961833949485/1061/3775/A"

 

Au retour, voici un exemple de flux JSON :

Retrouve un document numérique à partir des identifiants uniques. Les identifiants uniques peuvent être retrouvés grâce à la méthode search/searchArchives.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/archiving/getElectronicDocument/uniqueKey/imageID/boxCode/articleCode

Où :

uniqueKey : Jeton de la session ouverte précédemment
imageID : Identifiant du stockage
boxCode : Code boite du document
articleCode : Code article du document

Voici la liste des informations retournées par cette méthode :

Le document numérique au format Base64.

“success” :

“1” : Opération effectuée avec succès
“-1” : Erreur lors de la récupération de la liste des index

Retourne la liste des messages pour l’utilisateur connecté.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/messaging/getMessages/uniqueKey/allMessages

Où :

uniqueKey : Jeton de la session ouverte précédemment
allMessages : Valeur booléenne “true” : renvoie tous les messages de l’utilisateur ou “false” : uniquement les messages non-lus

Voici la liste des informations retournées par cette méthode :

“messages” : Les messages de l’utilisateur

“success” :

“1” : Messages reçus avec succès
“-1” : Erreur lors de la réception des messages
“0” : Pas de messages pour cet utilisateur

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H “Content-Type: application/json” “https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/messaging/getMessages/K5WFQFCPE6GQ41430DSE_20195814558878/false”

Au retour, voici un exemple de flux JSON :

JSON Messaging getMessages

Permet de lire un message en particulier à partir de l’identifiant du message préalablement retrouvé.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/messaging/readMessage/uniqueKey/messageID

Où :

uniqueKey : Jeton de la session ouverte précédemment
messageID : Identifiant unique du message à lire. Cet identifiant peut être obtenu par la méthode “allMessages”

Voici la liste des informations retournées par cette méthode :

“success” :

“1” : Messages reçus avec succès
“-1” : Erreur lors de la lecture du message

Supprime les messages pour l’utilisateur connecté.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/messaging/deleteMessages/uniqueKey/messageIDs

Où :

uniqueKey : Jeton de la session ouverte précédemment
messageIDs : Liste des ID des messages à supprimer. Cet identifiant peut être obtenu par la méthode “allMessages”

Voici la liste des informations retournées par cette méthode :

“success” :

“1” : Messages supprimés avec succès
“-1” : Erreur lors de la suppression des messages

Retrouve la liste des utilisateurs en vue de leur envoyer un message.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/messaging/getUsers/uniqueKey

Où :

uniqueKey : Jeton de la session ouverte précédemment

Voici la liste des informations retournées par cette méthode :

“users” : Liste des utilisateurs

“success” :

“1” : Liste récupérée avec succès
“0” : Aucun utilisateur trouvé sur le serveur
“-1” : Erreur lors de l’exécution de cette commande

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/messaging/getUsers/K5WFQFCPE6GQ41430DSE_20195814558878"

Au retour, voici un exemple de flux JSON :

JSON messaging getUsers

Retrouve la liste des utilisateurs en vue de leur envoyer un message.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/messaging/sendMessage/uniqueKey/toUsers/subject/body

Où :

uniqueKey : Jeton de la session ouverte précédemment
toUsers : Liste des identifiants utilisateurs destinataires. Le séparateur entre chaque code utilisateur est le tiret “-“. Vous pouvez utiliser la méthode messaging/getUsers pour retrouver les codes utilisateurs
subject : Le sujet du message
body : Le corps du message

Voici la liste des informations retournées par cette méthode :

“users” : Liste des utilisateurs

“success” :

“1” : Messages envoyés avec succès
“-1” : Erreur lors de l’exécution de cette commande

Lance une recherche simple de documents

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/search/searchArchives/uniqueKey/searchText/pageNumber/pageSize

Où :

uniqueKey : Jeton de la session ouverte précédemment
searchText : Chaîne de caractères contenant les critères de recherches (Recherche simple)
pageNumber : Numéro de page de résultat
pageSize : Nombre de lignes par page de résultat

Voici la liste des informations retournées par cette méthode :

“archives” : Liste JSON contenant les informations sur chaque enregistrement retrouvé

“success” :

“1” : Recherche effectuée avec succès
“0” : Recherche infructueuse renvoyant zéro enregistrements
“-1” : Erreur lors de l’exécution de cette commande

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/search/searchArchives/CHAINE_RECHERCHE/1/20"

Au retour, voici un exemple de flux JSON :

JSON résultat search / searArchives

Lance une recherche simple de documents et retourne le nombre de résultats trouvés

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/search/searchArchivesCount/uniqueKey/searchText

Où :

uniqueKey : Jeton de la session ouverte précédemment
searchText : Chaîne de caractères contenant les critères de recherches (Recherche simple)

Voici la liste des informations retournées par cette méthode :

“count” : Nombre d’enregistrements correspondants à la recherche effectuée

“success” :

“1” : Recherche effectuée avec succès
“-1” : Erreur lors de l’exécution de cette commande

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/search/searchArchivesCount/UKEPDHMUDQP0WLYUBRL1_201958112318862/test"

Au retour, voici un exemple de flux JSON :

{"success":"1","count":8}

Cette fonction concerne la Recherche avancée.

Retourne le nombre de lignes correspondantes aux critères.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/search/searchArchivesAdvancedCountGPS/{key}/{searchText}/{latitude}/{longitude}/{imei}/{docId}/{indexes}/{depId}/{compId}/{fileCode}/{boxCode}/{archivingDateFrom}/{archivingDateTo}/{finalizationDateFrom}/{finalizationDateTo}/{archiveTypeId}/{boxTypeId}/{parentBoxCode}/{addressFrom}/{addressTo}/{finalStateId}/{storageYears}/{storageTypeId}/{storageId}/{showFinalDocs}/{boxMode}/{comment}

Où :

{key} – unique key retrieved after login (String)
{searchText} – search text or empty string (String)
{latitude} – latitude of caller or empty string (String)
{longitude} – longitude of caller or empty string (String)
{imei} – IMEI of caller or empty string (String)
{docId} – document type ID (Number)
{indexes} – base 64 encoded string which contains search criteria based on indexes. The content of this parameter is JSON map, where key is index ID and value is searched value.
{compId} – company ID (Number)
{fileCode} – file code (String)
{boxCode} – box code (String)
{archivingDateFrom} – archiving date (String in format dd/MM/yyyy)
{archivingDateTo} – archiving date (String in format dd/MM/yyyy)
{finalizationDateFrom} – finalization date (String in format dd/MM/yyyy)
{finalizationDateTo} – finalization date (String in format dd/MM/yyyy)
{archiveTypeId} – archive type (Number, 1 – electronic documents, 2 – physical archive documents)
{boxTypeId} – box type ID (number)
{parentBoxCode} – parent box code (String)
{addressFrom} – physical storage address (String)
{addressTo} – physical storage address (String)
{finalStateId} – final state ID (Number)
{storageYears} – number of storage years (String)
{storageTypeId} – storage type (Number, 1 – electronic storage, 2 – physical archive storage)
{storageId} – storage ID (Number)
{showFinalDocs} – show finalized documents (Number, 1 – means yes)
{boxMode} – search in box mode (Number, 1 – means yes)
{comment} – comments (String)

Voici la liste des informations retournées par cette méthode :

“count” : Objet JSON contenant le nombre de documents trouvés.

“success” :

“1” : Recherche effectuée avec succès

http://localhost:8080/DamarisRM/dgs3g-ws/search/searchArchivesAdvanced/{key}/{searchText}/{pageNumber}/{pageSize}/{latitude}/{longitude}/{imei}/{docId}/{indexes}/{depId}/{compId}/{fileCode}/{boxCode}/{archivingDateFrom}/{archivingDateTo}/{finalizationDateFrom}/{finalizationDateTo}/{archiveTypeId}/{boxTypeId}/{parentBoxCode}/{addressFrom}/{addressTo}/{finalStateId}/{storageYears}/{storageTypeId}/{storageId}/{showFinalDocs}/{boxMode}/{comment}

Où :

{key} – unique key retrieved after login (String)
{searchText} – search text or empty string (String)
{pageNumber} – current page number (String)
{pageSize} – number of records per page (String)
{latitude} – latitude of caller or empty string (String)
{longitude} – longitude of caller or empty string (String)
{imei} – IMEI of caller or empty string (String)
{docId} – document type ID (Number)
{indexes} – base 64 encoded string which contains search criteria based on indexes. The content of this parameter is JSON map, where key is index ID and value is searched value.
{compId} – company ID (Number)
{fileCode} – file code (String)
{boxCode} – box code (String)
{archivingDateFrom} – archiving date (String in format dd/MM/yyyy)
{archivingDateTo} – archiving date (String in format dd/MM/yyyy)
{finalizationDateFrom} – finalization date (String in format dd/MM/yyyy)
{finalizationDateTo} – finalization date (String in format dd/MM/yyyy)
{archiveTypeId} – archive type (Number, 1 – electronic documents, 2 – physical archive documents)
{boxTypeId} – box type ID (number)
{parentBoxCode} – parent box code (String)
{addressFrom} – physical storage address (String)
{addressTo} – physical storage address (String)
{finalStateId} – final state ID (Number)
{storageYears} – number of storage years (String)
{storageTypeId} – storage type (Number, 1 – electronic storage, 2 – physical archive storage)
{storageId} – storage ID (Number)
{showFinalDocs} – show finalized documents (Number, 1 – means yes)
{boxMode} – search in box mode (Number, 1 – means yes)
{comment} – comments (String)

Voici la liste des informations retournées par cette méthode :

“archives” : Objet JSON contenant le résultat de la recherche.

“success” :

“1” : Recherche effectuée avec succès

Retourne les notices étendues d’un enregistrement en particulier.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/search/getExtendedNotices/uniqueKey/recordID

Où :

uniqueKey : Jeton de la session ouverte précédemment
recordID : Identifiant unique de l’archive

Voici la liste des informations retournées par cette méthode :

“extendedNotices” : Objet JSON contenant la liste des notices étendues correspondants à l’archive sélectionnée

“success” :

“1” : Recherche effectuée avec succès
“0” : Pas de notice étendue pour l’archive sélectionnée
“-1” : Erreur lors de l’exécution de cette commande
“-2” : recordID introuvable ou invalide

Retourne la liste des définitions des Tampons électroniques.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/stamp/getStampDefinitions/uniqueKey

Où :

uniqueKey : Jeton de la session ouverte précédemment

Voici la liste des informations retournées par cette méthode :

“stampDefinitions” : Objet JSON contenant la liste des Tampons électroniques disponibles pour l’utilisateur

“success” :

“1” : Opération effectuée avec succès
“0” : Pas de Tampons disponibles pour l’utilisateur connecté
“-1” : Erreur lors de l’exécution de cette commande

Exemple avec cURL

Voici un exemple de ligne de commande pour cette fonction :

curl -X POST -H "Content-Type: application/json" "https://prod4.damaris.pro/dgs3g_Damaris/dgs3g-ws/stamp/getStampDefinitions/UKEPDHMUDQP0WLYUBRL1_201958112318862"

Au retour, voici un exemple de flux JSON :

JSON Get Stamp Definitions

Ajoute un Tampon électronique sur un enregistrement sélectionné.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/stamp/addStamp/uniqueKey/recordID/stampDefID/comments

Où :

uniqueKey : Jeton de la session ouverte précédemment
recordID : Identifiant unique d’un document. Peut être trouvé en utilisant la méthode search/searchArchives. Vous pouvez soumettre plusieurs recordID avec le séparateur tiret “-“.
stampDefID : Identifiant unique d’une définition de Tampon. Peut être trouvé en utilisant la méthode stamp/getStampDefinitions
comments : Texte optionnel lié au tampon à appliquer

Voici la liste des informations retournées par cette méthode :

“stampDefinitions” : Objet JSON contenant la liste des Tampons électroniques disponibles pour l’utilisateur

“success” :

“1” : Opération effectuée avec succès
“-1” : Erreur lors de l’exécution de cette commande
“-2” : recordID non trouvé ou invalide
“-3” : stampDefID non trouvé ou invalide
“-4” : L’utilisateur n’a pas les permissions pour cette opération

Retrouve les Tampons électroniques appliqués sur un document en particulier.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/stamp/getRecordStamps/uniqueKey/recordID/stampDefID/comments

Où :

uniqueKey : Jeton de la session ouverte précédemment
recordID : Identifiant unique d’un document. Peut être trouvé en utilisant la méthode search/searchArchives. Vous pouvez soumettre plusieurs recordID avec le séparateur tiret “-“.
stampDefID : Identifiant unique d’une définition de Tampon. Peut être trouvé en utilisant la méthode stamp/getStampDefinitions
comments : Texte optionnel lié au tampon à appliquer

Voici la liste des informations retournées par cette méthode :

“stamps” : Objet JSON contenant la liste des Tampons électroniques appliqués sur le ou les enregistrements sélectionnés

“success” :

“1” : Opération effectuée avec succès
“0” : Pas de Tampons trouvés
“-1” : Erreur lors de l’exécution de cette commande
“-2” : recordID non trouvé ou invalide

Retrouve les types de demandes de sorties disponibles. Le résultat de cette méthode pourra être utilisé lors des futures demandes de sorties.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/request/getRequestTypes/uniqueKey/languageKey

Où :

uniqueKey : Jeton de la session ouverte précédemment
languageKey : Code langue préféré de l’utilisateur (Exemple : fr, en)

Voici la liste des informations retournées par cette méthode :

“requestTypes” : Objet JSON contenant la liste des types de demandes de sorties disponibles

“success” :

“1” : Opération effectuée avec succès
“0” : Pas de Type de demande disponible
“-1” : Erreur lors de l’exécution de cette commande
“-2” : languageKey non trouvé ou invalide

Retrouve les Motifs de demandes de sorties disponibles. Le résultat de cette méthode pourra être utilisé lors des futures demandes de sorties.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/request/getRequestReasons/uniqueKey/languageKey

Où :

uniqueKey : Jeton de la session ouverte précédemment
languageKey : Code langue préféré de l’utilisateur (Exemple : fr, en)

Voici la liste des informations retournées par cette méthode :

“requestReasons” : Objet JSON contenant la liste des Motifs de demandes de sorties disponibles

“success” :

“1” : Opération effectuée avec succès
“0” : Pas de Motif de demande disponible
“-1” : Erreur lors de l’exécution de cette commande
“-2” : languageKey non trouvé ou invalide

Effectue une demande de sortie d’archives physiques.

Voici la syntaxe de l’appel :

http://localhost:8080/DamarisRM/dgs3g-ws/request/doRequest/uniqueKey/recordID/expectedDate/returnDate/requestReason/expectedType/isEntireBox/requester/comments

Où :

uniqueKey : Jeton de la session ouverte précédemment
recordID : Identifiant unique d’un document
expectedDate : Date de livraison souhaitée (Format date : jjmmaaaa)
returnDate : Date de retour de l’article aux archives souhaitée (Format date : jjmmaaaa)
requestReason : Motif de la demande
expectedType : Type de demande
isEntireBox : Sortie par boite (true, false)
requester : Demandeur (Autre que l’utilisateur effectuant la demande de sortie)
comments : Commentaires éventuels liés à la demande

Voici la liste des informations retournées par cette méthode :

“success” :

“1” : Opération effectuée avec succès
“0” : Pas de demande créé
“-1” : Erreur lors de l’exécution de cette commande
“-2” : recordID non trouvé ou invalide
“-3” : recordID ne correspond pas à une archive physique
“-4” : expectedDate et/ou returnDate manquants
“-5” : expectedType manquant
“-6” : Valeur entireBox invalide (Doit être true ou false)
“-7” : returnDate doit être postérieure à expectedDate
“-8” : expectedType invalide
“-9” : Demande déjà existante sur l’article

Damaris RM Web Services