Axe Analytique

Présentation générale de l'API et finalité fonctionnelle

Cette API permet la recupération d'axe analytique de Cegid Loop :

• Interrogation

GET/axe

Cette API retourne la liste des axes d'un dossier

Lien vers la documentation technique

Cas d'usage

• Cette API permet de retourner toute la liste des axes d'un dossier client au sein du cabinet.
• Elle permet également de retourner un échantillon d'axe grâce à ses paramètres (Cf. § Paramètres de la demande).

Procédure

Il faut appeler un endpoint permettant de lister les sections :

GET https://api.cegid.com/loop-api-publiques/axe?codeDossier={codeDossier}[&filter][&sort][&skip][&take]

Route	Méthode http	Description
/axe	GET	Retourne la liste des axes

Paramétrage de l’appel

Méthode http pour la demande : GET

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de la demande

Champ	Description	Exemple	Obligatoire
codeDossier	Valeur à renseigner : Code dossier	CEGID001	Oui
filter	Permet de filtrer le resultat		Non
sort	Trie le résultat		Non
skip	Saute X dossiers		Non
take	Retourne X dossiers		Non
select	Retourne seulement les champs mentionnés		Non

Exemple URL : https://loop.loopsoftware.fr/collaborateur/service/publicapi/query/comptabilite/axe?codeDossier=CEGID001

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas de d'échec

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour

L'API retourne une liste d'objet dossier au format suivant :

Champ	Sous Champ	Type	Description
objectId		UUID	Code unique
revisionId		string($uuid)	ID de la révision
description		string	Libelllé de l'axe
code		string	code de l'axe
ferme		boolean	False ou True
sousAxe
	object	UUID	UUID du sous-axe
	decription	UUID	Description du sous-axe
sectionDefaut
	object	UUID	UUID de la section d'attente
	decription	UUID	Description de la section d'attente

Exemple de retour

[
  {
    "objectId": "352ebf42-ba97-43bb-a786-649ef1d4ba28",
    "revisionId": "0x0000000000033A13",
    "description": "Axe 1",
    "code": "AXE",
    "ferme": false,
    "sousAxe": {
      "objectId": null,
      "description": [
        ""
      ]
    },
    "sectionDefaut": {
      "objectId": "37f8728f-af7a-46e7-b690-668e810208ae",
      "description": [
        "SECA@AXE"
      ]
    }
  }
]