$connect (sdata)

Version du 7 octobre 2013 à 13:38

Le service SData supporte une fonction système pour ouvrir une session ou obtenir des information à propos de la session ouverte.

L'url de cette fonction est :

http://www.example.com/service/server/sdata/$connect

Pour un service utilisant le serveur HTTP intégré l'URL peut être simplifiée :

http://www.example.com/sdata/$connect

Les requêtes de méthode GET/HEAD/POST sont autorisées.

Lorsque un identifiant de session est passé en paramètre la session correspondante est contrôlée, si elle est valide cette session est réutilisée et la requête n'alloue pas de nouvelle session. La configuration de la session peut être ensuite modifiée suivant les paramètres de la requête.

Paramètres

Les paramètres supportés sont :

Paramètre	Usage
user	Identifiant de l'utilisateur
password	Mot de passe de l'utilisateur
folder	Dossier où ouvrir une session } Tip : Le paramètre folder est optionnel si le Service sert un seul dossier. Pour un dossier multi-sociétés les paramètres suivants sont optionnels : Paramètre Usage society Société de travail du dossier si le dossier est multi-sociétés societies Sociétés de restitution du dosser si le dossier est multi-sociétés Code de retour Code Contenu Usage 200 Information de session La session est connectée 403 Forbidden Les informations d'authentification ne sont pas valident 404 Dépend de la raison La session est connecté mais les informations de configuration du contexte ne sont pas valident. Contenu Lorsque la la requête retourne 200 le contenu contient des informations sur la configuration de la session. Le format de la réponse dépend de la valeur du paramètre Accept de l'entête de la requête, les formats supportées sont json,text,xml. Les paramètres retournés sont : Paramètre Usage user Nom de l'utilisateur de l'utilisateur. userLanguage Langue de l'utilisateur. userName Intitulé de l'utilisateur. asMember Autorisé en tant que membre du groupe. folder Dossier de la session. application Nom de l'application de la session } Si le dossier est multi-société les informations suivantes sont retournées : Paramètre Usage society Société de travail de la session. societies Sociétés de restitution du dossier si le contexte de partage est en mode restitution. readSocieties Sociétés sur lesquelles l'utilisateur à un droit de lecture. writeSocieties Sociétés sur lesquelles l'utilisateur à un droit de modification.