Parcourir les connexions

L'API parcourir les connexions permet aux utilisateurs de l'OD de parcourir les connexions qu'ils ont créées

Pré-requis

• Posséder un compte OD

Requête

Pour pacourir les connexions on fait une requête GET sur le chemin d'accès suivant:

v1/connexions

On doit passer:

• L'identifiant utilisateur de l'OD dans l'en-tête X-OD-User-ID
• Les paramètres de pagination dans la chaîne de requête

Par exemple:

cURL

Requête de parcours des connexions

curl \
-H 'X-OD-User-ID: ${userId}' \
http://<host>:<port>/v1/connexions?pageNumber=1&pageSize=25&orderBy=dateCreation&sortOrder=asc

Typescript

Requête de parcours des connexions

const url = 'http://<host>:<port>/v1/connexions?pageNumber=1&pageSize=25&orderBy=dateCreation&sortOrder=asc'
const response: AxiosResponse = await axios.get(url, {
    headers: {
        'X-OD-User-ID': userId,
    }
});

Paramètres de pagination

Paramètre	Valeur	Défaut
pageNumber	1..N	1
pageSize	1...N	20
orderBy	dateCreation	dateCreation
sort	asc ou desc	asc

Réponse

Si tout s'est bien passé, la réponse de l'OD est de la forme suivante:

Résultat de parcours des connexions

{
    "items": [
        {
          "id": "d69ace15-8489-497e-b9ef-d7abbfbfc959",
          "type": "PDP",
          "status": "PENDING",
          // --- seulement si PENDING, AWAITING_VERIFICATION, ou OUTDATED ---
          "signupUrl": "http://...",
          "loginUrl": "http://...",
          // ----------------------------------------------------------------
          "entreprises": [
            {
              "siren": "810319517",
              "nom": "Dougs",
              "regimesFiscaux": [
                {
                  "regime": "NORMAL_MENSUEL",
                  "dateEntreeEnVigueur": "2024-04-15"
                }
                // ... autres régimes fiscaux
              ]
            }
            // ... autres entreprises
          ]
        },
        // ... autres connexions
    ],
    "meta": {
        "pageNumber": 1,
        "pageSize": 20,
        "pageCount": 3,
        "itemCount": 55
    }
}

Propriété	Valeur
id	Identifiant interne de la connexion dans l'OD
type	PDP | PPF
status	PENDING | CONNECTED | AWAITING_VERIFICATION | OUTDATED
signupUrl	URL de création de compte PDP
loginUrl	URL d'association de ce compte OD à un compte PDP existant
entreprises[i].siren	Numéro SIREN de l'entreprise
entreprises[i].nom	Nom de l'entreprise
entreprises[i].regimesFiscaux[j].regime	Régime fiscal de l'entreprise
entreprises[i].regimesFiscaux[j].dateEntreeEnVigueur	Date d'entrée en vigueur du régime fiscal

Statut	Description
PENDING	La connexion est créée mais pas associée à ce compte OD
CONNECTED	La connexion est associée à ce compte OD
AWAITING_VERIFICATION	La connexion est associée à ce compte OD et en attente de la vérification d'identité de l'utilisateur
OUTDATED	La connexion est associée à ce compte OD mais le jeton d'accès à la PDP est périmé, l'utilisateur doit se reconnecter via l'URL loginUrl

Infos pagination (meta)

Propriété	Valeur
pageNumber	numéro de la page
pageSize	taille de la page
pageCount	nombre total de pages de la taille demandée
itemCount	nombre total de connexions

Erreurs

Code	Message
400 Bad Request	Requête invalide - Voir messages d'erreur
401 Unauthorized	Informations d'authentification invalides