Mettre à jour une entrée de l'annuaire France PID

PATCH 
/api/v1/companies/:company_id/france/pid/entries/:id

Met en file d'attente une demande de changement pour modifier la date de fin d'effet d'une entrée d'annuaire. L'entrée doit appartenir à l'entreprise indiquée. effective_to_on (DT-7-3-2) est le seul attribut que cette API transmet à l'annuaire : envoyer tout autre attribut est rejeté avec un 422 et aucune demande de changement n'est créée. L'Annexe 3 V1.8 DG-7 autorise également la modification du matricule de la plateforme de réception (DT-7-6) sur une ligne pas encore en vigueur, ce que cette API ne prend pas encore en charge. Pour modifier un attribut d'adressage, mettez fin à la ligne actuelle et enregistrez-en une nouvelle ; pour masquer une ligne qui n'est pas encore en vigueur, utilisez DELETE.

Request

Responses

202

La demande de changement pour mettre à jour l'entrée d'annuaire a été acceptée et mise en file d'attente ; l'opération d'annuaire proprement dite s'exécute de façon asynchrone. La réponse retourne l'identifiant de la demande de changement, pas l'entrée elle-même. Une fois la demande de changement traitée, une lecture de l'entrée retourne le nouvel effective_to_on.

401

La requête ne comportait pas de jeton d'accès (bearer token) OAuth 2.0 valide.

403

Soit le client OAuth ne dispose pas du scope write, soit la fonctionnalité d'annuaire n'est pas activée pour cet espace de travail.

404

Aucune entrée n'existe avec cet ID pour l'entreprise indiquée, ou l'entreprise appartient à un espace de travail auquel le client OAuth authentifié n'a pas accès.

422

La requête a tenté de modifier un attribut que cette API ne transmet pas à l'annuaire, ou la nouvelle date de fin d'effet n'a pas passé la validation. L'objet details du corps de la réponse nomme les attributs en cause ; aucune demande de changement n'est créée.