## CRM-SDK
[](https://www.npmjs.com/package/crm-sdk)
[](https://www.npmjs.com/package/crm-sdk)
[](https://www.npmjs.com/package/crm-sdk)
Javascript Software Development Kit for Dynamics CRM Web API.
## Recommendation
This library was written while Microsoft was still inventing [Xrm.WebApi](https://docs.microsoft.com/en-us/powerapps/developer/model-driven-apps/clientapi/reference/xrm-webapi).
Nowadays the [Xrm Api](https://docs.microsoft.com/en-us/powerapps/developer/model-driven-apps/clientapi/reference) will do most for you.
This library may still be usefull when implementing a SPA, but we recommend using another NPM package to develop your D365 project.
Please have a look at the [HSO D365 Command Line Interface](https://www.npmjs.com/package/@hso/d365-cli). That [@hso/d365-cli](https://www.npmjs.com/package/@hso/d365-cli) package also contains a WebApi as wrapper to help you building odata queries in an easier way.
## Why another library
There are several SDK's available, so why another one?
* This library does paging for you (using @odata-nextLink to do multiple requests)
* This library always finds correct entitySetName (which is not always: LogicalName + 's')
* This library is promise based
* This library supports modules
* This library supports default [WebAPI](#webapi-example) like other libraries, but also
* This library supports extra [Entity abstraction](#entity-abstraction-example)
* This library supports [annotations](./Entity.md#6-annotation)
* This library supports getting [OptionSet](./WebAPI.md#219-getoptionset)
* This library supports [Webresource](./Entity.md#7-webresource) uploading/publishing
* This library supports [Translation](./Translation.md)
## Table of contents
- [Install](#install)
- [WebAPI example](#webapi-example)
- [WebAPI](./WebAPI.md)
- [Entity abstraction example](#entity-abstraction-example)
- [Entity abstraction](./Entity.md)
- [Contribute](./Contribute.md)
- [Copyright](#copyright-and-license)
## Install
### Install with Npm
```sh
$ npm install crm-sdk
```
#### Modules
```javascript
//app.js
import {WebAPI} from "crm-sdk";
WebAPI.retrieveEntity("account", "475b158c-541c-e511-80d3-3863bb347ba8").then(function (data) {
//todo logic here
});
```
#### Require
```javascript
//app.js
var CRMSDK = require("crm-sdk"); //umd
var WebAPI = CRMSDK.WebAPI;
WebAPI.retrieveEntity("account", "475b158c-541c-e511-80d3-3863bb347ba8").then(function (data) {
//todo logic here
});
```
### Install via download
[Download latest release](https://github.com/hso-nn/crm-sdk/releases/latest) and put reference to dist/CRMSDK.js in your index.html.
In example below, the app.js is your own application code.
If you only need CRMSDK.WebAPI, you can include WebAPI.js in index.html instead of CRMSDK.js.
```html
```
In app.js, The WebAPI will be available on window.CRMSDK scope. Example for using WebAPI below:
```javascript
//app.js
var WebAPI = window.CRMSDK.WebAPI;
WebAPI.retrieveEntity("account", "475b158c-541c-e511-80d3-3863bb347ba8").then(function (data) {
//todo logic here
});
```
## WebAPI example
### Index.html
```html
```
### app.js
```javascript
WebAPI.retrieveEntity("account", "475b158c-541c-e511-80d3-3863bb347ba8")
.then(function (accountData) {
WebAPI.updateEntity("account", accountData.accountid, {
emailaddress1: "test2@company.com"
}).then(function (data) {
console.log("saved " + data.accountid);
});
});
```
## Entity abstraction example
### Index.html
```html
```
### app.js
```javascript
var WebAPI = CRMSDK.WebAPI;
var Entity = CRMSDK.Entity;
Entity.get("account", "475b158c-541c-e511-80d3-3863bb347ba8")
.then(function (account) {
account.emailaddress1 = "test2@company.com";
account.save().then(function () {
console.log("saved! " + account.accountid);
});
});
```
## Copyright and license
Code and documentation copyright 2011-2017 Dynamics Software. Code released under the [MIT License](https://github.com/hso-nn/crm-sdk/blob/master/LICENSE).