oData gestion des entités

Description des propriétés

Légende :

Propriété Navigable

Recherche d’utilisateurs

Le nom de l’entité est « Users »

Pour récupérer la liste des utilisateurs il suffit de spécifier le nom de l’entité après le point d’entrée.

/odata-api/Users

Attention : il est recommandé de spécifier l’option $top pour limiter le nombre d’éléments retournés

La méthode d’envoi doit être « GET »

Pour rechercher un utilisateur par son nom, utiliser l’option de filtrage $filter.

/odata-api/Users?$filter=FirstName eq 'Pierre'

   { "@odata.context": "https://develop-qa.syfadis.com/odata-api/$metadata#Users",

   "value": [

       {

           "Id": 18776068,

           "ApplicationId": 9797632,

           "DeletedOn": null,

           "CreatedOn": "2018-05-16T14:36:12Z",

           "ModifiedOn": "2023-09-12T13:58:53.2081327Z",

           "Version": 71,

           "Name": "Jean Dubois",

           "Description": null,

           "ExternalId": "user8",

           "PrimaryDomainId": 114884610,

           "Gender": "Male",

           "Prefix": "Mister",

           "Category": "Level3",

           "FirstName": "Jean",

           "LastName": "Dubois",

           "Address": "12 avenue des Tulipes",

           "City": "Rueil Malmaison",

           "Country": "France",

           "Fax": "",

           "WorkPhone": "3 85 42 42 42",

           "MobilePhone": "",

           "PostalCode": "92012",

           "Coefficient": "",

           "DisabledOn": null,

           "EnabledOn": null,

           "FirstLanguage": null,

           "FirstNameUse": null,

           "Language": "French",

           "LastNameUse": null,

           "MaidenName": null,

           "Nationality": "",

           "Title": "Responsable pédagogique",

           "Code": "user8",

           "CompletePictureUrl": "/Files/Applications/9797632/Pictures/18776068/AllanShelton.jpg",

           "Login": "apprenant8",

           "Mail": "sebastien.xxxxx@gmail.com",

           "PositionTitle": "Responsable pédagogique",

           "RateWorkingTime": null,

           "BornOn": "1968-01-02",

           "StartedOn": "2000-01-02",

           "FinishedOn": null,

           "OptionalField1": "",

           "OptionalField2": null,

           "OptionalField3": null,

           "OptionalField4": null,

           "OptionalField5": null,

           "OptionalField6": null,

           "OptionalField7": null,

           "OptionalField8": null,

           "TimeZoneId": "",

           "OptionalEnumField1": "None",

           "OptionalEnumField2": "None",

           "OptionalEnumField3": "None",

           "OptionalEnumField4": "None",

           "OptionalEnumField5": "None",

           "OptionalEnumField6": "None",

           "OptionalEnumField7": "None",

           "OptionalEnumField8": "None",

           "OptionalDateField1": null,

           "OptionalDateField2": null,

           "OptionalDateField3": null,

           "Grade": "None",

           "SyncToolsStatus": "Available",

           "ConnectionState": "Disconnected",

           "BlogId": null,

           "AnonymisationStatus": "NotAnonymised",

           "UserProjectStatus": null,

           "TotalPercentRealized": null,

           "SkillRequirementCoverage": null,

           "NoMailing": false,

           "PositionStartedOn": null,

           "UserType": "None",

           "Comments": "",

           "PlatformMailTransfer": false,

           "PictureUrl": "AllanShelton.jpg",

           "Import_DomainExternalId": null,

           "Import_CodeProfils": null,

           "ManagerExternalId": null,

           "StructureStartedOn": null,

           "JobStartedOn": null,

           "JobAge": 0,

           "DomainStartedOn": null,

           "EstablishmentStartedOn": null,

           "PosteStartedOn": null,

           "BlockedEducationally": false,

           "BlockedAdministratively": false,

           "PosteAge": 0,

           "HideFirstConnectionWizard": false,

           "ForceFirstConnectionWizard": false,

           "FirstConnectionWizardSavedOn": null,

           "ImageFile": "AllanShelton.jpg",

           "ContractType": "None",

           "ContractNature": "None",

           "WorkTime": "None",

           "ContractStart": null,

           "ManagementLevel": "",

           "TermsOfUseValidatedOn": "2021-01-26T09:17:37Z",

           "AnonymisationFinishedOn": null,

           "InterviewAvailability": true,

           "CreatedBy": {

               "Id": 0,

               "Name": "Superviseur",

               "TypeAlias": null,

               "ExternalId": null,

               "TypeName": null

           },

           "ModifiedBy": {

               "Id": 18776100,

               "Name": "Pellerin Guillaume",

               "TypeAlias": null,

               "ExternalId": null,

               "TypeName": null

           },

           "DynamicFields": {},

           "DeletedBy": null

       }

   ]

}

Pour ne retourner qu’une liste de propriétés, utiliser l’opérateur $select

/odata-api/Users?$select=FirstName,LastName

Obtenir des informations sur un utilisateur

Pour récupérer toutes les informations sur un utilisateur en particulier, vous pouvez spécifier son identifiant de la manière suivante.

/odata-api/Users(327680)

Pour ne récupérer qu’une propriété précisément, vous pouvez la préciser de la manière suivante.

/odata-api/Users(327680)/Name

Autrement, utiliser l’opérateur $select pour spécifier les propriétés souhaitées.

Exemple pour récupérer les rôles d’un utilisateur (nom du rôle et domaine):

/odata-api/Users(3852664867)?$expand=UserRoles($expand=Role,Domain)

Création d’un utilisateur

Pour créer une entité, la requête doit être envoyée avec la méthode « POST » et spécifier les propriétés éditables de l’entité dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires et ne pouvez définir que les propriétés éditables.

L’url doit contenir le nom de l’entité à savoir « User ».

La requête suivante crée un nouvel utilisateur avec pour domaine principal le domaine ayant l'identifiant Syfadis 131072 et un domaine secondaire ayant l'identifiant 131079:

En réponse, le contenu de l’entité créée est retourné. Notez que les propriétés de navigation de sont pas incluses :

Seules les propriétés éditables peuvent être spécifiées.

Remarque : Si le mot de passe n’est pas spécifié dans le JSON et qu’il est obligatoire pour la création d’un utilisateur, vous pouvez le générer automatiquement en positionnant le paramètre Génération automatique de mot de passe à Vrai (dans Paramètres > La configuration, puis sous Paramètres > Annuaire > Login et mot de passe).

Les types de réponses possibles :

• 201 Created : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section : Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Modification d’un utilisateur

Pour modifier une entité, la requête doit être envoyée avec la méthode « PATCH » et spécifier les propriétés éditables à mettre à jour, dans le corps au format JSON.

Nous recommandons l'utilisation du PATCH plutôt que celle du PUT pour les mises à jour d'entité.

Dans le cas où vous souhaitez récupérer l’ensemble des propriétés de l’entité, après sa mise à jour vous pouvez ajouter la préférence de type "return=representation" dans l'entête (Header) de la requête comme dans l’exemple ci-dessous. Cela permet la récupération de toutes les propriétés de l'objet après sa modification dans la réponse et contribue ainsi à réduire la charge de travail du serveur en limitant le nombre de requêtes.

La requête suivante modifie la propriété code pour l’utilisateur ayant l'identifiant Syfadis 327680.

En réponse, le contenu de l’entité mise à jour est retourné.

Seules les propriétés éditables sont modifiables.

Les types de réponses possibles :

• 200 OK: OK (Cas du header avec retour selon une représentation)

• 204 No Content: OK (Cas sans représentation)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 404 NotFound: Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Archivage d’un utilisateur

Pour archiver une entité, la requête doit être envoyée avec la méthode « DELETE » en ciblant une entité.

La requête suivante archive l’utilisateur ayant l’identifiant Syfadis 327680 :

Les types de réponses possibles :

• 204 No Content: OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound: Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Restauration d’un utilisateur

Pour restaurer une entité, il faut appeler la fonction « Services.Restore ».

La requête suivante restaure l’utilisateur ayant l’identifiant Syfadis 327680.

POST /odata-api/Users(327680)/Services.Restore

Les types de réponses possibles :

• 204 No Content: OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound: Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Ajouter un rôle à un utilisateur

Pour ajouter un rôle à un utilisateur, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.AddUserRole » sur un utilisateur ciblé. Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

L’action à appeler est : Services.AddUserRole

La requête suivante ajoute le rôle ayant l’identifiant Syfadis 229378 sur le domaine ayant l’identifiant Syfadis 163840 pour l’utilisateur ayant l’identifiant Syfadis 327680

Les types de réponses possibles :

• 201 Created : OK (la réponse contient une entité de type UserRole)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Actuellement il n'est pas possible d'ajouter un rôle au moment de la création de l'utilisateur

Retirer un rôle à un utilisateur

Pour retirer un rôle à un utilisateur, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.RemoveUserRole » sur un utilisateur ciblé. Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

L’action à appeler est : Services.RemoveUserRole

La requête suivante retire le rôle créé dans le chapitre « Ajouter un rôle à un utilisateur »

Définir l’image de profil d’un utilisateur

Pour ajouter une image de profil à un utilisateur, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.SetUserPicture » sur un utilisateur ciblé. Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

L’action à appeler est : Services.SetUserPicture

La requête suivante ajoute une image de profil à l’utilisateur ayant l’identifiant Syfadis 126976000

*** REQUEST ***

Http Method : POST

Http Headers :

Authorization : Basic c2ZlOjFCb3VnYWludmlsbCFlcg==

Http URI :

https://bpce.syfadis.local/odata-api/Users(126976000)/Services.SetUserPicture

Http body :

{

"ImageContent" : [137,80,78,71,13,10,26,10,0,0,0,13,73,72,68,…]

}

*** RESPONSE ***

Status : 204 Created

Les types de réponses possibles :

• 204 No Content : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Actuellement il n'est pas possible d'ajouter une image de profil au moment de la création de l'utilisateur.

Gestion des organismes de formation

Description des propriétés

Cette entité se nomme « TrainingProvider ». Elle est associée aux objets « Formation » et « Session de formation ».

Gestion des groupes

Les groupes représentent un ensemble d’entités structurées de la même manière, et qui permet de regrouper les utilisateurs.

Les entités qualifiées de groupes sont :

Description des propriétés

Légende :

Propriété Navigable

Rechercher des groupes

Pour récupérer la liste des groupes, il suffit de spécifier le nom de l’entité après le point d’entrée.

/odata-api/Domain

Attention : il est recommandé de spécifier l’option $top pour limiter le nombre d’éléments retournés.

La méthode d’envoi doit être « GET »

Pour rechercher un groupe par son nom, utiliser l’option de filtrage $filter.

/odata-api/Domains?$filter=Name eq 'Futurskill'

Obtenir des informations sur un groupe

Pour récupérer toutes les informations sur un groupe en particulier, vous pouvez spécifier son identifiant de la manière suivante.

/odata-api/Domains(163840)

Création d’un groupe

Pour créer une entité, la requête doit être envoyée avec la méthode « POST » et spécifier les propriétés éditables de l’entité dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires et ne pouvez définir que les propriétés éditables

L’url doit contenir le nom de l’entité à savoir l’une des valeurs indiquées au début de ce chapitre

La requête suivante crée une structure nommée FuturSkill :

En réponse, le contenu de l’entité créée est retourné :

Seules les propriétés éditables peuvent être spécifiées

Les types de réponses possibles :

• 201 Created : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Modification d’un groupe

Pour modifier une entité, la requête doit être envoyée avec la méthode « PATCH » et spécifier les propriétés éditables à mettre à jour, dans le corps au format JSON.

Nous recommandons l'utilisation du PATCH plutôt que celle du PUT pour les mises à jour d'entité.

Dans le cas où vous souhaitez récupérer l’ensemble des propriétés de l’entité, après sa mise à jour vous pouvez ajouter la préférence de type "return=representation" dans l'entête (Header) de la requête comme dans l’exemple ci-dessous. Cela permet la récupération de toutes les propriétés de l'objet après sa modification dans la réponse et contribue ainsi à réduire la charge de travail du serveur en limitant le nombre de requêtes.

La requête suivante modifie la propriété code pour la structure ayant l'identifiant Syfadis 2228224.

En réponse, le contenu de l’entité mise à jour est retourné :

Seules les propriétés éditables sont modifiables

Les types de réponses possibles :

• 200 OK: OK (Cas du header avec retour selon une représentation)

• 204 No Content: OK (Cas sans représentation)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound: Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Archiver un groupe

Pour archiver une entité, la requête doit être envoyée avec la méthode « DELETE » en ciblant une entité.

La requête suivante archive la structure ayant l’identifiant Syfadis 2228224

Les types de réponses possibles :

• 204 No Content: OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound: Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Restaurer un groupe

Pour restaurer une entité, il faut appeler la fonction « Services.Restore ».

La requête suivante restaure la structure ayant l’identifiant Syfadis 2228224

POST /odata-api/Structures(2228224)/Services.Restore

Les types de réponses possibles :

• 204 No Content: OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound: Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Gestion des sessions

Il existe deux types de sessions dans Syfadis.

• Les sessions de formation (TrainingSessions)

• Les sessions d’évaluation (EvaluationSessions)

Session de formation

Légende : Propriété Navigable

Session d’évaluation

Légende :

Propriété Navigable

Rechercher des sessions

Pour récupérer la liste des sessions, il suffit de spécifier le nom de l’entité après le point d’entrée.

/odata-api/ TrainingSessions

/odata-api/ ÉvaluationSessions

Attentio : il est recommandé de spécifier l’option $top pour limiter le nombre d’éléments retournés.

La méthode d’envoi doit être « GET »

Pour rechercher une session par son nom, utiliser l’option de filtrage $filter.

/odata-api/ TrainingSessions?$filter=contains(Name,'session')

Obtenir des informations sur une session

Pour récupérer toutes les informations sur une session en particulier, vous pouvez spécifier son identifiant de la manière suivante.

/odata-api/EvaluationSessions(2850816)

Rechercher les séances présentielles ou classes virtuelles d’une session

Le nom de l’entité à requêter est « MeetingSessions »

/odata-api/MeetingSessions

La méthode d’envoi doit être « GET »

Pour obtenir la liste des séances présentielles d’une session, utiliser l’option de filtrage $filter.

/odata-api/MeetingSessions?$filter=TrainingSession/Id eq 2247950336 and MeetingMode eq 'Presential'

*** REQUEST ***

Http Method : GET

Http Headers :

Authorization : Basic c2ZlOjFCb3VnYWludmlsbCFlcg==

Http URI :

https://demo.condate.com/odata-api/MeetingSessions?$filter=TrainingSession/Id eq 2247950336 and MeetingMode eq 'Presential'

*** RESPONSE ***

Status : 200 OK

Body : {

   "@odata.context": "https://demo.condate.com/odata-api/$metadata#MeetingSessions",

   "value": [

       {

           "Id": 2311913488,

           "Name": "Séance présentielle",

           "ExternalId": null,

           "CreatedBy": {

               "Id": 0,

               "Name": "Superviseur"

           },

           "ModifiedBy": {

               "Id": 0,

               "Name": "Superviseur"

           },

           "CreatedOn": "2022-06-15T13:23:42.2486119Z",

           "ModifiedOn": "2022-06-15T13:41:54.8040112Z",

           "DeletedOn": null,

           "Description": null,

           "Duration": {

               "Length": 9.00000,

               "Scale": "Hours"

           },

           "DurationHours": 9.00000,

           "StartedOn": "2022-05-09T07:00:00Z",

           "FinishedOn": "2022-05-10T15:00:00Z",

           "TimeZoneId": null,

           "MeetingMode": "Presential"

       }

   ]

}

Les types de réponses possibles :

• 200 OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Pour obtenir la liste des séances de classe virtuelle d’une session, utiliser l’option de filtrage $filter.

/odata-api/MeetingSessions?$filter=TrainingSession/Id eq 2247950336 and MeetingMode eq ' VirtualClass'

Obtenir les informations sur une séance présentielle ou classe virtuelle

Pour récupérer toutes les informations sur une séance en particulier, incluant les lieux et salles de formation, utiliser la requête suivante.

odata-api/MeetingSessions(2311913488)?$expand=Localisation,Rooms

*** REQUEST ***

Http Method : GET

Http Headers :

Authorization : Basic c2ZlOjFCb3VnYWludmlsbCFlcg==

Http URI :

https://demo.condate.com/odata-api/MeetingSessions(2311913488)?$expand=Localisation,Rooms

*** RESPONSE ***

Status : 200 OK

Body :

{    

"@odata.context": "https://v60.syfadis.com/odata-api/$metadata#MeetingSessions",

   "value": [

       {

           "Id": 2311913488,

           "Name": "Séance présentielle",

           "ExternalId": null,

           "CreatedBy": {

               "Id": 0,

               "Name": "Superviseur"

           },

           "ModifiedBy": {

               "Id": 0,

               "Name": "Superviseur"

           },

           "CreatedOn": "2022-06-15T13:23:42.2486119Z",

           "ModifiedOn": "2022-06-15T13:41:54.8040112Z",

           "DeletedOn": null,

           "Description": null,

           "Duration": {

               "Length": 9.00000,

               "Scale": "Hours"

           },

           "DurationHours": 9.00000,

           "StartedOn": "2022-05-09T07:00:00Z",

           "FinishedOn": "2022-05-10T15:00:00Z",

           "TimeZoneId": null,

           "MeetingMode": "Presential",

           "Localisation": {

               "Id": 208797726,

               "CreatedBy": {

                   "Id": 0,

                   "Name": "Superviseur"

               },

               "ModifiedBy": null,

               "CreatedOn": "2018-05-30T12:23:33Z",

               "ModifiedOn": null,

               "DeletedOn": null,

               "ExternalId": null,

               "Name": "Golf de Rennes",

               "Code": null,

               "Father0": null,

               "Father1": null,

               "Father2": null,

               "Father3": null,

               "Father4": null,

               "Father5": null,

               "Father6": null,

               "Father7": null,

               "Father8": null,

               "Depth": 0,

               "StartedOn": null,

               "FinishedOn": null,

               "Address": "Golf de Rennes\nLe Temple du Cerisier",

               "City": "Saint Jacques de la Lande",

               "Contact": null,

               "Country": "France",

               "Description": null,

               "Email": null,

               "FaxNumber": null,

               "MobileNumber": null,

               "PhoneNumber": null,

               "PostalCode": "35136",

               "ShortNumber": null

           },

           "Rooms": [

               {

                   "Id": 2312896513,

                   "Code": "",

                   "Name": "Salle 2",

                   "Description": "Au fond du golf",

                   "CreatedBy": {

                       "Id": 0,

                       "Name": "Superviseur"

                   },

                   "ModifiedBy": null,

                   "CreatedOn": "2022-06-15T13:41:13.0883475Z",

                   "ModifiedOn": null,

                  "DeletedOn": null,

          “ExternalID": null,

                  "Capacity": null,

                  '"RoomType": "None"

                 }

              ]

           }

      ]

}          

Les types de réponses possibles :

• 200 OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Création d’une session

Pour créer une entité de type session, la requête doit être envoyée avec la méthode « POST » et appeler l‘action « Service.Create ». Enfin, celle-ci doit spécifier les propriétés éditables de l’entité dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires et ne pouvez définir que les propriétés éditables

L’url doit contenir le nom de l’entité à savoir l’une des valeurs indiquées au début de ce chapitre

Les types de réponses possibles :

• 201 Created : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Session de formation

En plus des propriétés éditables obligatoires, vous devez au minimum spécifier les propriétés obligatoires suivantes :

L’action à appeler est : Services.Create

La requête suivante crée une Session de formation

Session d’évaluation

En plus des propriétés éditables obligatoires, vous devez au minimum spécifier les propriétés obligatoires suivantes :

L’action à appeler est : Services.Create

La requête suivante crée une Session d’évaluation

Modification d’une session

Modification des propriétés éditable

Pour modifier les propriétés éditables d’une entité, la requête doit être envoyée avec la méthode « PATCH » et spécifier les propriétés éditables à mettre à jour, dans le corps au format JSON.

Nous recommandons l'utilisation du PATCH plutôt que celle du PUT pour les mises à jour d'entité.

Dans le cas où vous souhaitez récupérer l’ensemble des propriétés de l’entité, après sa mise à jour vous pouvez ajouter la préférence de type "return=representation" dans l'entête (Header) de la requête comme dans l’exemple ci-dessous. Cela permet la récupération de toutes les propriétés de l'objet après sa modification dans la réponse et contribue ainsi à réduire la charge de travail du serveur en limitant le nombre de requêtes.

La requête suivante modifie la propriété code pour la session de formation ayant l'identifiant Syfadis 2850818.

En réponse, le contenu de l’entité mise à jour est retourné :

Les types de réponses possibles :

• 200 OK : OK (Cas du header avec retour selon une représentation)

• 204 No Content : OK (Cas sans représentation)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound: Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Modification des dates (formation)

Uniquement disponible pour les sessions de formation.

Pour modifier les dates de début et/ou de fin de session, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.Update ». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

L’action à appeler est : Services.Update

La requête suivante prolonge la date de fin de la session :

Les types de réponses possibles :

• 200 OK: OK (Cas du header avec retour selon une représentation)

• 204 No Content : OK (Cas sans représentation)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Modification des tuteurs et du lieu (formation)

Uniquement disponible pour les sessions de formation

Pour modifier les dates de début et/ou de fin de session, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.Update ». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

Les tuteurs ne sont affectés qu’aux éléments racines

L’action à appeler est : Services.Update

La requête suivante, ajouter deux tuteurs à la session :

Les types de réponses possibles :

• 200 OK : OK (Cas du header avec retour selon une représentation)

• 204 No Content : OK (Cas sans représentation)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Emargement des présences

Uniquement dans le cadre des formations contenants des séances présentielles (MeetingSession).

Pour émarger les présences d’un utilisateur sur un MeetingSession, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.Attendance». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier les propriétés obligatoires.

Les tuteurs ne sont affectés qu’aux éléments racines

L’action à appeler est : Services.Attendance

La requête suivante, emarger une inscription :

Emargement du tuteur

Uniquement dans le cadre des formations contenants des séances présentielles (MeetingSession).

Pour faire émarger un tuteur, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.TutorAttendance ». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier les propriétés obligatoires.

L’action à appeler est : Services.TutorAttendance

Les types de réponses possibles:

• 204 No Content: OK

• 400 Bad Request : Erreur technique ou fonctionnelle

Récupérer les informations sur l’émargement d’un élément présentiel

Pour récupérer les informations d’émargement pour une séance présentielle, une classe virtuelle ou une mise en situation, il faut requêter l’entité TraineePresenceViews.

Propriété Navigable

Exemple de requête pour récupérer les informations sur l’émargement d’un élément présentiel :

odata-api/TraineePresenceViews?filter=MeetingSession/Id eq 100 &expand=ComponentRun,Trainee($expand=User)

L’entité « AbstractCourseComponentRun » navigable depuis « TraineePresenceViews » contient les informations sur l’élément présentiel:

Déposer des documents

Uniquement dans le cadre des formations contenants des séances présentielles (MeetingSession)

Pour déposer un document dans le MeetingSession, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.AttendanceSheet». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier les propriétés obligatoires.

L’action à appeler est : Services. AttendanceSheet

La requête suivante, permet de déposer un fichier dans la séance de la session :

Archivage d’une session

Pour archiver une entité, la requête doit être envoyée avec la méthode « DELETE » en ciblant une entité.

La requête suivante archive la session de formation ayant l’identifiant Syfadis 2850818

Les types de réponses possibles :

• 204 No Content : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 404 NotFound : Enregistrement inexistant

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Annulation d’une session

Pour annuler une session, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.Cancel ».

Exemple pour annuler la session avec l’identifiant Syfadis « 1234 » :

POST https://demo.condate.com/odata-api/TrainingSessions(1234)/Services.Cancel

{

"CancelReason": "3",

"CancelDescription": "Formateur en arrêt",

"Chargeable": true

}

Ci-dessous les propriétés à envoyer à l’action :

Les types de réponses possibles :

• 204 No Content : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 404 NotFound : Enregistrement inexistant

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Gestion des inscriptions

Il existe deux types d’inscription dans Syfadis.

• Les inscriptions au session de formation (Trainees)

• Les inscriptions au session d’évaluation (ÉvaluationTrainees)

Inscription de formation

Légende :

Propriété Navigable

Inscription d’évaluation

Légende :

Propriété Navigable

Rechercher des inscriptions

Pour récupérer la liste des inscriptions, il suffit de spécifier le nom de l’entité après le point d’entrée.

/odata-api/ Trainees

/odata-api/ ÉvaluationTrainees

Attention : il est recommandé de spécifier l’option $top pour limiter le nombre d’éléments retournés.

La méthode d’envoi doit être « GET »

Pour rechercher une inscription par rapport à un utilisateur

/odata-api/Trainees?$filter=User/Id eq 327680&$expand=User

Obtenir des informations sur une inscription

Pour récupérer toutes les informations sur une inscription en particulier, vous pouvez spécifier son identifiant de la manière suivante.

/odata-api/Trainee(2916356)

Création d’une inscription

Pour créer une entité de type inscription, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.Register ». Enfin celle-ci doit spécifier les propriétés éditables de l’entité dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires et ne pouvez définir que les propriétés éditables.

L’url doit contenir le nom de l’entité à savoir l’une des valeurs indiquées au début de ce chapitre.

En plus des propriétés éditables obligatoires, vous devez au minimum spécifier les propriétés obligatoires suivantes :

L’action à appeler est : Services.Register

La requête suivante crée une inscription de formation

Les types de réponses possibles :

• 201 Created : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 Not Found : SessionId ou UserId invalide

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Modification d’une inscription

Modification des propriétés éditables

La mise à jour des propriétés d’une inscription n’est pas possible actuellement.

Modification des dates (Formation)

Uniquement disponible pour les inscriptions de formation

Pour modifier les dates de début et/ou de fin d’inscription, la requête doit être envoyée avec la méthode « POST » et appeler l’action.

« Services.ChangeDates ». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

L’action à appeler est : Services.ChangeDates

La requête suivante décale l’inscription dans le temps:

Les types de réponses possibles :

• 200 OK: OK (Cas du header avec retour selon une représentation)

• 204 No Content: OK (Cas sans représentation)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound : Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Modification de la session (Formation)

Uniquement disponible pour les inscriptions de formation

Pour modifier l’inscription de session, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Service.ChangeSession ». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

L’action à appeler est : Services.ChangeSession

La requête suivante change l’inscription de session:

Les types de réponses possibles :

• 200 OK : OK (Cas du header avec retour selon une représentation)

• 204 No Content : OK (Cas sans représentation)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound : Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Archivage d’une inscription

Pour archiver une entité, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.Unregister ». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

Seul une des deux propriétés doivent être spécifié.

L’url doit contenir le nom de l’entité à savoir l’une des valeurs indiquées au début de ce chapitre

L’action à appeler est : Services.Unregister

La requête suivante archive l’inscription de formation ayant l’identifiant Syfadis 2916366

Les types de réponses possibles :

• 204 No Content: OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound : Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Gestion des formations / évaluations

• Les Formations (Trainings)

• Les Évaluations (Évaluations)

Les formations

Légende :

Propriété Navigable

Modification de la mise en page Catalogue & Session

Pour modifier la mise en page Catalogue et Session d’une Formation, la requête doit être envoyée avec la méthode « POST » et appeler l’une des deux actions suivantes :

• Service.SetMyTrainingsPageData

• Service.SetCatalogPageData

Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

Modification des Privilèges Front & Back Office

Pour modifier les privilèges Front ou Back Office d’une formation, la requête doit être envoyée avec la méthode « POST » et appeler l’une des six actions suivantes :

• Service.SetFrontOfficeUserPrivilege

• Service.SetFrontOfficeGroupPrivilege

• Service.SetFrontOfficeDomainPrivilege

• Service.SetBackOfficeUserPrivilege

• Service.SetBackOfficeGroupPrivilege

• Service.SetBackOfficeDomainPrivilege

Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

Les évaluations

Légende :

Propriété Navigable

Rechercher des Formations / évaluations

Pour récupérer la liste des formations ou évaluations, il suffit de spécifier le nom de l’entité après le point d’entrée.

/odata-api/Trainings

/odata-api/Évaluations

Attention, il est recommandé de spécifier l’option $top pour limiter le nombre d’éléments retournés.

La méthode d’envoi doit être « GET »

Pour rechercher une formation / évaluation par son nom, utiliser l’option de filtrage $filter.

/odata-api/Training?$filter=contains(Name,'word')

Obtenir des informations sur une formation / évaluation

Pour récupérer toutes les informations sur une formation / évaluation en particulier, vous pouvez spécifier son identifiant de la manière suivante.

/odata-api/Évaluations(753673)

Création d’une formation / évaluation

Pour créer une entité, la requête doit être envoyée avec la méthode « POST » et spécifier les propriétés éditables de l’entité dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires et ne pouvez définir que les propriétés éditables.

L’url doit contenir le nom de l’entité à savoir l’une des valeurs indiquées au début de ce chapitre.

La requête suivante crée une formation nommée FuturSkill:

En réponse, le contenu de l'entité créée est retourné :

Les types de réponses possibles :

• 201 Created : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Modification d’une formation / évaluation

Pour modifier une entité, la requête doit être envoyée avec la méthode « PATCH » et spécifier les propriétés éditables à mettre à jour, dans le corps au format JSON.

Nous recommandons l'utilisation du PATCH plutôt que celle du PUT pour les mises à jour d'entité.

Dans le cas où vous souhaitez récupérer l’ensemble des propriétés de l’entité, après sa mise à jour vous pouvez ajouter la préférence de type "return=représentation" dans l'entête (Header) de la requête comme dans l’exemple ci-dessous. Cela permet la récupération de toutes les propriétés de l'objet après sa modification dans la réponse et contribue ainsi à réduire la charge de travail du serveur en limitant le nombre de requêtes.

La requête suivante modifie les propriétés nom et code pour la formation ayant l'identifiant Syfadis 2686977.

En réponse, le contenu de l’entité mise à jour est retourné :

Les types de réponses possibles :

• 200 OK : OK (Cas du header avec retour selon une représentation)

• 204 No Content : OK (Cas sans représentation)

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound : Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Archivage d’une formation / évaluation

Pour archiver une entité, la requête doit être envoyée avec la méthode « DELETE » en ciblant une entité.

La requête suivante archive la formation ayant l’identifiant Syfadis 2686977

Les types de réponses possibles :

• 204 No Content : OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section Sécurité et authentification)

• 404 NotFound : Enregistrement inexistant

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL

Gestion du tracking communautaire

Description des propriétés

Recherche des éléments de trackings communautaires

TrackingViews

Pour récupérer les informations de suivi des éléments communautaire sur un groupe communautaire ou une session de formation, il suffit de spécifier le nom de l’entité après le point d’entrée.

/odata-api/TrackingViews

Attention, il est recommandé de spécifier l’option $top pour limiter le nombre d’éléments retournés.

La méthode d’envoi doit être « GET »

• Pour rechercher les données d’une session en particulier, il faut utiliser l’option de filtrage $filter.

• Pour remonter les données sur l’utilisateur par exemple, il faut utiliser l’option d’élargissement $expand.

• Pour sélectionner les autres données remontées, il faut utiliser l’option de sélection $select.

Voici un exemple de requête permettant de rechercher le tracking communautaire sur la session dont le code est « SESS_TEST », en remontant l’heure, le type d’action, et le nom de l’utilisateur :

/odata-api/TrackingViews?$expand=User($select=Name)&$filter=Session/Code eq 'SESS_TEST'&$select=Timestamp,ActionType

Gestion des notations des formations/évaluations

Description des propriétés

Recherche des notations

Le nom de l’entité est « ItemRatings ».

Pour récupérer les notations attribuées à une formation ou une évaluation, il suffit de spécifier le nom de l’entité après le point d’entrée.

/odata-api/ItemRatings

Attention : il est recommandé de spécifier l’option $top pour limiter le nombre d’éléments retournés.

La méthode d’envoi doit être « GET ».

• Pour rechercher les données d’une formation ou évaluation en particulier, il faut utiliser l’option de filtrage $filter.. Le filtrage n’est possible qu’avec un identifiant ou un nom de formation/évaluation.

• Pour sélectionner les données à remonter, il faut utiliser l’option de sélection $select.

Voici un exemple de requête permettant de rechercher les notations sur une formation dont l’identifiant est 143, en remontant la note et le nom de l’utilisateur :

/odata-api/ItemRatings?$filter=CatalogItem/Id eq 143&$select=User,Rate

Notation d’une formation/évaluation

Pour définir la notation d’un utilisateur donné à une formation ou évaluation, la requête doit être envoyée avec la méthode « POST » et appeler l’action « Services.RateCatalogItemForUser ». Enfin celle-ci doit spécifier les propriétés listées dans le tableau ci-dessous dans le corps au format JSON.

Vous devez spécifier au minimum les propriétés obligatoires.

L’action à appeler est : Services.RateCatalogItemForUser.

La requête suivante définit une note de 2 attribuée par l’utilisateur ayant l’identifiant Syfadis 126976000 sur la formation ayant l’identifiant Syfadis 51183616.

*** REQUEST ***

Http Method : POST

Http Headers :

Authorization : Basic c2ZlOjFCb3VnYWludmlsbCFlcg==

Http URI :

https://demo.xxxx.com/odata-api/ItemRatings/Services.RateCatalogItemForUser

Http body :

{

"UserId" : 126976000,

"CatalogItemId" : 51183616,

"Rate" : 2

}

*** RESPONSE ***

Les types de réponses possibles :

• 200 OK

• 400 Bad Request : Erreur technique ou fonctionnelle

• 401 xxxxxxxxx : Erreur de sécurité (voir section :  Sécurité et authentification)

• 500 Internal Server : Vérifier la casse de l’entité dans l’URL