$connect (sdata)

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.

Méthode	Paramètres
GET/HEAD	Dans l'URL
POST	Dans le payload, format form-encoded

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
username	Identifiant de l'utilisateur
password	Mot de passe de l'utilisateur
group	Autorisé en tant que membre de ce groupe
authdirectory	Annuaire d'identité
md5	Hash md5 du mot de passe
society	Dossier où ouvrir une session

Tip : Le paramètre society 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
shareSociety	Société de travail du dossier si le dossier est multi-sociétés
shareSocieties	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és sont json,text,xml.

Les paramètres retournés sont :

Informations sur le dossier

Paramètre	Usage
socname	Dossier de la session.
appname	Nom de l'application de la session
glbShareEnable	Le contexte est en mode partage

Informations sur l'utilisateur

Paramètre	Usage
username	Nom de l'utilisateur.
userfullname	Nom complet de l'utilisateur.
userlanguage	Langue de l'utilisateur.
useremail	Email de l'utilisateur.
groupname	Autorisé en tant que membre du groupe.
authdirname	Intitulé de l'annuaire utilisé.

Si le dossier est multi-société les informations suivantes sont retournées :

Vue contexte :

Paramètre	Usage
glbShareRestitution	Le contexte est mode restitution
glbShareAllPerimeters	Le contexte est en mode restitution sur toutes les sociétés
glbShareSocieties	Liste des sociétés du contexte de restitution
glbShareGroupMode	Le contexte est en mode groupe
glbShareGroupPerimeter	Périmètre groupe du contexte.
glbShareSocietyPerimeter	Périmètre sociétés du contexte
glbSharePerimeters	Périmètres actifs du contexte
glbShareSocietyName	Nom de la société du contexte
glbSharePerimeterNames	Nom de tous les périmètres actifs du contexte
glbShareSocietyNames	Nom de toutes les sociétés du dossier
GlbShareAutorizedReadSocieties	Nom des sociétés sur lesquelles l'utilisateur à des droits de lecture
GlbShareAutorizedWriteSocieties	Nom des sociétés sur lesquelles l'utilisateur à des droits d'écriture

Vue API :

Information	Type	Valeur
ShareState	string	Une chaîne contenant la sérialisation de l'état du contexte de partage.
ShareSociety	OID	Le périmètre de la société active
ShareSocietyName	string	le nom de la société active.
ShareRestitution	boolean	Le contexte est en mode restitution.
ShareAllPerimeters	boolean	Le mode restitution est sur toutes les sociétés du dossier.
ShareRestitutionSocieties	StringList	Liste des noms de toutes les périmètres des sociétés actives