Web Services - Les personnes

Dernière mise à jour : 23 janvier 2025 10:15

Description

Chaque ressource est une personne et contient ses informations administratives.

URI	<url_de_base>/api/feed/personnes
Catégorie	http://schemas.holydis.com/tsq/2010#personne
Disponible en écriture	Oui

Paramètres spécifiques

Paramètre	Description
matricule	Filtre les personnes avec le matricule spécifié. Ce paramètre peut être utilisé seul ou combiné à equipeId.
equipeId	Filtre les personnes rattachées à l'équipe spécifiée. Ce paramètre peut être utilisé seul ou combiné à matricule.
structureId	Filtre les personnes rattachées à la structure. Ce paramètre peut être utilisé seul, combiné à dateRef, combiné à dateRef + avecContrat, combiné à dateMinRef + dateMaxRef ou encore combiné à dateMinRef + dateMaxRef + avecContrat.
dateRef	Filtre les personnes rattachées à la structure spécifiée (dans le paramètre structureId) à la date spécifiée.
codeExterneAffectationContrat	Filtre les personnes dont le code externe d'affectation de contrat est spécifié.
dateMinRef	Filtre les personnes ayant un contrat actif ou bien étant rattachés à une structure après la date spécifiée. Ce paramètre doit être combiné à structureId ou bien avecContrat. Il peut être combiné à dateMaxRef.
dateMaxRef	Filtre les personnes ayant un contrat actif ou bien étant rattachés à une structure avant la date spécifiée. Ce paramètre doit être combiné à structureId ou bien avecContrat. Il peut être combiné à dateMinRef.
avecContrat	Filtre les personnes ayant un contrat actif (true) ou pas de contrat actif (false). Ce paramètre peut être utilisé seul, combiné à structureId, combiné à dateRef, ou encore combiné à dateMinRef + dateMaxRef.

Eléments

Elément	Description	En écriture
nom	Le nom.	Obligatoire
prenom	Le prénom.
matricule?	Le matricule.	Obligatoire
matriculePaye?	Le matricule paie.
adresse?	L'adresse.
telFixe?	Le téléphone fixe.
telMobile?	Le téléphone mobile.
noSecuriteSociale?	Le numéro de sécurité sociale n'est pas disponible dans Timesquare. Cependant, il est encore présent dans la base de données. C'est pourquoi il est possible qu'une migration depuis Timesquare V1 puisse expliquer la valorisation de ce champ.
email?	L'email.
sexe	Le sexe. Les codes disponibles sont les suivants : Féminin F Masculin M Non renseigné NR	Par défaut, c'est NR.
situationFamille	La situation de famille. Par défaut, les codes sont les suivants : Célibataire CB Divorcé D Marié M Non renseignée NR Veuf(ve) V Vie maritale VM	Par défaut, c'est NR.
Origine	L'origine de la création de la personne (exemple : Timesquare, Flatchr, Staff & Go, etc.).	Par défaut, c'est Timesquare.
idOrigine	L'identifiant de l'origine de la création de la personne.
idExterne	L'identifiant Staff & Go. Cet identifiant doit être unique.
nbEnfants?	Le nombre d'enfants.
equipe?	L'équipe à laquelle elle appartient.
gtaIsActive	La GTA est activée pour cette personne.
identifiant?	L'identifiant.
regroupementPersonne?	L'identifiant de regroupement.
dateNaissance?	La date de naissance.
divers1?	Propriété "divers 1".
divers2?	Propriété "divers 2".
divers3?	Propriété "divers 3".
divers4?	Propriété "divers 4".

Exemples de requêtes

Lecture

Lire toutes les personnes

GET /[URI_de_base]/api/feed/personnes

Lire la personne dont l’identifiant en base est 16000

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

Exemple de résultat XML de la requête

Exemple de résultat JSON de la requête

Lire la personne dont le matricule est 9876543210

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

Lire les personnes rattachées à l’équipe dont l’identifiant en base est 12

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

Lire les personnes dont le matricule est 9876543210 et rattachées à l’équipe dont l’identifiant en base est 12

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

Lire les personnes rattachées à la structure dont l’identifiant en base est 11000 sans notion de date

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

Lire les personnes rattachées à la structure dont l’identifiant en base est 11000 à la date du 10/02/2022

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

Lire les personnes rattachées à la structure dont l’identifiant en base est 11000 à la date du 10/02/2022 ayant un contrat actif

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

Lire les personnes rattachées à la structure dont l’identifiant en base est 11000 à la date du 10/02/2022 n'ayant pas de contrat actif

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

Lire les personnes rattachées à la structure dont l’identifiant en base est 11000 entre le 01/01/2022 et le 31/01/2022

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

Lire les personnes rattachées à la structure dont l’identifiant en base est 11000 entre le 01/01/2022 et le 31/01/2022 ayant un contrat actif

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

Lire les personnes rattachées à la structure dont l’identifiant en base est 11000 entre le 01/01/2022 et le 31/01/2022 n'ayant pas de contrat actif

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

Lire les personnes ayant un contrat actif

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

Lire les personnes n'ayant pas de contrat actif

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

Lire les personnes ayant un contrat actif entre le 01/01/2022 et le 31/01/2022

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

Lire les personnes n'ayant pas de contrat actif entre le 01/01/2022 et le 31/01/2022

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

Lire les personnes ayant un contrat actif à la date du 10/02/2022

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

Lire les personnes n'ayant pas de contrat actif à la date du 10/02/2022

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

Lire les personnes dont le code externe d'affectation de contrat est ABCDE

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

Ecriture

Ajouter une personne

POST /[URI_de_base]/api/feed/personnes

Exemple de fichier XML en entrée

Exemple de fichier JSON en entrée

Modifier la personne dont l’identifiant en base est 19000

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

Supprimer la personne dont l’identifiant en base est 19000

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

Messages d'erreur fonctionnels

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

Mots clés :

Web Services - Les personnes

View the English version.

Description

Chaque ressource est une personne et contient ses informations administratives.

URI	<url_de_base>/api/feed/personnes
Catégorie	http://schemas.holydis.com/tsq/2010#personne
Disponible en écriture	Oui

Paramètres spécifiques

Paramètre	Description
matricule	Filtre les personnes avec le matricule spécifié. Ce paramètre peut être utilisé seul ou combiné à equipeId.
equipeId	Filtre les personnes rattachées à l'équipe spécifiée. Ce paramètre peut être utilisé seul ou combiné à matricule.
structureId	Filtre les personnes rattachées à la structure. Ce paramètre peut être utilisé seul, combiné à dateRef, combiné à dateRef + avecContrat, combiné à dateMinRef + dateMaxRef ou encore combiné à dateMinRef + dateMaxRef + avecContrat.
dateRef	Filtre les personnes rattachées à la structure spécifiée (dans le paramètre structureId) à la date spécifiée.
codeExterneAffectationContrat	Filtre les personnes dont le code externe d'affectation de contrat est spécifié.
dateMinRef	Filtre les personnes ayant un contrat actif ou bien étant rattachés à une structure après la date spécifiée. Ce paramètre doit être combiné à structureId ou bien avecContrat. Il peut être combiné à dateMaxRef.
dateMaxRef	Filtre les personnes ayant un contrat actif ou bien étant rattachés à une structure avant la date spécifiée. Ce paramètre doit être combiné à structureId ou bien avecContrat. Il peut être combiné à dateMinRef.
avecContrat	Filtre les personnes ayant un contrat actif (true) ou pas de contrat actif (false). Ce paramètre peut être utilisé seul, combiné à structureId, combiné à dateRef, ou encore combiné à dateMinRef + dateMaxRef.

Eléments

Elément	Description	En écriture
nom	Le nom.	Obligatoire
prenom	Le prénom.
matricule?	Le matricule.	Obligatoire
matriculePaye?	Le matricule paie.
adresse?	L'adresse.
telFixe?	Le téléphone fixe.
telMobile?	Le téléphone mobile.
noSecuriteSociale?	Le numéro de sécurité sociale n'est pas disponible dans Timesquare. Cependant, il est encore présent dans la base de données. C'est pourquoi il est possible qu'une migration depuis Timesquare V1 puisse expliquer la valorisation de ce champ.
email?	L'email.
sexe	Le sexe. Les codes disponibles sont les suivants : Féminin F Masculin M Non renseigné NR	Par défaut, c'est NR.
situationFamille	La situation de famille. Par défaut, les codes sont les suivants : Célibataire CB Divorcé D Marié M Non renseignée NR Veuf(ve) V Vie maritale VM	Par défaut, c'est NR.
Origine	L'origine de la création de la personne (exemple : Timesquare, Flatchr, Staff & Go, etc.).	Par défaut, c'est Timesquare.
idOrigine	L'identifiant de l'origine de la création de la personne.
idExterne	L'identifiant Staff & Go. Cet identifiant doit être unique.
nbEnfants?	Le nombre d'enfants.
equipe?	L'équipe à laquelle elle appartient.
gtaIsActive	La GTA est activée pour cette personne.
identifiant?	L'identifiant.
regroupementPersonne?	L'identifiant de regroupement.
dateNaissance?	La date de naissance.
divers1?	Propriété "divers 1".
divers2?	Propriété "divers 2".
divers3?	Propriété "divers 3".
divers4?	Propriété "divers 4".