Web Services - Mixed schedules for a list of employees

Voir la version française.

Description

Each resource corresponds to the last version of current schedules of a set of employees entered in the parameters or from a list of employees (input file) for a 24-hour day.

URI	<url_de_base>/api/feed/plannings_mixte
Category	http://schemas.holydis.com/tsq/2010#planning_mixte_personnes
Available for writing	No

Specific settings

Setting	Description
idsPersonnes	Filters schedules based on the employee database identifier specified (is not compatible with the parameters datetime-min et datetime-max).
datetime-min	Filters available schedules after or during the specified date (is not compatible with the parameter idsPersonnes).
datetime-max	Filters available schedules before or during the specified date (is not compatible with the parameter idsPersonnes).
planningValid	Filters validated schedules (true) or non-validated schedules (false).

Elements

Element	Description
periode	The time period spanned by the schedule. This period indicates the start and end timestamp (24h). It also indicates the day change time associated with the calendar to which the person is assigned for the date of the schedule. If the person does not have a calendar assignment for that date, this is the default calendar day changeover time of the structure to which the person is assigned. All periods for which there is an schedule are in the time zone of the person's calendar in the period.
planningPersonne+	Schedules of employees on a given day. There can be one or more schedules.

Examples of requests

Reading

Read the last version of schedules for a two employees whose database identifiers are 16004 and 111005 for a given date (13/02/2023)

GET /[URI_de_base]/api/feed/plannings_mixte/2023-02-13?idsPersonnes=16004,111005

Example of XML request results

Example of JSON request results

Read all the last version of schedules validated for the two employees whose database identifier is 16000 and 16007 for a given date (06/23/2022)

GET /[URI_de_base]/api/feed/plannings_mixte/2022-06-23?planningValid=true&idsPersonnes=16000,16007

Read all the last version of schedules not validated for the two employees whose database identifier is 16000 and 16007 for a given date (06/23/2022)

GET /[URI_de_base]/api/feed/plannings_mixte/2022-06-23?planningValid=false&idsPersonnes=16000,16007

Read the last version of schedules for a set of employees (input file) for a given period (from 01/06/2022 to 30/06/2022)

GET /[URI_de_base]/api/feed/plannings_mixte?datetime-min=2022-06-01&datetime-max=2022-06-30

Read the last version of validated schedules for a set of employees (input file) for a given period (from 01/06/2022 to 30/06/2022)

GET /[URI_de_base]/api/feed/plannings_mixte?datetime-min=2022-06-01&datetime-max=2022-06-30&planningValid=true

Read the last version of not validated schedules for a set of employees (input file) for a given period (from 01/06/2022 to 30/06/2022)

GET /[URI_de_base]/api/feed/plannings_mixte?datetime-min=2022-06-01&datetime-max=2022-06-30&planningValid=false

Functional error messages

• Error 400 Date renseignée non valide