Collaborateur du Cabinet

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

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

GET/collaborateurCabinet

Cette API retourne la liste des collaborateurs du cabinet.

Lien vers la documentation technique

Cas d'usage

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

Procédure

Il faut appeler un endpoint permettant de lister les collaborateurs du cabinet :

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

Route	Méthode http	Description
/collaborateurCabinet	GET	Retourne la liste des collaborateurs du cabinet

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 collaborateur au format suivant

Champ	Type	Description
objectId	string($uuid)	ID (UUID) Code unique
revisionId	string($uuid)	ID (UUID) de la révision
identifiant	string	code du dossier
prenom	string	Prénom, obligatoire pour les personnes physiques
nom	string	Nom, obligatoire pour les personnes physiques
email	string	Email
login	string	Login
telephone	string	Numéro du téléphone
adresse1	string	Adresse1
adresse2	string	Adresse2
adresse3	string	Adresse3
ville	string	Ville
codePostal	string	Code postal
pays	string	Code ISO du pays
langue	string	Code ISO 100 du pays
actif	string	Utilisateur active
tenant	string	Tenant
accesSocial	string	Accès social
responsable	string	Email du responsable
roleOrga	string	role organisationel
prixVente	float	prix du vente
prixRevient	float	prix du revient
groupeTravail	string	Liste des groupes de travail séparée par ;

Exemple de retour

{
    "objectId": "81b66d46-cefb-4dae-b739-1173aae97420",
    "revisionId": "0x000000000009109A",
    "identifiant": "Collaborateur_100",
    "prenom": "",
    "nom": "COL_100",
    "email": "col_100@devloop.onmicrosoft.com",
    "login": "col_100_login@devloop.onmicrosoft.com",
    "telephone": "",
    "adresse1": "",
    "adresse2": "",
    "adresse3": "",
    "ville": "",
    "codePostal": "",
    "pays": "",
    "langue": "",
    "tenant": "devloop",
    "accesSocial": true,
    "responsable": "collab@devloop.onmicrosoft.com",
    "roleOrga": "Administrateur",
    "prixVente": 0,
    "prixRevient": 0,
    "groupeTravail": "LOOP-GESTION-DES-DROITS;"
}]

GET/CollaborateurDossierCabinet

Cette API retourne la liste des collaborateurs par dossier.

Lien vers la documentation technique

Cas d'usage

Cette API peut servir à récupérer certaines informations techniques comme "objectId" et "revisionId"
Disposer de ces informations techniques peut être utile pour utiliser d'autres API de modification
l'API permet de retourner le ou les collaborateurs du cabinet attaché à un dossier grace au paramètre du filtre.

Procédure

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

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

Route	Méthode http	Description
/CollaborateurDossierCabinet	GET	Retourne la liste des collaborateurs par dossier

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, renseigner dossierId=="b42ba973-07ce-4c6a-873a-5509ab7a20e2"	Oui
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 collaborateur au format suivant

Champ	Type	Description
objectId	string($uuid)	ID (UUID) Code unique
revisionId	string($uuid)	ID (UUID) de la révision
identifiant	string	code du dossier
nom	string	Nom, obligatoire pour les personnes physiques
prenom	string	Prénom, obligatoire pour les personnes physiques
login	string	Login
email	string	Email
tenant	string	Tenant
adresse1	string	Adresse1
adresse2	string	Adresse2
adresse3	string	Adresse3
ville	string	Ville
codePostal	string	Code postal
pays	string	Code ISO du pays
telephone	string	Numéro du téléphone
groupeTravail	string	Liste des groupes de travail séparée par ;
prixVente	float	prix du vente
prixRevient	float	prix du revient
accesSocial	Boolean	Accès social
responsable	string	Email du responsable
roleOrga	string	role organisationel
langue	string	Code ISO 100 du pays
competences	string	Compétences

Exemple de retour

[
   {
      "objectId" : "e2b94200-11b1-4a60-b409-b19fed95d217",
      "revisionId" : "0x00000000001AA454",
      "identifiant" : "manon",
      "nom" : "Entressangle",
      "prenom" : "Manon",
      "login" : "manon@loop.onmicrosoft.com",
      "email" : "MENTRESSANGLE@cegid.com",
      "tenant" : "devloop",
      "adresse1" : "",
      "adresse2" : "",
      "adresse3" : "",
      "ville" : "",
      "codePostal" : "",
      "pays" : "",
      "telephone" : "",
      "groupeDeTravail" : [
         {
            "code" : "MV_GT_001",
            "description" : "MV GT 001",
            "agence" : ""
         },
         {
            "code" : "LOOP-RDD",
            "description" : "Collaborateurs RDD",
            "agence" : ""
         },
         {
            "code" : "LOOP-GESTION-DES-DROITS",
            "description" : "",
            "agence" : ""
         },
         {
            "code" : "",
            "description" : "",
            "agence" : ""
         }
      ],
      "prixVente" : 0,
      "prixRevient" : 0,
      "accesSocial" : false,
      "responsable" : "",
      "roleOrga" : "Administrateur",
      "langue" : "fr",
      "competences" : [ ]
   }
]

POST/collaborateurCabinet

Cette API crée des collaborateurs dans le cabinet

Lien vers la documentation technique

Cas d'usage

l'API permet d'ajouter un ou des collaborateurs au sein du cabinet.

Procédure

Il faut appeler un endpoint permettant d'ajouter un collaborateur au sein d'un cabinet :

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

Route	Méthode http	Description
/collaborateurCabinet	POST	Ajout d'un collaborateur du cabinet

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
login	string	Login	Oui
email	string	Email	Oui
identifiant	string	code du dossier	Non
nom	string	Nom, obligatoire pour les personnes physiques	Oui* si personne physique
prenom	string	Prénom, obligatoire pour les personnes physiques	Oui* si personne physique
responsable	string	Email du responsable	Non
adresse1	string	Adresse1	Non
adresse2	string	Adresse2	Non
adresse3	string	Adresse3	Non
ville	string	Ville	Non
codePostal	string	Code postal	Non
pays	string	Code ISO du pays	Non
langue	string	Code ISO 100 du pays	Non
telephone	string	Numéro du téléphone	Non
tenant	string	Tenant	Non
roleOrga	string	role organisationel	Non
prixVente	float	prix du vente	Non
prixRevient	float	prix du revient	Non
groupeTravail	string	Liste des groupes de travail séparée par ;	Non

Exemple de body

[{
    "login": "collab.api2@cabinettest.onmicrosoft.com",
    "email": "collab.api2@cabinettest.onmicrosoft.com",
    "identifiant": "test",
    "nom": "TESTNOM",
    "prenom": "testprénom",
    "responsable": "",
    "adresse1": "21 RUE JASMIN",
    "adresse2": "22 RUE JASMIN",
    "adresse3": "23 RUE JASMIN",
    "codePostal": "75016",
    "ville": "PARIS",
    "pays": "FR",
    "langue": "fr",
    "telephone" : "01 02 00 03 04",
    "tenant": "",
    "roleOrga": "",
    "prixVente": 45.66,
    "prixRevient": 33.73,
    "groupeTravail": "LOOP-GESTION-DES-DROITS"
}]

Exemple avec plusieurs objets collaborateurs

[
    {
        "login": "collab.api@cabinettest.onmicrosoft.com",
        "email": "collab.api@cabinettest.onmicrosoft.com",
        "identifiant": "test",
        "nom": "TESTNOM",
        "prenom": "testprénom",
        "responsable": "",
        "adresse1": "21 RUE JASMIN",
        "adresse2": "22 RUE JASMIN",
        "adresse3": "23 RUE JASMIN",
        "codePostal": "75016",
        "ville": "PARIS",
        "pays": "FR",
        "langue": "fr",
        "telephone" : "01 02 00 03 04",
        "tenant": "",
        "roleOrga": "",
        "prixVente": 45.66,
        "prixRevient": 33.73,
        "groupeTravail": "LOOP-GESTION-DES-DROITS"
    },
    {
        "login": "collab2.api@cabinettest.onmicrosoft.com",
        "email": "collab2.api@cabinettest.onmicrosoft.com",
        "identifiant": "test2",
        "nom": "TESTNOM",
        "prenom": "testprénom",
        "responsable": "",
        "adresse1": "21 RUE JASMIN",
        "adresse2": "22 RUE JASMIN",
        "adresse3": "23 RUE JASMIN",
        "codePostal": "75016",
        "ville": "PARIS",
        "pays": "FR",
        "langue": "fr",
        "telephone" : "01 02 00 03 04",
        "tenant": "",
        "roleOrga": "",
        "prixVente": 45.66,
        "prixRevient": 33.73,
        "groupeTravail": "LOOP-GESTION-DES-DROITS"
    }
]

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
identifiant	string	code du dossier
nom	string	Nom
prenom	string	Prénom
login	string	Login
email	string	Email
tenant	string	Tenant
adresse1	string	Adresse1
adresse2	string	Adresse2
adresse3	string	Adresse3
ville	string	Ville
codePostal	string	Code postal
pays	string	Code ISO du pays
telephone	string	Numéro du téléphone
groupeTravail	string	Liste des groupes de travail séparée par ;
prixVente	float	prix du vente
prixRevient	float	prix du revient
accesSocial	boolean	Accès social
responsable	string	Email du responsable
roleOrga	string	role organisationel
langue	string	Code ISO 100 du pays

Exemple de retour

{
    "success": [{
        "objectId": "b760550f-0a9b-4686-af1f-8bd9d6797189",
        "revisionId": "0x00000000001A4696",
        "identifiant": "test",
        "nom": "TESTNOM",
        "prenom": "testprénom",
        "login": "collab.api2@cabinettest.onmicrosoft.com",
        "email": "collab.api2@cabinettest.onmicrosoft.com",
        "tenant": "cabinettest",
        "adresse1": "21 RUE JASMIN",
        "adresse2": "22 RUE JASMIN",
        "adresse3": "23 RUE JASMIN",
        "ville": "PARIS",
        "codePostal": "75016",
        "pays": "FR",
        "telephone": "01 02 00 03 04",
        "groupeTravail": "LOOP-GESTION-DES-DROITS",
        "prixVente": 45.66,
        "prixRevient": 33.73,
        "accesSocial": true,
        "responsable": "",
        "roleOrga": "",
        "langue": "fr"
    }],
    "errors": []
}

PUT/collaborateurCabinet

Cette API modifie les collaborateurs du cabinet

Lien vers la documentation technique

Cas d'usage

l'API permet de modifier la liste des collaborateurs du cabinet.

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/collaborateurcabinet 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 lister les collaborateurs du cabinet :

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

Route	Méthode http	Description
/collaborateurCabinet	PUT	Modifie la liste des collaborateurs du cabinet

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
identifiant	string	code du dossier	Non
prenom	string	Prénom, obligatoire pour les personnes physiques	Non
nom	string	Nom, obligatoire pour les personnes physiques	Non
email	string	Email	Non
login	string	Login	Non
telephone	string	Numéro du téléphone	Non
adresse1	string	Adresse1		Non
adresse2	string	Adresse2	Non
adresse3	string	Adresse3	Non
ville	string	Ville	Non
codePostal	string	Code postal	Non
pays	string	Code ISO du pays	Non
langue	string	Code ISO 100 du pays	Non
tenant	string	Tenant	Non
accesSocial	Boolean	Accès social	Non
responsable	string	Email du responsable	Non
roleOrga	string	role organisationel	Non
prixVente	float	prix du vente	Non
prixRevient	float	prix du revient	Non
groupeTravail	string	Liste des groupes de travail séparée par ;	Non

Exemple de body

{
    "objectId": "b760550f-0a9b-4686-af1f-8bd9d6797189",
    "revisionId": "0x00000000001A4699",
    "identifiant": "test MODIF",
    "prenom": "testprénom",
    "nom": "TESTNOM",
    "email": "collab.api2@cabinettest.onmicrosoft.com",
    "login": "collab.api2@cabinettest.onmicrosoft.com",
    "telephone": "01 02 00 03 04",
    "adresse1": "21 RUE JASMIN",
    "adresse2": "22 RUE JASMIN",
    "adresse3": "23 RUE JASMIN",
    "ville": "PARIS",
    "codePostal": "75016",
    "pays": "FR",
    "langue": "fr",
    "tenant": "cabinettest",
    "accesSocial": true,
    "responsable": "",
    "roleOrga": "",
    "prixVente": 45.66,
    "prixRevient": 33.73,
    "groupeTravail": "LOOP-GESTION-DES-DROITS"
}

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
identifiant	string	code du dossier
prenom	string	Prénom
nom	string	Nom
email	string	Email
login	string	Login
telephone	string	Numéro du téléphone

{
    "success": [{
        "objectId": "5ce882dd-e1cf-4062-a3c5-40c1e839db07",
        "revisionId": "0x00000000001A4691",
        "identifiant": "Collaborateur_101",
        "prenom": "",
        "nom": "COL_101 Modification",
        "email": "col_100@devloop.onmicrosoft.com",
        "login": "col_100_login@devloop.onmicrosoft.com",
        "telephone": "",
        "adresse1": "",
        "adresse2": "",
        "adresse3": "",
        "ville": "",
        "codePostal": "",
        "pays": "",
        "langue": "",
        "tenant": "devloop",
        "accesSocial": true,
        "responsable": "collab@devloop.onmicrosoft.com",
        "roleOrga": "Administrateur",
        "prixVente": 0,
        "prixRevient": 0,
        "groupeTravail": "LOOP-GESTION-DES-DROITS;"
    }],
    "errors": []
}

DEL/collaborateurcabinet

Cette API supprime un collaborateur du cabinet

Lien vers la documentation technique

Cas d'usage

l'API permet de supprimer la liste des collaborateurs du cabinet.

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/collaborateurcabinet 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 lister les collaborateurs du cabinet :

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

Route	Méthode http	Description
/collaborateurCabinet	DEL	supprimele collaborateur du cabinet

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

Exemple de body

[{
         "objectId" : "ad7f2403-82e1-47c6-840f-3f8f15635062",
}]

Exemple de retour

{
   "success" : [
      {
         "status" : "deleted",
         "objectId" : "ad7f2403-82e1-47c6-840f-3f8f15635062",
         "revisionId" : "0x00000000001A65ED"
      }
   ],
   "errors" : [ ]
}

Welcome to the Cegid APIs documentation

Collaborateur du Cabinet

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

GET/collaborateurCabinet

Cas d'usage

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

GET/CollaborateurDossierCabinet

Cas d'usage

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

POST/collaborateurCabinet

Cas d'usage

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

PUT/collaborateurCabinet

Cas d'usage

Points d'attention

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

DEL/collaborateurcabinet

Cas d'usage

Points d'attention

Procédure

Paramétrage de l’appel

Exemple de body

Exemple de retour