Workgroup list (liste de groupe de travail)

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/groupe

Returns the workgroup list

GET https://api.cegid.com/loop-api-publiques/groupe?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=getgroupe

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:

Parameter

The C R UD – Retrieve resources.

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

Name Description example mandatory
codeDossier Code Dossier cabinet YES
filter string (query) Allows you to filter the result codeDossier =="CEGID001" 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 Description
objectId string($uuid) ID (UUID) Code unique
revisionId string($uuid) ID (UUID) of revision
code string maxlengt 100 Working group code
description string maxlength 100 Description
agence string maxLength: 100 Agency code

Example response

 "data" : [
      {
         "objectId" : "b805040d-0586-4d10-aff2-19b49f81693d",
         "revisionId" : "0x00000000000278DA",
         "code" : "COMPTA_PARIS",
         "description" : "Service comptabilité Paris",
         "agence" : ""
      },
      {
         "objectId" : "8a1023a0-029e-4409-97e3-20181f909b2e",
         "revisionId" : "0x000000000002F661",
         "code" : "TEST",
         "description" : "Test",
         "agence" : ""
      }
   ]
}

POST/groupe

adding a work group

POST https://api.cegid.com/loop-api-publiques/groupe?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=addgroupe

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:

Parameter

The C R UD – Retrieve resources.

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

Name Description example mandatory
codeDossier Code Dossier cabinet Yes

On body

[{
    "code": "groupe-Test",
    "description": "groupe de travail",
    "agence": ""
}]

...

Information:

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

Class Reponse

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

Action Nature Description
objectId string($uuid) ID (UUID) Code unique
revisionId string($uuid) ID (UUID) of revision
code string maxlengt 100 Working group code
description string maxlength 100 Description
agence string maxLength: 100 Agency code

Example response

{
   "success" : [
      {
         "objectId" : "d858b833-492e-4268-a291-4788d07140a3",
         "revisionId" : "0x00000000000CF851",
         "code" : "groupe-Test",
         "description" : "groupe de travail",
         "agence" : ""
      }
   ],
   "errors" : [ ]
}

PUT/groupe

Modification of groupe

PUT https://api.cegid.com/loop-api-publiques/groupe?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=updategroupe

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:

Parameter

The C R UD – Retrieve resources.

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

Action Nature Description
objectId string($uuid) ID (UUID) Code unique
revisionId string($uuid) ID (UUID) of revision
code string maxlengt 100 Working group code
description string maxlength 100 Description
agence string maxLength: 100 Agency code

Example body

Information:

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

[
      {
         "objectId" : "b760550f-0a9b-4686-af1f-8bd9d6797189",
         "revisionId" : "0x00000000001A4699",
         "code" : "groupe-Test",
         "description" : "groupe de travail 2",
         "agence" : ""
      }
]

Example response

{
   "success" : [
      {
         "objectId" : "d858b833-492e-4268-a291-4788d07140a3",
         "revisionId" : "0x00000000000CF852",
         "code" : "groupe-Test",
         "description" : "groupe de travail 2",
         "agence" : ""
      }
   ],
   "errors" : [ ]
}

DEL/groupe

Delete of groupe

DEL https://api.cegid.com/loop-api-publiques/groupe?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=deletegroupe

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:

Parameter

The C R UD – Retrieve resources.

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

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

Example body

Information:

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

[{
         "objectId" : "d858b833-492e-4268-a291-4788d07140a3"",
         "revisionId" : "0x00000000000CF852"
}]

Example response

{
   "success" : [
      {
         "status" : "deleted",
         "objectId" : "d858b833-492e-4268-a291-4788d07140a3",
         "revisionId" : "0x00000000000CF852"
      }
   ],
   "errors" : [ ]
}