Obtenir la liste des agences
Obtenir la liste des agences rattachées à un client.
➤ Cas d'usage
Ce service renvoie la liste des agences utilisables au sein de la demande de caution pour un client.
Le SIREN passé en paramètre devra faire partie de la structure du SIREN de l'entreprise à l'origine de cet appel.
Ce service prend en paramètre le SIREN du client et renvoie en réponse une liste contenant les informations suivantes :
- Id technique de l'agence.
- Description courte de l'agence.
➤ Prérequis
Pour procéder à cette requête, il est nécessaire de remplir les prérequis d’éligibilité et d'avoir récupéré le jeton d'accès (voir la rubrique "Vue d'ensemble" > "Récupération d'un jeton").
➤ Exemple
Requête
GET /v1/clientBranches/search/bySiren
Résultat
Status code : 200
Description : La liste des agences répertoriées pour le SIREN passé en paramètre de la requête.
L'élément identification.clientBranchId sera à utiliser au sein de la demande de caution pour indiquer l'agence pour laquelle sera faite la demande.
Body
"items": [ { "identification": { "clientBranchId": "string" }, "identity": { "clientBranchLabel": "string" } } ] } |
Status code : 400
Description : l'erreur 400 "Bad request" sera retournée si le paramètre SIREN n'est pas
correct dans la requête.
Body
{ "errors": [ { "code": "string", "message": "string", "attribute": "string", "additionalInformation": "string" } ] } |
Status code : 500
Description : Internal Server Error.
Body
{ "errors": [ { "code": "string", "message": "string", "attribute": "string", "additionalInformation": "string" } ] } |
Status code : 503
Description : Internal Unavailable.
Body
{ "errors": [ { "code": "string", "message": "string", "attribute": "string", "additionalInformation": "string" } ] } |