bpixrm/dynamics/dynamics.md

Bpifrance XRM Package

Ce document présente les fonctions principales de la lib Bpi XRM Dynamics

# Comment inistialiser l'objet  IDynamicsService
`````
        const iDynamicsService = new IDynamicsService(accessToken, resourceId, resourceRefBase);
`````
avec les paramètres suivants:
* ```accessToken```: Le token valide de MsADAL
* ```resourceId```: L'adresse de l'environnement Dynamis (par exemple: 'https://xxx-dev-v2.crm4.dynamics.com')
* ```accessToken```: Par exemple '/api/data/v8.2/' pour désigner la version 8.2 de Dynamics



# Comment récupérer l'identifiant unique d'un utilisateur de XRM?

Il faudra faire appel à la fonction ```IDynamicsService.whoAmI()```

Cette fonction, comme la majorité des fonctions de la lib, est un Promise.

La valeur de retour de la fonction est l'identifiant unique de l'utilisateur actuel comme identifié dans XRM sous format d'un GUID (string).


# Entreprise

## Comment récupérer un objet Entreprise (account) par son code SIREN
La fonction ```getCompanyBySiren(numero de siren)``` permet de renvoyer un objet de type ```CompanyType```.

L'identifiant unique de l'entité est accessible via l'attribut ```.guid```.


## Comment récupérer un objet Entreprise (account) par son code CP
La fonction ```getCompanyByCP(codecp)``` permet de renvoyer un objet de type ```CompanyType```.

L'identifiant unique de l'entité est accessible via l'attribut ```.guid```.


# Comment avoir la liste des SuiviPar

Pour récupérer la liste dees sociétés suiviPar, il faudra faire appel à la fonction ```getPortfolio``` en passant l'adresse email de l'utilisateur
```
getPortfolio("xxx@bpifrance.fr.fr");
```


# Ajout ou retrait d'une entreprise à un portefeuille

## Pour suivre une entreprise

Pour suivre une entreprise, il faudra faire appel à la fonction ```addCompanyToPortfolio```

Cette fonction a besoin des paramètress suivants:
* numéro unique de l'entreprise à suivre (guid)
* identifiant unique de l'utilisateur qui souhaite suivre l'entreprise


## Pour ne plus suivre une entreprise

Pour ne plus suivre une entreprise, il faudra faire appel à la fonction ```removeCompanyFromPortfolio```

Cette fonction a besoin des paramètress suivants:
* numéro unique de l'entreprise à suivre (guid)
* identifiant unique du record de suiviPar