Absences
Lecture, création, modification, suppression d‘absences via l’API de RDV-Solidarités.

Index

GET /api/v1/absences

Paramètres

  • organisation_id INTEGER - optionnel : filtre les absences retournées pour une seule organisation

Réponse en cas de succès

  • absences : ARRAY[ABSENCE]

Exemple de requête

httpie
curl
1
http 'https://www.rdv-solidarites.fr/api/v1/absences' \
2
access-token:FLXP6G2hIEYhmGe5MpHKfg \
3
client:fySY0UMlNzgbhE8QYhXdkw \
Copied!
1
curl --verbose \
2
--header 'access-token: FLXP6G2hIEYhmGe5MpHKfg' \
3
--header 'client: fySY0UMlNzgbhE8QYhXdkw' \
4
--header 'uid: [email protected]' \
5
'https://www.rdv-solidarites.fr/api/v1/absences'
Copied!

Exemple de réponse

1
HTTP/1.1 200 OK
2
...
3
4
{
5
"absences": [
6
{
7
"agent": {
8
"email": "[email protected]",
9
"first_name": "Martine",
10
"id": 1,
11
"last_name": "VALIDAY"
12
},
13
"end_day": "2021-01-05",
14
"end_time": "08:00:00",
15
"first_day": "2020-12-23",
16
"ical_uid": "[email protected] Solidarités",
17
"id": 14,
18
"organisation": {
19
"departement": "75",
20
"id": 1,
21
"name": "MDS Paris Nord"
22
},
23
"start_time": "08:00:00",
24
"title": "Vacances de Noël"
25
},
26
{
27
...
28
}
29
],
30
"meta": {
31
...
32
}
33
}
Copied!

Consultation

GET /api/v1/absences/:id

Paramètres

  • id: identifiant de l’absence (requis)

Réponse en cas de succès

  • absence: ABSENCE

Exemple de requête

httpie
curl
1
http 'https://www.rdv-solidarites.fr/api/v1/absences/14' \
2
access-token:FLXP6G2hIEYhmGe5MpHKfg \
3
client:fySY0UMlNzgbhE8QYhXdkw \
Copied!
1
curl --verbose \
2
--header 'access-token: FLXP6G2hIEYhmGe5MpHKfg' \
3
--header 'client: fySY0UMlNzgbhE8QYhXdkw' \
4
--header 'uid: [email protected]' \
5
'https://www.rdv-solidarites.fr/api/v1/absences/14'
Copied!

Exemple de réponse

1
HTTP/1.1 200 OK
2
...
3
4
{
5
"absence": {
6
"agent": {
7
"email": "[email protected]",
8
"first_name": "Martine",
9
"id": 1,
10
"last_name": "VALIDAY"
11
},
12
"end_day": "2021-01-05",
13
"end_time": "08:00:00",
14
"first_day": "2020-12-23",
15
"ical_uid": "[email protected] Solidarités",
16
"id": 14,
17
"organisation": {
18
"departement": "75",
19
"id": 1,
20
"name": "MDS Paris Nord"
21
},
22
"start_time": "08:00:00",
23
"title": "Vacances de Noël"
24
}
25
}
Copied!

Création

POST /api/v1/absences

Paramètres

  • organisation_id INTEGER : l'identifiant de l'organisation dans laquelle créer une absence
  • agent_id INTEGER : l'identifiant de l'agent absent
  • agent_email EMAIL: l’email de l’agent absent. agent_emailou agent_id doit être spécifié; si les deux sont présents, agent_id est utilisé.
  • title TEXT : le titre de l’absence
  • first_day DATE : le jour de début de l'absence
  • start_time TIME : l'heure de début de l'absence
  • end_day DATE : le jour de fin de l'absence
  • end_time TIME : l'heure de fin de l'absence
L’API de création d'absence ne permet pour l'instant pas de créer des absences récurrentes.

Réponse

  • absence : ABSENCE : uniquement présent quand l'absence a été créée avec succès. Contient l'absence qui vient d'être créée.

Exemple de requête

httpie
curl
1
http --json POST https://www.rdv-solidarites.fr/api/v1/absences \
2
access-token:FLXP6G2hIEYhmGe5MpHKfg \
3
client:fySY0UMlNzgbhE8QYhXdkw \
5
organisation_id=1 \
6
agent_id=1 \
7
title="Congé parental" \
8
first_day="2020-11-20" \
9
start_time="08:00" \
10
end_day="2020-11-20" \
11
end_time="18:00"
Copied!
1
curl --verbose --request 'POST' \
2
--header 'access-token: FLXP6G2hIEYhmGe5MpHKfg' \
3
--header 'client: fySY0UMlNzgbhE8QYhXdkw' \
4
--header 'uid: [email protected]' \
5
--header 'Content-Type: application/json' \
6
--data '{"agent_id":"1","end_day":"2020-11-20","end_time":"18:00","first_day": "2020-11-20","organisation_id":"1","start_time":"08:00","title":"Congé parental"}' \
7
'https://www.rdv-solidarites.fr/api/v1/absences'
Copied!

Exemple de réponse

1
HTTP/1.1 200 OK
2
...
3
4
{
5
"absence": {
6
"agent": {
7
"email": "[email protected]",
8
"first_name": "Martine",
9
"id": 1,
10
"last_name": "VALIDAY"
11
},
12
"end_day": "2020-11-20",
13
"end_time": "18:00:00",
14
"first_day": "2020-11-20",
15
"ical_uid": "[email protected] Solidarités",
16
"id": 10,
17
"organisation": {
18
"departement": "75",
19
"id": 1,
20
"name": "MDS Paris Nord"
21
},
22
"start_time": "08:00:00",
23
"title": "Congé parental"
24
}
25
}
Copied!

Modification

PUT /api/v1/absences/:id
PATCH /api/v1/absences/:id

Paramètres

  • id: l’identifiant de l’absence
  • title TEXT : le titre de l’absence
  • first_day DATE : le jour de début de l'absence
  • start_time TIME : l'heure de début de l'absence
  • end_day DATE : le jour de fin de l'absence
  • end_time TIME : l'heure de fin de l'absence

Réponse

  • absence : ABSENCE. L’absence modifiée.

Exemple de requête

httpie
curl
1
http --json PATCH https://www.rdv-solidarites.fr/api/v1/absences/10 \
2
access-token:FLXP6G2hIEYhmGe5MpHKfg \
3
client:fySY0UMlNzgbhE8QYhXdkw \
5
title="Congé maladie"
Copied!
1
curl --verbose --request 'PATCH' \
2
--header 'access-token: FLXP6G2hIEYhmGe5MpHKfg' \
3
--header 'client: fySY0UMlNzgbhE8QYhXdkw' \
4
--header 'uid: [email protected]' \
5
--header 'Content-Type: application/json' \
6
--data '{"title":"Congé maladie"}' \
7
'https://www.rdv-solidarites.fr/api/v1/absences/10'
Copied!

Exemple de réponse

1
HTTP/1.1 200 OK
2
...
3
4
{
5
"absence": {
6
"agent": {
7
"email": "[email protected]",
8
"first_name": "Martine",
9
"id": 1,
10
"last_name": "VALIDAY"
11
},
12
"end_day": "2020-11-20",
13
"end_time": "18:00:00",
14
"first_day": "2020-11-20",
15
"ical_uid": "[email protected] Solidarités",
16
"id": 10,
17
"organisation": {
18
"departement": "75",
19
"id": 1,
20
"name": "MDS Paris Nord"
21
},
22
"start_time": "08:00:00",
23
"title": "Congé maladie"
24
}
25
}
Copied!

Suppression

DELETE /api/v1/absences/:id

Paramètres

  • id: l’identifiant de l’absence
Réponse
  • Réponse vide en cas de succès.

Exemple de requête

httpie
curl
1
http DELETE https://www.rdv-solidarites.fr/api/v1/absences/10 \
2
access-token:FLXP6G2hIEYhmGe5MpHKfg \
3
client:fySY0UMlNzgbhE8QYhXdkw \
Copied!
1
curl --verbose --request 'DELETE' \
2
--header 'access-token: FLXP6G2hIEYhmGe5MpHKfg' \
3
--header 'client: fySY0UMlNzgbhE8QYhXdkw' \
4
--header 'uid: [email protected]' \
5
--header 'Content-Type: application/json' \
6
'https://www.rdv-solidarites.fr/api/v1/absences/10'
Copied!

Exemple de réponse

1
HTTP/1.1 204 No Content
2
...
Copied!
Dernière mise à jour 1mo ago
Exporter en PDF
Copier le lien