Ajouter une entreprise

L'API ajouter une entreprise permet aux utilisateurs de l'OD d'ajouter des entreprises sur leurs connexions

Pré-requis

• Posséder un compte OD
• Avoir créé une connexion PDP ou PPF

Requête

Pour ajouter une entreprise, on fait une requête PATCH sur le chemnin d'accès suivant:

v1/connexions/<identifiant connexion>

On doit passer:

• L'identifiant utilisateur de l'OD dans l'en-tête X-OD-User-ID
• Le contenu du patch au format JSON Patch dans le corps de la requête

Par exemple :

cURL

Requête d'ajout d'un régime fiscal

curl \
-X PATCH \
-H 'X-OD-User-ID: ${userId}' \
-H 'Content-Type: application/json; charset=utf-8' \
-d @entreprise.json \
http://<host>:<port>/v1/connexions/bff1b979-9788-44bc-aa38-7809795b58b7

Typescript

Requête d'ajout d'un régime fiscal

const url = 'http://<host>:<port>/v1/connexions/bff1b979-9788-44bc-aa38-7809795b58b7'
const data: string = fs.readFileSync('entreprise.json');
const response: AxiosResponse = await axios.patch(url, data, {
    headers: {
        'X-OD-User-ID': userId,
        'Content-Type': 'application/json; charset=utf-8',
    }
});

Fichier entreprise.json

[
    {
        "op": "add",
        "path": "/entreprises/-",
        "value": {
            "siren": "810319517",
            "nom": "Dougs"
        }
    }
]

Propriété	Valeur
op	add (on ajoute une entreprise)
path	/entreprises/-
value.siren	Numéro SIREN de l'entreprise: 9 chiffres sans espaces
value.nom	Nom de l'entreprise

Réponse

Si l'ajout a réussi, la réponse de l'OD est 204 No Content

Erreurs

Si une erreur s'est produite, les codes et messages suivants peuvent être retournés:

Code	Message
400 Bad Request	Requête invalide - Voir messages d'erreur
401 Unauthorized	Informations d'authentification invalides
403 Forbidden	Droits insuffisants pour effectuer cette action
404 Not Found	La connexion n'a pas été trouvée

Impact

• L'entreprise est maintenant ajoutée à la connexion
• Pour pouvoir l'utiliser, il faudra lui ajouter un régime fiscal