Web Services - Employees

Description

Each resource is a person and contains their administrative information.

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

Specific settings

Setting	Description
matricule	Filters employees with the specified employee ID. This setting can be used alone or combined with equipeId.
equipeId	Filters employees from the specified team. This setting can be used alone or combined with matricule.
structureId	Filters employees attached to the specified structure identifier. This setting can be used alone, combined with dateRef, combined with dateRef + avecContrat, combined with dateMinRef + dateMaxRef or combined with dateMinRef + dateMaxRef + avecContrat.
structureCode	Filters employees attached to the specified structure code. This setting can be used alone, combined with dateRef, combined with dateRef + avecContrat, combined with dateMinRef + dateMaxRef or combined with dateMinRef + dateMaxRef + avecContrat.
dateRef	Filters employees attached to the specified structure (in the structureId setting) at the specified date.
codeExterneAffectationContrat	Filters employees whose contract assignment external code is specified.
dateMinRef	Filters employees with an active contract or attached to the specified structure after the specified date. This setting can be used combined with structureId or avecContrat. It can be combined with dateMaxRef.
dateMaxRef	Filters employees with an active contract or attached to the specified structure before the specified date. This setting can be used combined with structureId or avecContrat. It can be combined with dateMinRef.
avecContrat	Filters employees with an active contract (true) or no contact at all (false). This setting can be used alone, combined with structureId, combined with dateRef, or combined with dateMinRef + dateMaxRef.

Elements

Element	Description	In writing mode
nom	Name.	Mandatory
prenom	First name.
matricule?	Employee ID.	Mandatory
matriculePaye?	Payroll number.
adresse?	Address.
telFixe?	Land phone.
telMobile?	Mobile telephone.
noSecuriteSociale?	The social security number is not available in Timesquare. However, it is still present in the database. This is why it is possible that a migration from Timesquare V1 could explain the valuation of this field.
email?	E-mail.
sexe	Gender. The codes available are: Female F Male M Unspecified NR	By default, it's NR.
situationFamille	Family situation. The codes available are: Single CB Divorced D Married M Unspecified NR Widower V Marital life VM	By default, it's NR.
Origine	The origin of the creation of the employee (example: Timesquare, Flatchr, Staff & Go, etc.).	By default, it's Timesquare.
idOrigine	The origin identifier of the creation of the employee.
idExterne	Staff & Go identifier. This identifier must be unique.
nbEnfants?	Number of children.
equipe?	Team to which belongs.
gtaIsActive	T&A is active for this employee.
identifiant?	Identifier.
regroupementPersonne?	Grouping.
dateNaissance?	Date of birth.
divers1?	Diverse 1.
divers2?	Diverse 2.
divers3?	Diverse 3.
divers4?	Diverse 4.
autoPlanificationActive	Indicates that the employee is self-planned.
dateAnciennete	Seniority date.

Examples of requests

Reading

Read all employees

GET /[URI_de_base]/api/feed/personnes

Read the employee whose database identifier is 16000

GET /[URI_de_base]/api/feed/personnes/16000

Example of XML request results

Example of JSON request results

Read the employee whose ID employee is 9876543210

GET /[URI_de_base]/api/feed/personnes?matricule=9876543210

Read the employees attached to the team whose database identifier is 12

GET /[URI_de_base]/api/feed/personnes?equipeId=12

Read the employee whose ID employee is 9876543210 and assigned to the team whose database identifier is 12

GET /[URI_de_base]/api/feed/personnes?matricule=9876543210&equipeId=12

Read the employees assigned to the structure whose database identifier is 11000 without any date information

GET /[URI_de_base]/api/feed/personnes?structureId=11000

Read the employees assigned to the structure whose database identifier is 11000 on 10/02/2022

GET /[URI_de_base]/api/feed/personnes?structureId=11000&dateRef=2022-02-10

Read the employees assigned to the structure whose database identifier is 11000 on 10/02/2022 with an active contract

GET /[URI_de_base]/api/feed/personnes?structureId=11000&dateRef=2022-02-10&avecContrat=true

Read the employees assigned to the structure whose database identifier is 11000 on 10/02/2022 with no active contract

GET /[URI_de_base]/api/feed/personnes?structureId=11000&dateRef=2022-02-10&avecContrat=false

Read the employees assigned to the structure whose database identifier is 11000 between 10/02/2022 and 31/01/2022

GET /[URI_de_base]/api/feed/personnes?structureId=11000&dateMinRef=2022-01-01&dateMaxRef=2022-01-31

Read the employees assigned to the structure whose database identifier is 11000 between 10/02/2022 and 31/01/2022 with an active contract

GET /[URI_de_base]/api/feed/personnes?structureId=11000&dateMinRef=2022-01-01&dateMaxRef=2022-01-31&avecContrat=true

Read the employees assigned to the structure whose database identifier is 11000 between 10/02/2022 and 31/01/2022 with no active contract

GET /[URI_de_base]/api/feed/personnes?structureId=11000&dateMinRef=2022-01-01&dateMaxRef=2022-01-31&avecContrat=false

Read the employees assigned to the structure whose code is CATA without any date information

GET /[URI_de_base]/api/feed/personnes?structureCode=CATA

Read the employees assigned to the structure whose code is CATA on 19/05/2026

GET /[URI_de_base]/api/feed/personnes?structureCode=CATA&dateRef=2026-05-19

Read the employees assigned to the structure whose code is CATA on 19/05/2026 with an active contract

GET /[URI_de_base]/api/feed/personnes?structureCode=CATA&dateRef=2026-05-19&avecContrat=true

Read the employees assigned to the structure whose code is CATA on 19/05/2026 with no active contract

GET /[URI_de_base]/api/feed/personnes?structureCode=CATA&dateRef=2026-05-19&avecContrat=false

Read the employees assigned to the structure whose code is CATA between 19/05/2026 and 31/12/2026

GET /[URI_de_base]/api/feed/personnes?structureCode=CATA&dateMinRef=2026-05-19&dateMaxRef=2026-12-31

Read the employees assigned to the structure whose code is CATA between 19/05/2026 and 31/12/2026 with an active contract

GET /[URI_de_base]/api/feed/personnes?structureCode=CATA&dateMinRef=2026-05-19&dateMaxRef=2026-12-31&avecContrat=true

Read the employees assigned to the structure whose code is CATA between 19/05/2026 and 31/12/2026 with no active contract

GET /[URI_de_base]/api/feed/personnes?structureCode=CATA&dateMinRef=2026-05-19&dateMaxRef=2026-12-31&avecContrat=false

Read the employees with an active contract

GET /[URI_de_base]/api/feed/personnes?avecContrat=true

Read the employees with no active contract

GET /[URI_de_base]/api/feed/personnes?avecContrat=false

Read the employees with an active contract between 01/01/2022 and 31/01/2022

GET /[URI_de_base]/api/feed/personnes?avecContrat=true&dateMinRef=2022-01-01&dateMaxRef=2022-01-31

Read the employees with no active contract between 01/01/2022 and 31/01/2022

GET /[URI_de_base]/api/feed/personnes?avecContrat=false&dateMinRef=2022-01-01&dateMaxRef=2022-01-31

Read the employees with an active contract on 10/02/2022

GET /[URI_de_base]/api/feed/personnes?avecContrat=true&dateRef=2022-02-10

Read the employees with no active contract on 10/02/2022

GET /[URI_de_base]/api/feed/personnes?avecContrat=false&dateRef=2022-02-10

Read the employee whose contract assignment external code is 12ABCDE

GET /[URI_de_base]/api/feed/personnes?codeExterneAffectationContrat=ABCDE

Writing

Add an employee

POST /[URI_de_base]/api/feed/personnes

Example of XML input file

Example of JSON input file

Modify the employee whose database identifier is 19000

PUT /[URI_de_base]/api/feed/personnes/19000

Delete the employee whose database identifier is 19000

DELETE /[URI_de_base]/api/feed/personnes/19000

Functional error messages

Error 400 Le matricule renseigné existe
Error 400 L'identifiant externe renseigné existe

Mots clés :

Web Services - Employees

Voir la version française.

Description

Each resource is a person and contains their administrative information.

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

Specific settings

Setting	Description
matricule	Filters employees with the specified employee ID. This setting can be used alone or combined with equipeId.
equipeId	Filters employees from the specified team. This setting can be used alone or combined with matricule.
structureId	Filters employees attached to the specified structure identifier. This setting can be used alone, combined with dateRef, combined with dateRef + avecContrat, combined with dateMinRef + dateMaxRef or combined with dateMinRef + dateMaxRef + avecContrat.
structureCode	Filters employees attached to the specified structure code. This setting can be used alone, combined with dateRef, combined with dateRef + avecContrat, combined with dateMinRef + dateMaxRef or combined with dateMinRef + dateMaxRef + avecContrat.
dateRef	Filters employees attached to the specified structure (in the structureId setting) at the specified date.
codeExterneAffectationContrat	Filters employees whose contract assignment external code is specified.
dateMinRef	Filters employees with an active contract or attached to the specified structure after the specified date. This setting can be used combined with structureId or avecContrat. It can be combined with dateMaxRef.
dateMaxRef	Filters employees with an active contract or attached to the specified structure before the specified date. This setting can be used combined with structureId or avecContrat. It can be combined with dateMinRef.
avecContrat	Filters employees with an active contract (true) or no contact at all (false). This setting can be used alone, combined with structureId, combined with dateRef, or combined with dateMinRef + dateMaxRef.

Elements

Element	Description	In writing mode
nom	Name.	Mandatory
prenom	First name.
matricule?	Employee ID.	Mandatory
matriculePaye?	Payroll number.
adresse?	Address.
telFixe?	Land phone.
telMobile?	Mobile telephone.
noSecuriteSociale?	The social security number is not available in Timesquare. However, it is still present in the database. This is why it is possible that a migration from Timesquare V1 could explain the valuation of this field.
email?	E-mail.
sexe	Gender. The codes available are: Female F Male M Unspecified NR	By default, it's NR.
situationFamille	Family situation. The codes available are: Single CB Divorced D Married M Unspecified NR Widower V Marital life VM	By default, it's NR.
Origine	The origin of the creation of the employee (example: Timesquare, Flatchr, Staff & Go, etc.).	By default, it's Timesquare.
idOrigine	The origin identifier of the creation of the employee.
idExterne	Staff & Go identifier. This identifier must be unique.
nbEnfants?	Number of children.
equipe?	Team to which belongs.
gtaIsActive	T&A is active for this employee.
identifiant?	Identifier.
regroupementPersonne?	Grouping.
dateNaissance?	Date of birth.
divers1?	Diverse 1.
divers2?	Diverse 2.
divers3?	Diverse 3.
divers4?	Diverse 4.
autoPlanificationActive	Indicates that the employee is self-planned.
dateAnciennete	Seniority date.