Obtenir la liste des modèles de texte
Obtenir la liste des modèles de texte rattachés à un contrat.
➤ Cas d'usage
Ce service renvoie la liste des modèles de texte rattachés à un contrat d’un client.
Il prend en paramètre un numéro de contrat CEGC et renvoie en réponse une liste contenant les informations suivantes :
- Identifiant du modèle de texte.
- Description courte du modèle.
- Description longue du modèle.
- Identifiant du type de garantie.
- Description courte du type de la garantie.
- Type de Marché.
➤ 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/bondTemplateTexts/search/byMarketBondContract
Résultat
Status code : 200
Description : La réponse contient un ensemble de modèles de texte utilisables sur le contrat demandé en entrée.
L'élément identification.marketBondTextId contient la valeur à utiliser lors de la demande de caution. Il s'agit de l'identifiant du texte qui sera utilisé pour la caution lors de la demande de caution.
Body
{ "items": [ { "identification": { "marketBondTextId": "string" }, "identity": { "textLabel": "RESTITUTION D'ACOMPTE MARCHE PUBLIC GARANTIE A PREMIERE DEMANDE AVEC ECHEANCE", "textShortLabel": "RA - PUB GAPD AVEC ECH", "warrantTypeId": "string", "warrantTypeShortLabel": "string", "marketType": "string" } ] } |
Status code : 400
Description : l'erreur 400 "Bad request" pourra se produire en cas d'absence du paramètre query marketBondContractId.
Ou si la valeur de ce paramètre n'est pas renseignée.
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" } ] } |