Web Services - Roles

Voir la version française.

Description

Each resource is a role.

URI	<url_de_base>/api/feed/roles
Category	http://schemas.holydis.com/tsq/2010#role
Available for writing	Yes

Specific settings

Setting	Description
title	Filters the roles with the specified label.

Elements

Element	Description
title	Label.
description	Description of the role.
equipes	Teams in case of a Supervisor or Manager type.
libelleAffectationStructureNonAutorisee	Label of the structure assignments of employees outside the authorized structures in case of an Application type: Full path of the structure: CHEMIN_COMPLET_STRUCT Unauthorized structure: STRUCT_NON_AUTORISEE
modificationPlannings	Limit the schedule modification in case of an Application type.
dureeModifPlg	If schedule modification limitation is enabled, the duration of this limitation. This is an integer value greater than or equal to 1.
uniteDureeModifPlg	If schedule modification limitation is enabled, unit of limitation (associated with duration). Day: JOUR Week: SEMAINE Month: MOIS
planningsStructureNonAutorisee	Display the schedules of employees outside the authorized structures in case of an Application type.
profilFonctionnalites	Feature profile in case of an Application type.
profilStructuresTaches	Structures, tasks and calendars profile.
typeRole	The role type. Supervisor: RESPONSABLE Manager: GESTIONNAIRE Application: UTILISATEUR

Examples of requests

Reading

Read all roles

GET /[URI_de_base]/api/feed/roles

Read the application type role whose database identifier is 3000

GET /[URI_de_base]/api/feed/roles/3000

Example of request XML results

Example of request JSON results

Read the supervisor type role whose database identifier is 6000

GET /[URI_de_base]/api/feed/roles/6000

Example of request XML results

Example of request JSON results

Read the role whose label is Role_Planificateur

GET /[URI_de_base]/api/feed/roles?title=Role_Planificateur

Writing

Add an application type role with limitation of schedule modifications to 30 days without authorization to view unauthorized structures

POST /[URI_de_base]/api/feed/roles

Example of XML input file

Example of JSON input file

Add an application type role without limitation of schedule modifications with authorization to view unauthorized structures (full path)

POST /[URI_de_base]/api/feed/roles

Example of XML input file

Example of JSON input file

Add a supervisor type role

POST /[URI_de_base]/api/feed/roles

Example of XML input file

Example of JSON input file

Modify a role whose database identifier is 6000

PUT /[URI_de_base]/api/feed/roles/6000

Delete the role whose database identifier is 6000

DELETE /[URI_de_base]/api/feed/roles/6000

Functional error messages

• Error 400 Le rôle ne peut être supprimé car il est utilisé.
• Error 400 Le libellé doit être renseigné.
• Error 400 Le libellé [LIBELLE] est déjà utilisé pour un autre rôle.
• Error 400 Le type rôle doit être renseigné.
• Error 400 Le profil structures, tâches et calendriers doit être renseigné.
• Error 400 Le profil fonctionnalités doit être renseigné.
• Error 400 L'équipe doit être renseignée.