Web Services - Schedule patterns

Voir la version française.

Description

Each resource is a schedule pattern.

URI	<url_de_base>/api/feed/modelesHoraires
Category	http://schemas.holydis.com/tsq/2010#modeleHoraire
Available for writing	Non

Specific settings

Setting	Description
idStructure	Filters schedule patterns created on the specified database identifier structure.
idPersonne	Filters schedule patterns created on the specified database identifier employee.
TypeModele	Filters schedule patterns of the specified type (QUOTIDIEN for daily, HEBDOMADAIRE for weekly, PERIODIQUE for periodic).

Elements

Element	Description
title	Label.
code	Code.
calendrier	Calendar of the schedule pattern.
dispoBibHor?	Available for SPL?
dispoPlannings?	Available for schedules?
nbJours	Number of days in the schedule pattern.
actif?	Active or not.
bornesVariables?	Pattern with variable limits?
personne	If the schedule is created on an employee: identifier of the employee.
structure	If the schedule is created on a structure: identifier of the structure.

Examples of requests

Reading

Read all schedule patterns

GET /[URI_de_base]/api/feed/modelesHoraires

Read the schedule pattern whose database identifier is 12000

GET /[URI_de_base]/api/feed/modelesHoraires/12000

Example of XML request results

Example of JSON request results

Read all schedule patterns created on the structure whose database identifier is 11000

GET /[URI_de_base]/api/feed/modelesHoraires?idStructure=11000

Read all schedule patterns created on the employee whose database identifier is 16000

GET /[URI_de_base]/api/feed/modelesHoraires?idPersonne=16000

Read all daily schedule patterns

GET /[URI_de_base]/api/feed/modelesHoraires?typeModele=QUOTIDIEN

Read all weekly schedule patterns
 

GET /[URI_de_base]/api/feed/modelesHoraires?typeModele=HEBDOMADAIRE

Read all periodic schedule patterns

GET /[URI_de_base]/api/feed/modelesHoraires?typeModele=PERIODIQUE