Passer au contenu principal
GET
Relire le planning de permanence d'une semaine

Autorisations

Authorization
string
header
requis

Token LinkedAPI avec scope externalIntegration. La clé doit avoir un agencyGroup configuré (sinon 400 LinkedAPI agencyGroup is required). Fourni via l'en-tête Authorization: Bearer {linkedAPI_token}. Si la clé a secure === true, l'IP appelante doit être whitelistée (en-tête X-Real-IP), sinon 403 Not authorized to access this resource.

La clé porte aussi un niveau d'accès : en lecture seule, elle n'autorise que les GET ; un POST ou un PATCH renvoie alors 403 Not authorized to access this resource, soit la même réponse qu'une requête sans en-tête Authorization. Voir le guide Authentification.

Paramètres de chemin

agencyId
string
requis

Identifiant de l'agence. Doit appartenir au périmètre autorisé de la clé, sinon 400. Identifiant Mongo (24 caractères hexadécimaux).

Pattern: ^[a-fA-F0-9]{24}$
Exemple:

"618a35a36d932054e195ca0a"

transaction
enum<string>
requis

Type de transaction — un planning de permanence par type. Toute autre valeur répond 404 This route does not exist.

Options disponibles:
sale,
acquisition,
rental

Paramètres de requête

year
integer
requis

Année ISO de la semaine.

Exemple:

2026

weekNumber
integer
requis

Numéro de semaine ISO, de 1 au nombre de semaines de l'année (52, ou 53 les années longues : 2026 en compte 53).

Plage requise: 1 <= x <= 53
Exemple:

37

Réponse

Planning daté de la semaine demandée.

success
boolean
agencyId
string

Identifiant Mongo (24 caractères hexadécimaux).

Pattern: ^[a-fA-F0-9]{24}$
Exemple:

"618a35a36d932054e195ca0a"

transactionType
enum<string>
Options disponibles:
sale,
acquisition,
rental
year
integer
weekNumber
integer
shifts
object[]

Créneaux datés de la semaine demandée. Les créneaux de semaine type (sans date) ne sont pas renvoyés.