api/v1/crm/org
CrmOrg model represents organization in the elDoc system. This REST API Reference describes available methods for the CrmOrg objects.
API overview
Method | API endpoint |
---|---|
Get CRM organization data | GET api/v1/crm/org/{id} |
Create or updated CRM organization | POST api/v1/crm/org |
Get CRM organization data
URL & Method & Description
GET api/v1/crm/org/{id}
Retrieves CRM organisation data.
Request:
Request (sample)
GET https://eldoc.domain.com/api/v1/crm/org/{id}
Param | Type | Description | Sample values (comma separated) |
---|---|---|---|
{id} | Path param | Full id (24 hex-character) of the CrmOrg | 59e351e8805645140093721, 59e351e8805645140093722 |
Response:
Response headers
Content-Type: application/json
Response body (sample)
{ "_id": "59e351e8805645140093721", "owner": "usr-a55dc9cd-1ecd-474-955a-8383c666702d", "author": "api-f55dc9cd-1ecd-474-955a-8383c666549f", "description": "", "orgname": "dms-solutions" "orgarea": "59e351da8056451460093702", "orgnameext": "", "orgstateid": "", "orgtype": "59e351da8056451460093705", "_meta": { "_created": "2015-12-28T05:16:09Z", "_lastmodified": "2016-07-02T13:54:21Z", "_rev": 0 } "_id_web": "A2" }
Create or updated CRM organization
URL & Method & Description
POST api/v1/crm/org
Retrieves CRM organisation data.
Access rights requirement
Method requires [elAdminCrmRW] role
Request:
Request (sample)
POST https://eldoc.domain.com/api/v1/crm/org
Request body (sample)
{ "_id": "59e351e8805645140093722", "owner": "usr-f55dc9cd-1ecd-474-955a-8383c666549a", "orgname": "dms-solutions" "tags":"tag1" "orgnameext": "", "orgstateid": "", "cfdata":[ ] }, }
Response:
Response headers
Content-Type: application/json
Response body (sample)
{ "_meta": { "_created": "2020-03-06T10:45:43Z", "_rev": 0 } "author": "api-f55dc9cd-1ecd-474-955a-8383c666549f", "owner": "usr-f55dc9cd-1ecd-474-955a-8383c666549a", "orgname": "dms-solutions" "orgtype": "", "orgarea": "", "description": "", "orgstateid": "", "_id_web": "A6" "_id": "5e6229d8c5a8ef1cfaf3a174" }
Last modified: April 28, 2023