List of firm collaborators file (liste de Collaborateur Cabinet)

Pre-requisites

"Cegid Loop - APIKey Cabinet" is required This service is chargeable, check with your sales representative

Medias/Helloworld.png

The api key is generated in cegidlife on this service by a firm administrator

Settings in LoopHub, documentation in French : https://assistanceloop.blob.core.windows.net/documentation/Gestion_interne/collaboratif_catalogue_applications.pdf

The request headers must contain x-apikey, Ocp-Apim-Subscription-Key : This is the subscription key and it is mandatory.

GET/collaborateurcabinet

Returns a collaborateurcabinet list

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

API Request/Response

example Code Description Links 200 class response

Media type

application/json Controls Accept header.

Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format. The request headers must contain Content-Type: application-json.

Base URL

The base URL has the same structure for all public API requests. It consists of:

	Domain	Mode	Role
Example	https://loop.loopsoftware.fr	/YPN	/cabinet

on cegid Developers :

https://developers.cegid.com/api-details#api=loop-api-publiques&operation=getcollaborateurcabinet

For the purpose of this document, Base URL will be referred to as <baseUrl>.

Request Types

The base url is followed by one of Request Types:

query for CRUD operations on models
transaction for transactional requests
serverless for requests to server functions
service for requests to services

Parameter

The C R UD – Retrieve resources.

"url": https://api.cegid.com/loop-api-publiques/collaborateurcabinet?codeDossier?codeDossier=cabinet

Name	Description	example	mandatory
codeDossier	Code Dossier	cabinet	YES
filter string (query)	Allows you to filter the result	identifiant=="Collaborateur_100"	NO
Sort	Allows you to sort the result	field1&&field2:desc	NO
skip	Allows to pass X elements	?skip="{number}"	NO
take	Allows to recover X elements	?take="{number}"	NO

Note : the filter parameter should use javascript notation for equality : either == or === or !=

Class Reponse

To retrieve a single resource the request should supply the UID.

Action	Nature
objectId	string($uuid)	ID (UUID) Code unique

revisionId	string($uuid)	ID (UUID) of revision

identifiant	string maxlengt 100	code of dossier
prenom	string maxlength 100	First name, mandatory for individual persons
nom	string maxLength: 100	Name, mandatory for individual persons
login	string maxLength: 100	login
email	string maxLength: 100	Name of dossier
langue	string maxLength: 100	Code ISO 100 country
actif	string maxLength: 100	active user
tenant	string maxLength: 100	tenant

adresse1	string maxLength: 100	Adress1
adresse2	string maxlength 100	Adress2

adresse3 string	maxlength 100	Adress3

ville	string maxLength: 10	city

codePostal	string	code zip

pays	string	Code ISO of country

telephone	string maxLength: 100	Phone number

groupeTravail	string maxLength: 100	List of working group codes associated with the folder, separated by a ;

responsable	string maxLength 100	Line manager email

roleOrga	string maxLength 100	Lorganizational role
prixVente	float	Selling price
prixRevient	float	cost price

Example response

{
    "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

Returns a CollaborateurDossierCabinet list

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

API Request/Response

example Code Description Links 200 class response

Media type

application/json Controls Accept header.

Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format. The request headers must contain Content-Type: application-json.

Base URL

The base URL has the same structure for all public API requests. It consists of:

	Domain	Mode	Role
Example	https://loop.loopsoftware.fr	/YPN	/cabinet

on cegid Developers :

https://developers.cegid.com/api-details#api=loop-api-publiques&operation=getcollaborateurdossiercabinet

For the purpose of this document, Base URL will be referred to as <baseUrl>.

Request Types

The base url is followed by one of Request Types:

query for CRUD operations on models
transaction for transactional requests
serverless for requests to server functions
service for requests to services

Parameter

The C R UD – Retrieve resources.

"url": https://api.cegid.com/loop-api-publiques/collaborateurcabinet?codeDossier?codeDossier=cabinet

Name	Description	example	mandatory
codeDossier	Code Dossier	cabinet	YES
filter string (query)	Allows you to filter the result	dossierId=="b42ba973-07ce-4c6a-873a-5509ab7a20e2"	YES
Sort	Allows you to sort the result	field1&&field2:desc	NO
skip	Allows to pass X elements	?skip="{number}"	NO
take	Allows to recover X elements	?take="{number}"	NO

Note : the filter parameter should use javascript notation for equality : either == or === or !=

Class Reponse

To retrieve a single resource the request should supply the UID.

Action	Nature
objectId	string($uuid)	ID (UUID) Code unique

revisionId	string($uuid)	ID (UUID) of revision

identifiant	string maxlengt 100	code of dossier
prenom	string maxlength 100	First name, mandatory for individual persons
nom	string maxLength: 100	Name, mandatory for individual persons
login	string maxLength: 100	login
email	string maxLength: 100	Name of dossier
langue	string maxLength: 100	Code ISO 100 country
actif	string maxLength: 100	active user
tenant	string maxLength: 100	tenant

adresse1	string maxLength: 100	Adress1
adresse2	string maxlength 100	Adress2

adresse3 string	maxlength 100	Adress3

ville	string maxLength: 10	city

codePostal	string	code zip

pays	string	Code ISO of country

telephone	string maxLength: 100	Phone number

groupeTravail	string maxLength: 100	List of working group codes associated with the folder, separated by a ;

responsable	string maxLength 100	Line manager email

roleOrga	string maxLength 100	Lorganizational role
prixVente	float	Selling price
prixRevient	float	cost price

groupeDeTravail	[...]	group

Example response

[
   {
      "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

adding a collaborateurcabinet

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

API Request/Response

example Code Description Links 200 class response

Media type

application/json Controls Accept header.

Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format. The request headers must contain Content-Type: application-json.

Base URL

The base URL has the same structure for all public API requests. It consists of:

	Domain	Mode	Role
Example	https://loop.loopsoftware.fr	/YPN	/cabinet

on cegid Developers :

https://developers.cegid.com/api-details#api=loop-api-publiques&operation=addcollaborateurcabinet

For the purpose of this document, Base URL will be referred to as <baseUrl>.

Request Types

The base url is followed by one of Request Types:

query for CRUD operations on models
transaction for transactional requests
serverless for requests to server functions
service for requests to services

Parameter

The C R UD – Retrieve resources.

"url": https://api.cegid.com/loop-api-publiques/collaborateurcabinet?codeDossier=cabinet

Name	Description	example	mandatory
codeDossier	Code Dossier	cabinet	Yes

On 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"
}]
example several files

[
    {
        "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"
    }
]
...

Information:

Attention, before adding it is necessary to do the get collaborateurcabinet in order to have objectId of the collaborateurcabinet

Class Reponse

To retrieve a single resource the request should supply the UID.

Action	Nature
objectId	string($uuid)	ID (UUID) Code unique

revisionId	string($uuid)	ID (UUID) of revision

identifiant	string maxlengt 100	code of dossier
prenom	string maxlength 100	First name, mandatory for individual persons
nom	string maxLength: 100	Name, mandatory for individual persons
login	string maxLength: 100	login
email	string maxLength: 100	Name of dossier
langue	string maxLength: 100	Code ISO 100 country
actif	string maxLength: 100	active user
tenant	string maxLength: 100	tenant

adresse1	string maxLength: 100	Adress1
adresse2	string maxlength 100	Adress2

adresse3 string	maxlength 100	Adress3

ville	string maxLength: 10	city

codePostal	string	code zip

pays	string	Code ISO of country

telephone	string maxLength: 100	Phone number

groupeTravail	string maxLength: 100	List of working group codes associated with the folder, separated by a ;

responsable	string maxLength 100	Line manager email

roleOrga	string maxLength 100	Lorganizational role
prixVente	float	Selling price
prixRevient	float	cost price

Example response

{
    "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

Modification of collaborateurcabinet

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

API Request/Response

example Code Description Links 200 class response

Media type

application/json Controls Accept header.

Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format. The request headers must contain Content-Type: application-json.

Base URL

The base URL has the same structure for all public API requests. It consists of:

	Domain	Mode	Role
Example	https://loop.loopsoftware.fr	/YPN	/cabinet

on cegid Developers : https://developers.cegid.com/api-details#api=loop-api-publiques&operation=updatecollaborateurcabinet

For the purpose of this document, Base URL will be referred to as <baseUrl>.

Request Types

The base url is followed by one of Request Types:

query for CRUD operations on models
transaction for transactional requests
serverless for requests to server functions
service for requests to services

Parameter

The C R UD – Retrieve resources.

"url": https://api.cegid.com/loop-api-publiques/collaborateurcabinet?codeDossier=cabinet

Action	Nature
objectId	string($uuid)	ID (UUID) Code unique

revisionId	string($uuid)	ID (UUID) of revision

identifiant	string maxlengt 100	code of dossier
prenom	string maxlength 100	First name, mandatory for individual persons
nom	string maxLength: 100	Name, mandatory for individual persons
login	string maxLength: 100	login
email	string maxLength: 100	Name of dossier
langue	string maxLength: 100	Code ISO 100 country
actif	string maxLength: 100	active user
tenant	string maxLength: 100	tenant

adresse1	string maxLength: 100	Adress1
adresse2	string maxlength 100	Adress2

adresse3 string	maxlength 100	Adress3

ville	string maxLength: 10	city

codePostal	string	code zip

pays	string	Code ISO of country

telephone	string maxLength: 100	Phone number

groupeTravail	string maxLength: 100	List of working group codes associated with the folder, separated by a ;

responsable	string maxLength 100	Line manager email

roleOrga	string maxLength 100	Lorganizational role
prixVente	float	Selling price
prixRevient	float	cost price

Example body

Information:

Attention, before modifying it is necessary to do the get collaborateurcabinet in order to have objectId of the collaborateurcabinet

{
    "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"
}

Example response

{
    "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

Delete of collaborateurcabinet

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

API Request/Response

example Code Description Links 200 class response

Media type

application/json Controls Accept header.

Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format. The request headers must contain Content-Type: application-json.

Base URL

The base URL has the same structure for all public API requests. It consists of:

	Domain	Mode	Role
Example	https://loop.loopsoftware.fr	/YPN	/cabinet

on cegid Developers : https://developers.cegid.com/api-details#api=loop-api-publiques&operation=deletecollaborateurcabinet

For the purpose of this document, Base URL will be referred to as <baseUrl>.

Request Types

The base url is followed by one of Request Types:

query for CRUD operations on models
transaction for transactional requests
serverless for requests to server functions
service for requests to services

Parameter

The C R UD – Retrieve resources.

"url": https://loop.loopsoftware.fr/collaborateur/service/publicapi/query/comptabilite/collaborateurcabinet?codeDossier=cabinet

Name	Description	example	mandatory
codeDossier string	The code of collaborateurcabinet	cabinet	YES

Example body

Information:

Attention, before modifying it is necessary to do the get collaborateurcabinet in order to have objectId of the collaborateurcabinet

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

Example response

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

Welcome to the Cegid APIs documentation

List of firm collaborators file (liste de Collaborateur Cabinet)

Pre-requisites

GET/collaborateurcabinet

API Request/Response

Base URL

Request Types

Parameter

Class Reponse

Example response

GET//CollaborateurDossierCabinet

API Request/Response

Base URL

Request Types

Parameter

Class Reponse

Example response

POST/collaborateurcabinet

API Request/Response

Base URL

Request Types

Parameter

Class Reponse

Example response

PUT/collaborateurcabinet

API Request/Response

Base URL

Request Types

Parameter

Example body

Example response

DEL/collaborateurcabinet

API Request/Response

Base URL

Request Types

Parameter

Example body

Example response