Parametres.General.StructBanque

En bref

8 opérations sur 4 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).

Opérations

Méthode	Chemin	Rôle
GET	/v2/structbanque	Lister les enregistrements
POST	/v2/structbanque	Créer l'enregistrement
PUT	/v2/structbanque	Mettre à jour l'enregistrement
DELETE	/v2/structbanque	Supprimer l'enregistrement
GET	/v2/structbanque/count	Compter les enregistrements
POST	/v2/structbanque/count	Compter les enregistrements
POST	/v2/structbanque/recherche	Rechercher des enregistrements
POST	/v2/structbanque/save	Créer ou mettre à jour l'enregistrement (upsert)

Rôle déduit

La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.

Détail

GET /v2/structbanque

Lister les enregistrements.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
sort	query	string	non	-
where	query	string	non	-

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/structbanque?sort=<sort>&where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/structbanque

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma StructBanqueDto - 11 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/structbanque" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"type": 0, "edi": false, "longueurBanque": 0}'

PUT /v2/structbanque

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma StructBanqueDto - 11 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X PUT "https://<votre-connecteur>/v2/structbanque" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"type": 0, "edi": false, "longueurBanque": 0}'

DELETE /v2/structbanque

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma StructBanqueDto - 11 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X DELETE "https://<votre-connecteur>/v2/structbanque" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"type": 0, "edi": false, "longueurBanque": 0}'

GET /v2/structbanque/count

Compter les enregistrements.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
where	query	string	non	-

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/structbanque/count?where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/structbanque/count

Compter les enregistrements.

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/structbanque/count" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/structbanque/recherche

Rechercher des enregistrements.

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/structbanque/recherche" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/structbanque/save

Créer ou mettre à jour l'enregistrement (upsert).

Corps de la requête (application/json)

Schéma StructBanqueDto - 11 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/structbanque/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"type": 0, "edi": false, "longueurBanque": 0}'

Schémas

Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.

StructBanqueDto

StructBanqueDto - 11 propriétés

Propriété	Type	Notes
type	integer (int32)	Type de structure (clé, cbIndice = valeur de l'énuméré RibType).
edi	boolean	Structure EDI.
longueurBanque	integer (int32)	Longueur du code banque.
typeBanque	integer (int32)	Type du code banque (énuméré StructBanqueFieldType).
longueurGuichet	integer (int32)	Longueur du code guichet.
typeGuichet	integer (int32)	Type du code guichet (énuméré StructBanqueFieldType).
longueurCompte	integer (int32)	Longueur du compte.
typeCompte	integer (int32)	Type du compte (énuméré StructBanqueFieldType).
longueurCle	integer (int32)	Longueur de la clé.
typeCle	integer (int32)	Type de la clé (énuméré StructBanqueFieldType).
controle	integer (int32)	Contrôle RIB (énuméré StructBanqueControleRib).

Voir aussi

• Démarrer avec l'API v2
• Conventions de payload
• Tous les groupes