Dossiers clients

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

Ces API permettent d'interagir sur le paramétrage des dossiers clients de Cegid Loop :

GET/dossierClient

Cette API retourne la liste des dossiers clients.

Lien vers la documentation technique

Cas d'usage

Cette API peut servir à récupérer certaines informations techniques comme l'"objectId" et le "revisionId".
Disposer de ces informations techniques peut être utile pour utiliser d'autres API (exemple le Sinker).
Cette API permet de retourner toute la liste des dossiers clients du cabinet.
Elle permet également de retourner un échantillon de dossiers clients grâce à ses paramètres (Cf. § Paramètres de la demande).

Procédure

Il faut appeler un endpoint permettant de lister les dossiers clients :

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

Route	Méthode http	Description
/dossierClient	GET	Retourne la liste des dossiers clients

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	Obligatoire
codeDossier	Valeur à renseigner : cabinet	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

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	Type	Description
objectId	string($uuid)	ID (UUID) Code unique
revisionId	string($uuid)	ID (UUID) de la révision
nature	string	Nature du dossier : 1 : Personne Physique 2 : Personne Morale
prenom	string	Prénom, obligatoire pour les personnes physiques
nom	string	Nom, obligatoire pour les personnes physiques
raisonSociale	string	Dénomination, obligatoire pour les personnes morales
nomUsuel	string	Nom du dossier
complementNom	string	Complement du nom
siren	string	siren
nic	string	nic
formejuridique	string	Forme juridique
naf	string	Code naf
numVoie	string	Numéro de la voie
extension	string	Extension du numéro de voie : 1 : Bis 2 : Ter 3 : Quater
nomVoie	string	Type et nom de la voie
lieuditHameau	string	Lieu-dit
complementDistrib	string	Complément d'adresse
codePostal	string	Code Postal
localite	string	Localité
pays	string	Code ISO du pays
telephone	string	Numéro de téléphone
fax	string	Numéro de Fax
email	string	Email
siteweb	string	Site web
maitreDossier	string	Adresse mail du maitre du dossier existant
engagementManager	string	Adresse mail de l'engagement manager existant
groupeTravail	string	Liste des groupes de travail ratachés à ce dossier
statut	string	Liste des statuts techniques du dossier status : 1 : A préparer 2 : En création 3 : Base de données créée 4 : Site SharePoint sur le tenant du cabinet créé 5 : SharePoint Client créé 77 : Création de la GED en cours 88 : GED en erreur 99 : Migration en cours
statutTeams	string	Statut technique du Teams of associé au dossier : 1: A préparer 2: En préparation 3: GED a préparer 4: GED en préparation 5: Operationnel 33: Teams en erreur 44 : GED en error 77 : Migration en cours 88 : Migration en erreur 99 : Migration à faire
sansEngagement	boolean	Sans engagement (true par défaut)
typeDossier	string	Type de dossier, dossier client ou dossier utilisé pour la gestion interne (facturation) : 1 : Dossier client 2 : dossier interne
site	string	Adresse du site Sharepoint du dossier
codeDossier	string	code du dossier
maitreDossierId	string	Identifiant du dossier
engagementManagerId	string	Identifiant de l'engagement manager
dtSortie	date	Date de résiliation du client, à partir de la quelle le dossier passe en lecture. Cette date n'est utilisable que pour les dossier avec "sansEngagement" égale true

Exemple de retour

[{
    "objectId": "d84bd177-0934-40ed-8e74-01f18f17f760",
    "revisionId": "0x000000000023EBA3",
    "nature": 1,
    "prenom": "",
    "nom": "",
    "raisonSociale": "DUPONT",
    "nomUsuel": "DUPONT SARL",
    "complementNom": "",
    "siren": "",
    "nic": "",
    "formeJuridique": "",
    "naf": "",
    "numVoie": "",
    "extension": 0,
    "nomVoie": "",
    "lieuditHameau": "",
    "complementDistrib": "",
    "codePostal": "",
    "localite": "",
    "pays": "",
    "telephone": "",
    "fax": "",
    "email": "",
    "siteWeb": "",
    "maitreDossier": "collaborateur01@cegidpartenaires.onmicrosoft.com",
    "engagementManager": "manager01@cegidpartenaires.onmicrosoft.com",
    "groupeTravail": "Groupe01",
    "statut": 4,
    "statutTeams": 5,
    "sansEngagement": true,
    "typeDossier": 1,
    "site": "DUPONT01",
    "codeDossier": "DUPONT01",
    "maitreDossierId": "9af5ca7c-9ff5-4d88-bcb0-87e097ca5c32",
    "engagementManagerId": "56363e5d-aec5-45a7-b275-c43aebe861bb",
    "dtSortie": "2024-05-07T00:00:00Z"
}]

POST/dossierClient

Cette API crée un dossier client.

Lien vers la documentation technique

Cas d'usage

Cette API permet la création de dossiers clients dans Cegid Loop depuis une application externe.

Procédure

Il faut appeler un endpoint permettant d'ajouter les dossiers clients :

https://api.cegid.com/loop-api-publiques/dossierClient?codeDossier={codeDossier}

Route	Méthode http	Description
/dossierClient	POST	Ajoute des dossiers clients

Paramétrage de l’appel

Méthode http pour la demande : POST

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	Obligatoire
codeDossier	Valeur à renseigner : cabinet	Oui

Body de la demande

Champ	Type	Description	Obligatoire
codeDossier	string	code du dossier	Oui
nature	string	Nature du dossier 1: Personne Physique 2: Personne Morale	Oui
prenom	string	Prénom	Oui* si personne physique
nom	string	Noms	Oui* si personne physique
raisonSociale	string	Dénominations	Oui* si personne morale
nomUsuel	string	Nom du dossier	Non
complementNom	string	Complement du nom	Non
siren	string	siren	Non
nic	string	nic	Non
formejuridique	string	Forme juridique	Non
naf	string	Code naf	Non
numVoie	string	Numéro de la voie	Non
extension	string	Extension du numéro de voie 1 : Bis 2 : Ter 3 : Quater	Non
nomVoie	string	Type et nom de la voie	Non
lieuditHameau	string	Lieu-dit	Non
complementDistrib	string	Complément d'adresse	Non
codePostal	string	Code Postal	Non
localite	string	Localité	Non
pays	string	Code ISO du pays	Non
telephone	string	Numéro de téléphone	Non
fax	string	Numéro de Fax	Non
email	string	Email	Non
siteweb	string	Site web	Non
maitreDossier	string	Adresse mail du maitre du dossier	Non
maitreDossierId	string	Identifiant du dossier	Non
engagementManager	string	Adresse mail de l'engagement manager	Non
engagementManagerId	string	Identifiant de l'engagament manager	Non
groupeTravail	string	Liste des groupes de travail ratachés à ce dossier	Non
sansEngagement	boolean	Sans engagement (true par défaut)	Non
typeDossier	string	Type de dossier, dossier client ou dossier utilisé pour la gestion interne (facturation) : 1 : Dossier client 2 : dossier interne	Non
approvisionnement	boolean	Renseigné à la création, provisionnement automatique la base SQL et de la GED	Non
statut	string	Liste des statuts techniques du dossier status : 1 : A préparer 2 : En création 3 : Base de données créée 4 : Site SharePoint sur le tenant du cabinet créé 5 : SharePoint Client créé 77 : Création de la GED en cours 88 : GED en erreur 99 : Migration en cours	Non
statutTeams	string	Statut technique du Teams of associé au dossier 1 : A préparer 2 : En préparation 3 : GED à préparer 4 : GED en préparation 5 : Operationnel 33 : Teams en erreur 44 : GED en error 77 : Migration en cours 88 : Migration en erreur 99 : Migration à faire	Non
site	string	Adresse du site Sharepoint du dossier	Non
dtSortie	date	Date de résiliation du client, à partir de la quelle le dossier passe en lecture

Exemple de body

[
   {
      "codeDossier": "string",
      "nature" : 2,
      "prenom" : "Manon",
      "nom" : "Martin",
      "raisonSociale" : "CEGID003",
      "nomUsuel" : "CEGID003",
      "complementNom" : "",
      "siren" : "",
      "nic" : "",
      "formeJuridique" : "",
      "naf" : "",
      "numVoie" : "",
      "extension" : 0,
      "nomVoie" : "",
      "lieuditHameau" : "",
      "complementDistrib" : "",
      "codePostal" : "",
      "localite" : "",
      "pays" : "",
      "telephone" : "",
      "fax" : "",
      "email" : "",
      "siteWeb": "www.google.com",
      "maitreDossier" : "manon@devloop.onmicrosoft.com",
      "engagementManager" : "manon@devloop.onmicrosoft.com",
      "groupeTravail" : "LOOP-DOSSIER-CABINET",
      "sansEngagement" : true,
      "typeDossier" : 1,
      "maitreDossierId" : "e2b94200-11b1-4a60-b409-b19fed95d217",
      "engagementManagerId" : "e2b94200-11b1-4a60-b409-b19fed95d217",
      "approvisionnement": true,
      "site" :"",
      "dtSortie": null
   }
]

Points d'attention sur la structure du JSON

Vous ne pouvez pas modifier les propriétés d'un élément 'enfant'.
Vous pouvez ajouter, modifier ou supprimer des éléments 'enfant' en incluant leur 'objectId', toutes les autres propriétés seront ignorées.
Cela s'applique également aux éléments « enfants » dans un tableau.
Fournir un nom de site SharePoint existant n'est pas encore autorisé pour les entreprises utilisant Loop avec Teams.
Le nom du site fourni ne doit pas dépasser 100 caractères. Si non respecté, l'API renvoie une erreur.
Le nom du site fourni doit suivre les conventions de dénomination requises par Loop. Ceci est sous la seule responsabilité du cabinet.
Le nom du site fourni doit correspondre à un site existant avec une structure répondant aux exigences de Loop. Ceci est sous la seule responsabilité du cabinet.

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

Champ	Type	Description
objectId	string($uuid)	ID (UUID) Code unique
revisionId	string($uuid)	ID (UUID) de la révision
codeDossier	string	code du dossier
nature	string	Nature du dossier : 1 : Personne Physique 2 : Personne Morale
prenom	string	Prénom, obligatoire pour les personnes physiques
nom	string	Nom, obligatoire pour les personnes physiques
raisonSociale	string	Dénomination, obligatoire pour les personnes morales
nomUsuel	string	Nom du dossier
complementNom	string	Complement du nom
siren	string	siren
nic	string	nic
formejuridique	string	Forme juridique
naf	string	Code naf
numVoie	string	Numéro de la voie
extension	string	Extension du numéro de voie 1 : Bis 2 : Ter 3 : Quater
nomVoie	string	Type et nom de la voie
lieuditHameau	string	Lieu-dit
complementDistrib	string	Complément d'adresse
codePostal	string	Code Postal
localite	string	Localité
pays	string	Code ISO du pays
telephone	string	Numéro de téléphone
fax	string	Numéro de Fax
email	string	Email
siteweb	string	Site web
maitreDossier	string	Adresse mail du maitre du dossier
maitreDossierId	string	Identifiant du dossier
engagementManager	string	Adresse mail de l'engagement manager
engagementManagerId	string	Identifiant de l'engagament manager
groupeTravail	string	Liste des groupes de travail ratachés à ce dossier
sansEngagement	boolean	Sans engagement (true par défaut)
typeDossier	string	Type de dossier, dossier client ou dossier utilisé pour la gestion interne (facturation) 1 : Dossier client 2 : dossier interne
approvisionnement	boolean	Renseigné à la création, provisionnement automatique la base SQL et de la GED
statut	string	Liste des statuts techniques du dossier status 1 : A préparer 2 : En création 3 : Base de données créée 4 : Site SharePoint sur le tenant du cabinet créé 5 : SharePoint Client créé 77 : Création de la GED en cours 88 : GED en erreur 99 : Migration en cours
statutTeams	string	Statut technique du Teams of associé au dossier 1: A préparer 2 : En préparation 3 GED a préparer 4 : GED en préparation 5 : Operationnel 33 : Teams en erreur 44: GED en error 77 : Migration en cours 88 : Migration en erreur 99 : Migration à faire
site	string	Adresse du site Sharepoint du dossier
dtSortie	date	Date de résiliation du client, à partir de la quelle le dossier passe en lecture

Exemple de retour

{
    "success": [{
        "objectId": "48c11529-bf85-4b1e-96f7-6d61054ca3da",
        "revisionId": "0x00000000001A277F",
        "codeDossier": "CEGID003",
        "nature": 2,
        "prenom": "",
        "nom": "",
        "raisonSociale": "CEGID003",
        "nomUsuel": "CEGID003",
        "complementNom": "",
        "siren": "",
        "nic": "",
        "formeJuridique": "",
        "naf": "",
        "numVoie": "",
        "extension": 0,
        "nomVoie": "",
        "lieuditHameau": "",
        "complementDistrib": "",
        "codePostal": "",
        "localite": "",
        "pays": "",
        "telephone": "",
        "fax": "",
        "email": "",
        "siteWeb": "www.google.com",
        "maitreDossier": "manon@devloop.onmicrosoft.com",
        "maitreDossierId": "e2b94200-11b1-4a60-b409-b19fed95d217",
        "engagementManager": "manon@devloop.onmicrosoft.com",
        "engagementManagerId": "e2b94200-11b1-4a60-b409-b19fed95d217",
        "groupeTravail": "LOOP-DOSSIER-CABINET",
        "sansEngagement": true,
        "typeDossier": 1,
        "statut": 1,
        "statutTeams": 1,
        "site": "CEGID003",
        "dtSortie": "2024-05-07T00:00:00Z"
    }],
    "errors": []
}

PUT/dossierClient

Cette API modifie un dossier client

Lien vers la documentation technique

Cas d'usage

Cette API permet de modifier les informations des dossiers clients dans Cegid Loop depuis une application externe.

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/dossierClient afin de recupérer les champs obligatoires objectId et revisionId.

Assurez-vous d'avoir la dernière version de la valeur de revisionId.

En effet, la valeur de ce champ est incrémentée à chaque mise à jour.

Cette API permet de modifier la valeur d'un champ et pas de la supprimer. Envoyer une valeur à vide ne supprimera pas la valeur précedente.

Procédure

Il faut appeler un endpoint permettant de modifier les dossiers clients :

https://api.cegid.com/loop-api-publiques/dossierClient?codeDossier={codeDossier}

Route	Méthode http	Description
/dossierClient	PUT	Modifie des dossiers clients

Paramétrage de l’appel

Méthode http pour la demande : PUT

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	Obligatoire
codeDossier	Valeur à renseigner : cabinet	Oui

Body de la demande

Champ	Type	Description	Obligatoire
objectId	string($uuid)	ID (UUID) Code unique	Oui
revisionId	string($uuid)	ID (UUID) de la révision	Oui
codeDossier	string	code du dossier	Non
nature	string	Nature du dossier 1: Personne Physique 2: Personne Morale	Non
prenom	string	Prénom, obligatoire pour les personnes physiques	Non
nom	string	Nom, obligatoire pour les personnes physiques	Non
raisonSociale	string	Dénomination, obligatoire pour les personnes morales	Non
nomUsuel	string	Nom du dossier	Non
complementNom	string	Complement du nom	Non
siren	string	siren	Non
nic	string	nic	Non
formejuridique	string	Forme juridique	Non
naf	string	Code naf	Non
numVoie	string	Numéro de la voie	Non
extension	string	Extension du numéro de voie 1: Bis 2: Ter 3: Quater	Non
nomVoie	string	Type et nom de la voie	Non
lieuditHameau	string	Lieu-dit	Non
complementDistrib	string	Complément d'adresse	Non
codePostal	string	Code Postal	Non
localite	string	Localité	Non
pays	string	Code ISO du pays	Non
telephone	string	Numéro de téléphone	Non
fax	string	Numéro de Fax	Non
email	string	Email	Non
siteweb	string	Site web	Non
maitreDossier	string	Adresse mail du maitre du dossier	Non
maitreDossierId	string	Identifiant du dossier	Non
engagementManager	string	Adresse mail de l'engagement manager	Non
engagementManagerId	string	Identifiant de l'engagament manager	Non
groupeTravail	string	Liste des groupes de travail ratachés à ce dossier	Non
sansEngagement	boolean	Sans engagement (true par défaut)	Non
typeDossier	string	Type de dossier, dossier client ou dossier utilisé pour la gestion interne (facturation) 1: Dossier client 2: dossier interne	Non
approvisionnement	boolean	Renseigné à la création, provisionnement automatique la base SQL et de la GED	Non
statut	string	Liste des statuts techniques du dossier status 1: A préparer 2: En création 3: Base de données créée 4: Site SharePoint sur le tenant du cabinet créé 5: SharePoint Client créé 77: Création de la GED en cours 88: GED en erreur 99: Migration en cours	Non
statutTeams	string	Statut technique du Teams of associé au dossier 1: A préparer 2: En préparation 3: GED a préparer 4: GED en préparation 5: Operationnel 33: Teams en erreur 44: GED en error 77: Migration en cours 88: Migration en erreur 99: Migration à faire	Non
site	string	Adresse du site Sharepoint du dossier	Non
dtSortie	date	Date de résiliation du client, à partir de la quelle le dossier passe en lecture

Exemple de body

[{
        "objectId": "48c11529-bf85-4b1e-96f7-6d61054ca3da",
        "revisionId": "0x00000000001A277F",
        "codeDossier": "CEGID003",
        "nature": 2,
        "prenom": "",
        "nom": "",
        "raisonSociale": "CEGID003 MODIFICATION",
        "nomUsuel": "CEGID003",
        "complementNom": "",
        "siren": "",
        "nic": "",
        "formeJuridique": "",
        "naf": "",
        "numVoie": "",
        "extension": 0,
        "nomVoie": "",
        "lieuditHameau": "",
        "complementDistrib": "",
        "codePostal": "",
        "localite": "",
        "pays": "",
        "telephone": "",
        "fax": "",
        "email": "",
        "siteWeb": "www.google.com",
        "maitreDossier": "manon@devloop.onmicrosoft.com",
        "maitreDossierId": "e2b94200-11b1-4a60-b409-b19fed95d217",
        "engagementManager": "manon@devloop.onmicrosoft.com",
        "engagementManagerId": "e2b94200-11b1-4a60-b409-b19fed95d217",
        "groupeTravail": "LOOP-DOSSIER-CABINET",
        "sansEngagement": true,
        "typeDossier": 1,
        "statut": 1,
        "dtSortie": null
    }]

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

Champ	Type	Description
objectId	string($uuid)	ID (UUID) Code unique
revisionId	string($uuid)	ID (UUID) de la révision
codeDossier	string	code du dossier
nature	string	Nature du dossier 1: Personne Physique 2: Personne Morale
prenom	string	Prénom, obligatoire pour les personnes physiques
nom	string	Nom, obligatoire pour les personnes physiques
raisonSociale	string	Dénomination, obligatoire pour les personnes morales
nomUsuel	string	Nom du dossier
complementNom	string	Complement du nom
siren	string	siren
nic	string	nic
formejuridique	string	Forme juridique
naf	string	Code naf
numVoie	string	Numéro de la voie
extension	string	Extension du numéro de voie 1 : Bis 2 : Ter 3 : Quater
nomVoie	string	Type et nom de la voie
lieuditHameau	string	Lieu-dit
complementDistrib	string	Complément d'adresse
codePostal	string	Code Postal
localite	string	Localité
pays	string	Code ISO du pays
telephone	string	Numéro de téléphone
fax	string	Numéro de Fax
email	string	Email
siteweb	string	Site web
maitreDossier	string	Adresse mail du maitre du dossier
maitreDossierId	string	Identifiant du dossier
engagementManager	string	Adresse mail de l'engagement manager
engagementManagerId	string	Identifiant de l'engagament manager
groupeTravail	string	Liste des groupes de travail ratachés à ce dossier
sansEngagement	boolean	Sans engagement (true par défaut)
typeDossier	string	Type de dossier, dossier client ou dossier utilisé pour la gestion interne (facturation) 1 : Dossier client 2 : dossier interne
approvisionnement	boolean	Renseigné à la création, provisionnement automatique la base SQL et de la GED
statut	string	Liste des statuts techniques du dossier status 1 : A préparer 2 : En création 3 : Base de données créée 4 : Site SharePoint sur le tenant du cabinet créé 5 : SharePoint Client créé 77 : Création de la GED en cours 88 : GED en erreur 99 : Migration en cours
statutTeams	string	Statut technique du Teams of associé au dossier 1 : A préparer 2 : En préparation 3 : GED a préparer 4 : GED en préparation 5 : Operationnel 33 : Teams en erreur 44 : GED en error 77 : Migration en cours 88 : Migration en erreur 99 : Migration à faire
site	string	Adresse du site Sharepoint du dossier
dtSortie	date	Date de résiliation du client, à partir de la quelle le dossier passe en lecture

Exemple de retour

{
    "success": [{
        "objectId": "5ce882dd-e1cf-4062-a3c5-40c1e839db07",
        "revisionId": "0x00000000001A4691",
        "codeDossier": "CEGID003",
        "nature": 2,
        "prenom": "",
        "nom": "",
        "raisonSociale": "CEGID003 MODIFICATION",
        "nomUsuel": "CEGID003",
        "complementNom": "",
        "siren": "",
        "nic": "",
        "formeJuridique": "",
        "naf": "",
        "numVoie": "",
        "extension": 0,
        "nomVoie": "",
        "lieuditHameau": "",
        "complementDistrib": "",
        "codePostal": "",
        "localite": "",
        "pays": "",
        "telephone": "",
        "fax": "",
        "email": "",
        "siteWeb": "www.google.com",
        "maitreDossier": "manon@devloop.onmicrosoft.com",
        "maitreDossierId": "e2b94200-11b1-4a60-b409-b19fed95d217",
        "engagementManager": "manon@devloop.onmicrosoft.com",
        "engagementManagerId": "e2b94200-11b1-4a60-b409-b19fed95d217",
        "groupeTravail": "LOOP-DOSSIER-CABINET",
        "sansEngagement": true,
        "typeDossier": 1,
        "statut": 1,
        "statutTeams": 1,
        "site": "CEGID003",
        "dtSortie": null
    }],
    "errors": []
}

DEL/dossierClient

Cette API supprime un dossier Client

Lien vers la documentation technique

Cas d'usage

Cette API permet de supprimer des dossiers clients dans Cegid Loop depuis une application externe

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/dossierClient afin de recupérer les champs obligatoires objectId et revisionId.

Assurez-vous d'avoir la dernière version de la valeur de revisionId.

En effet, la valeur de ce champ est incrémentée à chaque mise à jour.

Procédure

Il faut appeler un endpoint permettant de supprimer les dossiers clients :

https://api.cegid.com/loop-api-publiques/dossierClient?codeDossier={codeDossier}

Route	Méthode http	Description
/dossierClient	DEL	Suppression des dossiers clients

Paramétrage de l’appel

Méthode http pour la demande : DEL

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	Obligatoire
codeDossier	Valeur à renseigner : cabinet	Oui

Body de la demande

Champ	Type	Description	Obligatoire
objectId	string($uuid)	ID (UUID) Code unique	Oui
revisionId	string($uuid)	ID (UUID) de la révision	Oui

Exemple de body

[{
  "objectId": "5ce882dd-e1cf-4062-a3c5-40c1e839db07",
    "revisionId": "0x00000000001A4693"
}]

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

Champ	Type	Description
objectId	string($uuid)	ID (UUID) Code unique
revisionId	string($uuid)	ID (UUID) de la révision

Example de retour

{
    "success": [{
        "status": "deleted",
        "objectId": "5ce882dd-e1cf-4062-a3c5-40c1e839db07",
        "revisionId": "0x00000000001A4693"
    }],
    "errors": []
}

Table of Contents

Dossiers clients

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

GET/dossierClient

Cas d'usage

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

POST/dossierClient

Cas d'usage

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

PUT/dossierClient

Cas d'usage

Points d'attention

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

DEL/dossierClient

Cas d'usage

Points d'attention

Procédure

Paramétrage de l’appel

Code retour

Structure du retour