Gestion des Entreprises

Dans AGATA CONSENT, tout intervenant dans le système est désigné comme une Entreprise (Company), quelque soit son rôle (Détenteur ou Bénéficiaire). Toute Entreprise possède au moins une Activité (Activity) créée par défaut.

Par exemple, sur le portail Entreprise AGATA CONSENT : pour chaque Entreprise de la liste, les actions individuelles possibles sont :

Créer une demande de consentement : ouvre la fenêtre de création de demande de consentement avec les informations Détenteurs précompletées avec les informations de l'Entreprise courante.
Consulter les détails des demandes de consentement à traiter : déplie l'Entreprise afin d'afficher la liste complète des demandes de consentement à traiter.
Visualiser de l'historique complet des consentements de l'Entreprise : affiche la liste complète des consentements traités et à traiter pour l'Entreprise courante.

La récupération des Entreprises est notamment utilisée sur l'écran Gestion des détenteurs.

Écran de gestion des Entreprises du portail AGATA CONSENT

L'écran de gestion des Détenteurs permet de rechercher des Entreprises par la raison sociale, l'identifiant (siret, siren, numagrin ou numagrit), l'adresse, le code postal, la commune ou le statut.

La liste des résultats de recherche permet de visualiser la liste des Entreprises ayant des demandes de consentements à traiter. Pour chaque Détenteur de la liste, les informations affichées sont :

La raison sociale.
L'identifiant (SIREN, SIRET, NUMAGRIN ou NUMAGRIT).
Le nombre de demandes de consentements en attente de traitement.
L'adresse postale.
Le code postal.
La commune.
Le statut du Détenteur.

Récupérer une entreprise

Récupérer les éléments d'une Entreprise par son identifiant unique id.

Requête

GET /companies/{company_id}

Paramètre	Type	Obligatoire	Description	Exemple
company_id ^*	string	Oui	Identifiant unique de l'Entreprise recherchée	fef1b25a-e980-4bd6-9ced-e1c4df714665

Exemple de requête

curl -X 'GET' \
  'https://www.agata-consent.com/companies/fef1b25a-e980-4bd6-9ced-e1c4df714665' \
  -H 'accept: application/json'

Réponse

Code	Titre	Description
200	OK	Retourne l'Entreprise
404	Not Found	L' Entreprise est introuvable

Body	Type	Description	Exemple
corporate_name	string	Raison sociale de l'Entreprise	GAEC DU VERGER
address	string	Adresse postale de l'Entreprise	LD BEAUREGARD
postal_code	string	Code postal de la commune de l'Entreprise	16310
city	string	Commune de l'Entreprise	MONTEMBOEUF
email	string	Mail de contact	gaec.verger@orange.fr
id	string	Identifiant unique (UUID) de l'Entreprise recherchée	fef1b25a-e980-4bd6-9ced-e1c4df714665
identifier_type	string	Type d'identifiant utilisé pour désigner l'Entreprise : SIRET \| SIREN \| NUMAGRIT \| NUMAGRIN	SIRET
business_identifier	string	Valeur de l'identifiant selon le type spécifié dans identifier_type	73282932000074
status	string	État du compte de l'Entreprise : ACTIVE \| SUSPENDED \| CLOSED	ACTIVE

Exemple de réponse

{
    "corporate_name": "GAEC DU VERGER",
    "address": "LD BEAUREGARD",
    "postal_code": "16310",
    "city": "MONTEMBOEUF",
    "email": "gaec.verger@orange.fr",
    "id": "fef1b25a-e980-4bd6-9ced-e1c4df714665",
    "identifier_type": "SIRET",
    "business_identifier": "73282932000074",
    "status": "ACTIVE"
}

Rechercher une entreprise

Rechercher une Entreprise grâce à son identifier_type (SIRET, SIREN, NUMAGRIN ou NUMAGRIT).

Requêtes

GET /companies?identifierType={identifier_type}&businessIdentifier={business_identifier}

Paramètre	Type	Obligatoire	Description	Exemple
identifierType ^*	string	Oui	Type d'identifiant utilisé pour désigner l'Entreprise : SIRET \| SIREN \| NUMAGRIT \| NUMAGRIN	SIRET
businessIdentifier ^*	string	Oui	Valeur de l'identifiant selon le type spécifié dans identifier_type	73282932000074

Exemple de requête

curl -X 'GET' \
  'https://www.agata-consent.com/companies?identifierType=SIRET&siret=73282932000074' \
  -H 'accept: application/json'

GET /companies/email={email}

Paramètre	Type	Obligatoire	Description	Exemple
email ^*	string	Oui	Mail de contact	gaec.verger@orange.fr

Exemple de requête

curl -X 'GET' \
  'https://www.agata-consent.com/companies?email=gaec.verger@orange.fr' \
  -H 'accept: application/json'

Réponse

Code	Titre	Description
200	OK	Retourne l'Entreprise
404	Not Found	L' Entreprise est introuvable

Body	Type	Description	Exemple
corporate_name	string	Raison sociale de l'Entreprise	GAEC DU VERGER
address	string	Adresse postale de l'Entreprise	LD BEAUREGARD
postal_code	string	Code postal de la commune de l'Entreprise	16310
city	string	Commune de l'Entreprise	MONTEMBOEUF
email	string	Mail de contact	gaec.verger@orange.fr
id	string	Identifiant unique (UUID) de l'Entreprise recherchée	fef1b25a-e980-4bd6-9ced-e1c4df714665
identifier_type	string	Type d'identifiant utilisé pour désigner l'Entreprise : SIRET \| SIREN \| NUMAGRIT \| NUMAGRIN	SIRET
business_identifier	string	Valeur de l'identifiant selon le type spécifié dans identifier_type	73282932000074
status	string	État du compte de l'Entreprise : ACTIVE \| SUSPENDED \| CLOSED	ACTIVE

Exemple de réponse

{
    "corporate_name": "GAEC DU VERGER",
    "address": "LD BEAUREGARD",
    "postal_code": "16310",
    "city": "MONTEMBOEUF",
    "email": "gaec.verger@orange.fr",
    "id": "fef1b25a-e980-4bd6-9ced-e1c4df714665",
    "identifier_type": "SIRET",
    "business_identifier": "73282932000074",
    "status": "ACTIVE"
}

Ajouter une Entreprise

Dans le cas où l'Entreprise n'existe pas encore, il est nécessaire de la créer avant de pouvoir lui affecter une demande de Consentement par exemple.

Requête

POST /companies

Body	Type	Obligatoire	Description	Exemple
corporate_name	string	Non	Raison sociale de l'Entreprise	GAEC DU VERGER
address	string	Non	Adresse postale de l'Entreprise	LD BEAUREGARD
postal_code	string	Non	Code postal de la commune de l'Entreprise	16310
city	string	Non	Commune de l'Entreprise	MONTEMBOEUF
email	string	Non	Mail de contact	gaec.verger@orange.fr

Exemple de requête

curl -X 'POST' \
  'https://www.agata-consent.com/companies' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "corporate_name": "GAEC DU VERGER",
    "address": "LD BEAUREGARD",
    "postal_code": "16310",
    "city": "MONTEMBOEUF",
    "email": "gaec.verger@orange.fr",
    "identifier_type": "SIRET",
    "siret": "73282932000074",
    "status": "ACTIVE"
}'

Réponse

Code	Titre	Description
201	Created	Entreprise créée
400	Bad Request	Syntaxe de la requête invalide
409	Conflict	Entreprise est déjà connue

Body	Type	Description	Exemple
corporate_name	string	Raison sociale de l'Entreprise	GAEC DU VERGER
address	string	Adresse postale de l'Entreprise	LD BEAUREGARD
postal_code	string	Code postal de la commune de l'Entreprise	16310
city	string	Commune de l'Entreprise	MONTEMBOEUF
email	string	Mail de contact	gaec.verger@orange.fr
id	string	Identifiant unique (UUID) de l'Entreprise recherchée	fef1b25a-e980-4bd6-9ced-e1c4df714665
identifier_type	string	Type d'identifiant utilisé pour désigner l'Entreprise : SIRET \| SIREN \| NUMAGRIT \| NUMAGRIN	SIRET
business_identifier	string	Valeur de l'identifiant selon le type spécifié dans identifier_type	73282932000074
status	string	État du compte de l'Entreprise : ACTIVE \| SUSPENDED \| CLOSED	ACTIVE

Exemple de réponse

{
    "corporate_name": "GAEC DU VERGER",
    "address": "LD BEAUREGARD",
    "postal_code": "16310",
    "city": "MONTEMBOEUF",
    "email": "gaec.verger@orange.fr",
    "id": "fef1b25a-e980-4bd6-9ced-e1c4df714665",
    "identifier_type": "SIRET",
    "business_identifier": "73282932000074",
    "status": "ACTIVE"
}

Modifier une Entreprise

Modification d'une Entreprise afin de mettre à jour certains de ses champs.

Requête

PATCH /companies/{company_id}

Body	Type	Obligatoire	Description
corporate_name ^*	string	Oui	Raison sociale de l'Entreprise
address ^*	string	Oui	Adresse postale de l'Entreprise
postal_code ^*	string	Oui	Code postal de la commune de l'Entreprise
city ^*	string	Oui	Commune de l'Entreprise
email	string	Non	Mail de contact de l'Entreprise

Exemple de requête

curl -X 'PATCH' \
  'https://www.agata-consent.com/companies/fef1b25a-e980-4bd6-9ced-e1c4df714665' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "gaec.verger@free.fr"
}'

Réponse

Code	Titre	Description
200	OK	Entreprise modifiée
400	Bad Request	Entreprise modifiée
404	Not Found	Entreprise introuvable
409	Conflict	Le corporate_mail ou email sont déjà connus sur une autre Entreprise

Body	Type	Description	Exemple
corporate_name	string	Raison sociale de l'Entreprise	GAEC DU VERGER
address	string	Adresse postale de l'Entreprise	LD BEAUREGARD
postal_code	string	Code postal de la commune de l'Entreprise	16310
city	string	Commune de l'Entreprise	MONTEMBOEUF
email	string	Mail de contact	gaec.verger@orange.fr
id	string	Identifiant unique (UUID) de l'Entreprise recherchée	fef1b25a-e980-4bd6-9ced-e1c4df714665
identifier_type	string	Type d'identifiant utilisé pour désigner l'Entreprise : SIRET \| SIREN \| NUMAGRIT \| NUMAGRIN	SIRET
business_identifier	string	Valeur de l'identifiant selon le type spécifié dans identifier_type	73282932000074
status	string	État du compte de l'Entreprise : ACTIVE \| SUSPENDED \| CLOSED	ACTIVE

Exemple de réponse

{
    "corporate_name": "GAEC DU VERGER",
    "address": "LD BEAUREGARD",
    "postal_code": "16310",
    "city": "MONTEMBOEUF",
    "email": "gaec.verger@orange.fr",
    "id": "fef1b25a-e980-4bd6-9ced-e1c4df714665",
    "identifier_type": "SIRET",
    "business_identifier": "73282932000074",
    "status": "ACTIVE"
}

Supprimer une Entreprise

La suppression d'une Entreprise correspond à une cessation d'activité : le statut de l'Entreprise passe alors à CLOSED. L'ensemble des Activités associées à l'Entreprise sont également clôturées : les dates de fin de toutes les Activités sont donc actualisées dans l'opération.

Requête

DELETE /companies/{company_id}

Paramètre	Type	Obligatoire	Description	Exemple
company_id ^*	string	Oui	Identifiant unique de l'Entreprise recherchée	73ca52fc-40b9-4c79-84d9-daae0462132b

Exemple de requête

curl -X 'DELETE' \
  'https://www.agata-consent.com/companies/73ca52fc-40b9-4c79-84d9-daae0462132b' \
  -H 'accept: application/json'

Réponse

Code	Titre	Description
200	OK	Succès
404	Not Found	Entreprise non trouvée

Body	Type	Description	Exemple
corporate_name	string	Raison sociale de l'Entreprise	GAEC DU VERGER
address	string	Adresse postale de l'Entreprise	LD BEAUREGARD
postal_code	string	Code postal de la commune de l'Entreprise	16310
city	string	Commune de l'Entreprise	MONTEMBOEUF
email	string	Mail de contact	gaec.verger@orange.fr
id	string	Identifiant unique (UUID) de l'Entreprise recherchée	fef1b25a-e980-4bd6-9ced-e1c4df714665
identifier_type	string	Type d'identifiant utilisé pour désigner l'Entreprise : SIRET \| SIREN \| NUMAGRIT \| NUMAGRIN	SIRET
business_identifier	string	Valeur de l'identifiant selon le type spécifié dans identifier_type	73282932000074
status	string	État du compte de l'Entreprise : ACTIVE \| SUSPENDED \| CLOSED	CLOSE

Exemple de réponse

{
    "corporate_name": "GAEC DU VERGER",
    "address": "LD BEAUREGARD",
    "postal_code": "16310",
    "city": "MONTEMBOEUF",
    "email": "gaec.verger@orange.fr",
    "id": "fef1b25a-e980-4bd6-9ced-e1c4df714665",
    "identifier_type": "SIRET",
    "business_identifier": "73282932000074",  
    "status": "CLOSE"
}