oData entity management

User management

Description of properties

Key:

Navigable property

Search users

The name of the entity is "Users”

To retrieve the list of users, specify the name of the entity after the entry point.

/odata-api/Users

Warning: it is recommended to specify the option $top to limit the number of elements returned.

Example: /odata-api/Users?$top=20

The send method must be GET. To search for a user by their name, use the filter option $filter.

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

To simply return a list of properties , use the operator $select

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

Obtain information on a user

To return all information on a specific user, you can provide the ID as follows.

/odata-api/Users(327680)

To return a single property, proceed as follows.

/odata-api/Users(327680)/Name

Otherwise, use the operator $select to specify the properties required.

Example to return user roles (role and domain name)

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

Create a user

• To create an entity, the request must be sent with the method “POST” and specify the and specify the modifiable properties of the entity in the body in JSON format.

• You must specify at least the mandatory properties and only definer modifiable properties.

• The URL must contain the name of the entity: “User”.

The following request creates a new user with the main domain with the Syfadis ID 131072 and a secondary domain with the ID 131079.

The created entity contents is returned. Note that the navigation properties are not included:

Only the modifiable properties can be specified.

If the password is not specified in the JSON and qu’il est mandatory for the creation of a user, you can generate it automatically by setting Automatic password generation to True (in Configuration > Directory > Login and password).

Possible responses:

• 201 Created: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 500 Internal Server: Check the entity case in the URL.

Modify a user

To modify an entity, the request must be sent with the method “PATCH" and specify the modifiable properties to update in the body of the JSON format.

We recommend using PATCH rather than PUT for entity updates.

If you want to return all entity properties, after updating you can add the preference of the type "return=representation" in the request header as in the example below. This enables you to retrieve all object properties after modifiying the response and reduce the load on the server by limiting the number of requests.

The following request modifies the code property with the Syfadis ID 327680. The updated entity contents are returned:

Only modifiable properties can be changed.

Possible responses:

• 200 OK: OK (Header with return based on a representation).

• 204 No Content: OK (No representation).

• 400 Bad Request: Technical or functional error.

• 404 NotFound: Record inexistant.

• 500 Internal Server: Check the entity case in the URL.

Archive a user

To archive an entity, the request must be sent with the method “DELETE” that targets an entity

The following request archives the user with the Syfadis ID 327680:

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx : Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server: Check the entity case in the URL.

Restore a user

To restore an entity, call the function Services.Restore.

The following request restores the user with the Syfadis ID 327680.

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

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server: Check the entity case in the URL.

Add a role to a user

To add a role to a user, the request must be sent with the method “POST” and call the action Services.AddUserRole on a target user. This user must specify the properties listed in the table below in JSON format.

You must specify at least the manadatory minimum the mandatory properties.

The action to call is: Services.AddUserRole

The following request adds the role with the Syfadis ID 229378 on the domain with the Syfadis ID 163840 for the user with the Syfadis ID 327680

Possible responses:

• 201 Created: OK (the response contains a UserRole entity).

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx : Security error (see Security and authentication).

• 500 Internal Server : Check the entity case in the URL.

It is not currently possible to add a role when creating the user.

Remove a role from a user

To remove a role from a user, the request must be sent with the method "POST" and call the action Services.RemoveUserRole on a targetted user. You must specify the properties listed in the following table in the body of the JSON format.

You must at least specify mandatory properties.

The action to call is: Services.RemoveUserRole

The following request removes the role created in the section Add a role to a user.

Define the user profile image

To add a user profile image, the request must be sent with the method "POST" and call the action Services.SetUserPicture on a targeted user. This must specify the properties listed in the following table in the body of the JSON format.

You must at least specify mandatory properties.

The action to call is: Services.SetUserPicture

The following request adds a user profile image with the Syfadis ID 126976000:

*** REQUEST ***

Http Method : POST

Http Headers :

Authorization : Basic c2ZlOjFCb3VnYWludmlsbCFlcg==

Http URI :

https://xxxxxxxxx/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

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 500 Internal Server: Check the entity case in the URL.

It is currently not possible to add a profile image when creating the user.

Manage training providers

Description of the properties

This entity is called TrainingProvider. It is associated with the objects Training and Sessiontraining:

Manage groups

The groups represent a group of entities structured in the same way, and which allows you to regroup users. The qualified entities are:

Description of properties

Key:

Navigable property

Search groups

To return the group list, simply specify the name of the entity after the entry point.

/odata-api/Domain

Warning, we recommend you specify the option $top to limit the number of elements returned.

The send method must be GET.

To search for a group by its name, use the filter option $filter.

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

Obtain information about a group

To obtain all information about a specific group, you can specify its ID as follows.

/odata-api/Domains(163840)

Create a group

To create an entity, the request must be sent with the method "POST" and specify the modifiable properties of the entity in the body of the JSON format.

You must specify at least the mandatory properties and only define the modifiable properties. The URL must include the name of the entity - one of the values provided in the start of this section.

The following request creates a structure called FuturSkill. The created entity response is returned:

Only modifiable properties can be specified.

Possible responses:

• 201 Created: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx : Security error (see Security and authentication).

• 500 Internal Server : Check the entity case in the URL.

Modify a group

To modify an entity, the request must be sent with the method PATCH and specify the modifiable properties to update in the body of the JSON format.

We recommend you use PATCH rather than PUT for the entity update.

If you want to retrieve all entity properties, after the update you can add the preference type "return=representation" in the header of the request as in the example below. This enables you to retrieve all object properties after the modification in the response and contributes to reducing the load on the server and limiting the number requests.

The following request modifies the property code for the structure to have the Syfadis ID 2228224. The updated entity response is returned:

Only the modifiable properties can be modified.

Possible responses:

• 200 OK: OK (Header with return based on a representation).

• 204 No Content: OK (No representation).

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server : Check the entity case in the URL.

Archive a group

To archive an entity, the request must be sent with the method DELETE targeting an entity.

The following request archives the structure with the Syfadis ID 2228224.

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx : Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server: Check the entity case in the URL.

Restore a group

To restore an entity, call the function Services.Restore. The following request restores the structure with the Syfadis ID 2228224.

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

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server: Check the entity case in the URL.

Manage sessions

There are 2 types of session in Syfadis.

• Training Sessions

• Evaluation Sessions

Training session

Key : Navigable property

Evaluation session

Key:

Navigable Property

Search sessions

To retrieve the list of sessions, simply specify the name of the entity after the entry point.

/odata-api/ TrainingSessions

/odata-api/ EvaluationSessions

Warning, we recommend you specify the option $top to limit the number of elements returned.

The send method must be GET.

To search for a session by its name, use the filter option $filter.

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

Obtain information on a session

To retrieve all information on a given session, you can specify the ID as follows.

/odata-api/EvaluationSessions(2850816)

Search for in-person or virtual class sessions

The name of the entity to request is MeetingSessions

/odata-api/MeetingSessions

The send method must be GET.

To obtain the list of in-person sessions, use the filter option$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": "In-person class",

           "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"

       }

   ]

}

Possible responses:

• 200 OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 500 Internal Server: Check the entity case in the URL.

To obtain the list of virtual class sessions, use the $filter option.

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

Obtain information on in-person or virtual classes

To retrieve all data on a specific session, including training locations and classroom, use the following request.

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": "In-person class",

           "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",

               "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"

               }

           ]

       }

   ]

}

Possible responses:

• 200 OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 500 Internal Server: Check the entity case in the URL.

Create a session

To create a session type entity, the request must be sent with the method "POST" and call the action Service.Create. This must specify the modifiable properties of the entity in the body of the JSON format.

You must specify at least the mandatory properties and only define the modifiable properties. The URL must contain the name of the entity (one of the cvalues indicated at the start of this section).

Possible responses:

• 201 Created: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 500 Internal Server: Check the entity case in the URL.

Training session

In addition to the modifiable properties, you need to at least specify the following mandatory properties:

The action to call is: Services.Create

The following request creates a training session:

Evaluation session

In addition to the modifiable properties, you need to at least specify the following mandatory properties:

The action to call is: Services.Create

Modify properties

Modify modifiable properties

To modify the modifiable properties of an entity, the request must be sent with the method PATCH and specify the modifiable properties to update, in the body of the JSON format.

We recommend you use PATCH rather than PUT to update the entity.

If you wish to retrieve all entity properties, after the update you can add the preference return=representation in the header of the request as shown in the following example. This enables you to retrieve all object properties after the modification in the reponse and contributes to reducing the server load and limiting the number of requests.

The following request modifies the code property for the training session with the Syfadis ID 2850818. In response, the contents of the entity is returned:

Possible responses:

• 200 OK: OK (Header with return based on a representation).

• 204 No Content: OK (No representation).

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server : Check the entity case in the URL.

Modify the dates (training)

Only available for the training session.

To modify the session start and end dates, the request must be sent with the method "POST" and call the action Services.Update. This request must specify the properties listed in the following table in the body of the JSON format.

You must at least specify mandatory properties.

The action to call is: Services.Update.

The following request extends the session end date:

Possible responses:

• 200 OK: OK (Header with return based on a representation).

• 204 No Content: OK (No representation).

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see section Security and authentication).

• 500 Internal Server: Check the entity case in the URL.

Modify the tutors and locations (training)

Only available for training sessions.

To modify the session start and end dates, the request must be sent with the method "POST" and call the action Services.Update. This request must specify the properties listed in the following table in the body of the JSON format.

You must at least specify mandatory properties.

Tutors are only assigned to root elements.

The action to call is: Services.Update.

The following request, add 2 tutors to the session:

Possible responses:

• 200 OK: OK (Header with return based on a representation).

• 204 No Content: OK (No representation).

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 500 Internal Server: Check the entity case in the URL.

Attendance

Only in the framework that contain in-person sessions (MeetingSession).

To manage attendance of a user in a MeetingSession, the request must be sent with the method "POST" and call the action Services.Attendance. This request must specify the properties listed in the following table in the body of the JSON format.

You must specify the mandatory properties.

Tutors are only assigned to root elements.

The action to call is: Services.Attendance.

The following request, registration attendance:

Tutor attendance

Only for training that contain in-presence sessions (MeetingSession).

To manage tutor attendance, the request must be sent with the method "POST" and call the action Services.TutorAttendance. This request must specify the properties listed in the following table in the body of the JSON format.

You must specify the mandatory properties.

The action to call is: Services.TutorAttendance

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error.

Retrieve attendance information of an in-presence session

To retrieve attendance data for an in-person session, a virtual class or other, request the entity TraineePresenceViews.

Navigable Property

Example of a request to return information on the attendance of an in-person element:

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

The entity AbstractCourseComponentRun navigable from TraineePresenceViews contains information on the in-presence element:

Deposit documents

Only in the framework of training courses containing in-presence sessions (MeetingSession)

To deposit documents in the MeetingSession, the request must be sent with the method "POST" and call the action Services.AttendanceSheet. This must specify the properties listed in the following table in the body of the JSON format.

You must specify the mandatory properties.

The action to call is : Services.AttendanceSheet

The following request enables you to deposit a file in the session:

Archive a session

To archive an entity, the request must be sent with the method “DELETE” targeting an entity.

The following request archives the training session with the Syfadis ID 2850818.

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error

• 404 NotFound: Record inexistant

• 401 xxxxxxxxx: Security error (see section Security and authentication)

• 500 Internal Server: Check the entity case in the URL

Cancel a session

To cancel a session, the request must be sent with the method "POST" and call the action Services.Cancel.

Example to cancel the session with the Syfadis ID 1234:

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

{

"CancelReason": "3",

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

"Chargeable": true

}

These are the properties to send to the action:

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error

• 404 NotFound: Record inexistant

• 401 xxxxxxxxx : Security error (see section: Security and authentication)

• 500 Internal Server : Check the entity case in the URL

Manage registrations

There are 2 types of registrations in Syfadis.

• Session registrations (Trainees)

• Evaluation registrations (EvaluationTrainees)

Training registrations

Key :

Navigable property

Evaluation registration

Key:

Navigable property

Search for registrations

To retrieve registration list, simply specify the name of the entity after the entry point.

/odata-api/ Trainees

/odata-api/ EvaluationTrainees

IMPORTANT, we recommend the option $top to limit the number of elements returned.

The send method must be GET. To search for a user registration.

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

Obtain registration information

To retrieve specific registration data, you can specify its ID as follows:

/odata-api/Trainee(2916356)

Create a registration

To create an entity, the request must be sent with the method "POST" and call the action Services.Register. This request must specify the modifiable properties of the entity in the body of the JSON format.

You must specify at least the mandatory properties and only define properties which are modifiable.

The URL must contain the name of the entity with one of the values indicated at the start of the section. In addition to the modifiable properties, you need to at least specify the following mandatory properties:

The action to call is : Services.Register.

The following request creates a training registration.

Possible responses:

• 201 Created: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 404 Not Found: SessionId or UserId invalid.

• 500 Internal Server: Check the entity case in the URL.

Modify a registration

Modification of modifiable properties. Updating registration properties is not currently possible.

Modify training dates

• Only available for training registrations

To modify registration start and end dates, the request must be sent with the method "POST" and call the action Services.ChangeDates. This request must specify the properties listed in the following table in the body of the JSON format.

You must at least specify mandatory properties.

The action to call is : Services.ChangeDates

The following request shifts the registration in time:

Possible responses:

• 200 OK: OK (Header with return based on a representation).

• 204 No Content: OK (No representation).

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server: Check the entity case in the URL.

Modify a training session

• Only available for training registrations

To modify the session registration, the request must be sent with the method "POST" and call the action Service.ChangeSession. This request must specify the properties listed in the following table in the body of the JSON format.

You must at least specify mandatory properties.

The action to call is: Services.ChangeSession

The following request changes the session registration:

Possible responses:

• 200 OK: OK (Header with return based on a representation).

• 204 No Content: OK (No representation).

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server: Check the entity case in the URL.

Archive a registration

To archive an entity, the request must be sent with the method "POST" and call the action Services.Unregister. This request must specify the properties listed in the following table in the body of the JSON format.

You must at least specify mandatory properties.

Only one of these properties must be specified.

The URL must contain the name of the entity (as indicated at the start of this section).

The action to call is: Services.Unregister.

The following request archives the training registration with the Syfadis ID 2916366.

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx : Security error (see section Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server : Check the entity case in the URL.

Training/Evaluation management

• The Training courses

• The Evaluations

Description of properties

Training courses

Key:

Navigable property

Evaluations

Key:

Navigable property

Search trainings/evaluations

To retur, the list of trainings or evaluations, simply specify the name of the entity after the entry point.

/odata-api/Trainings

/odata-api/Evaluations

IMPORTANT: we recommend you specify the option $top to limit the number of elements returned.

The send method must be GET

To search for a training/evaluation by its name, use the filter option $filter.

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

Obtain information on training/evaluation

To retrieve all data on training/evaluation, you can specify its id as follows.

/odata-api/Evaluations(753673)

Create a training/evaluation

To create an entity, the request must be sent with the method "POST" and specify the modifiable properties of the entity in the body of the JSON format.

You must specify at least the mandatory properties and can only define modifiable properties.

The URL must contain the name of the entity - at least one of the values given at the start of this section.

The following request creates a training course called FuturSkill. In response, the contents of the created entity is returned:

Possible responses:

• 201 Created: OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx : Security error (see section Security and authentication).

• 500 Internal Server : Check the entity case in the URL.

Modify a training/evaluation

To modify an entity, the request must be sent with the method PATCH and specify the modifiable properties to update, in the body of the JSON format.

We recommend using the PATCH rather than PUT for entity updates.

If you wish to retrieve all entity properties, after the update you can add the preference of the type "return=representation" in the header of the request as in the following example. This enables you to retrieve all object properties after the modification in the response and therefore contributes to reducing server load and limiting the number of requests.

The following request modifies the properties name and code for the training with the Syfadis ID 2686977.

In response, the contents of the updated entity is returned:

Possible responses:

• 200 OK: OK (Header with return based on a representation).

• 204 No Content: OK (No representation).

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx : Security error (see Security and authentication).

• 404 NotFound: Record inexistant.

• 500 Internal Server: Check the entity case in the URL.

Archive a training/evaluation

To archive an entity, the request must be sent with the method DELETE targeting an entity.

The following request archives the training course with the Syfadis ID 2686977:

Possible responses:

• 204 No Content: OK

• 400 Bad Request: Technical or functional error

• 401 xxxxxxxxx: Security error (see section Security and authentication)

• 404 NotFound: Record inexistant

• 500 Internal Server: Check the entity case in the URL

Social tracking management

Description of properties

Search for social tracking elements

The name of the entity is TrackingViews.

To retrieve social element follow up information for a social group or a training session, simply specify the name of the entity after the entry point.

/odata-api/TrackingViews

IMPORTANT: We recommend you specify the option $top to limit the number of elements returned.

The send method must be GET

• To search for specific session data, use the filter option $filter.

• To return user data for example, use the expand option $expand.

• To select other returned data, use the select option $select.

Here is an example of a request enabling social tracking searches for the session with the code SESS_TEST, returning the time, the action type and the user name:

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

Manage training/evaluation ratings

Description of properties:

Search ratings

The name of the entity is ItemRatings.

To retrieve ratings given to a training course or an evaluation, simply specify the name of the entity after the entry point.

/odata-api/ItemRatings

The send method must be GET.

• To search for specific training or evaluation data use the $filter option. The filter is only possible with an ID or the name of the training/evaluation.

• To select data to retrieve, use the $select option.

Below is a request example enabling a search for a training course with the ID is 143, returning the rating and the user name:

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

Training/evaluation notation

To define user ratings for a given training or evaluation, the request must be sent with the method "POST" and call the action Services.RateCatalogItemForUser. This request must specify the properties listed in the following table in the body of the JSON format.

You must at least specify mandatory properties.

The action to call is : Services.RateCatalogItemForUser

The following request defines a rating of 2 given by the user with the Syfadis ID 126976000 on the training course with the Syfadis ID 51183616:

*** REQUEST ***

Http Method : POST

Http Headers :

Authorization : Basic c2ZlOjFCb3VnYWludmlsbCFlcg==

Http URI :

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

Http body :

{

"UserId" : 126976000,

"CatalogItemId" : 51183616,

"Rate" : 2

}

*** RESPONSE ***

Status : 200 OK

Possible responses:

• 200 OK

• 400 Bad Request: Technical or functional error.

• 401 xxxxxxxxx: Security error (see Security and authentication).

• 500 Internal Server: Check the entity case in the URL.