Organization API family
CarMD’s APIs allows the creation of complex hierarchies. The Organization API family is provided allowing you to set up your account with a custom org structure. You may use this org hierarchy to organize your clients on our account as you see fit.
This service is provided for businesses who may have many clients under different account management and is completely optional
Provides the list of added organizations.
GET
http://sandbox-api2.carmd.com/v2.0/organizations
"Message": {
"Code": 0,
"Message": "Get organizations successfully."
},
{
"CurrentPage": 1,
"PageCount": 1,
"Count": 1,
"Organizations": [
{
"Id": "534237d331ece61eb0d4e052",
"ExternalId": "technical-services-new",
"CompanyId": "5342299631ece61eb0d4e051",
"Name": "Technical Services 1",
"Path": ",Technical Services 1,",
"ParentId": null
}
]
}Adds an organization to your account.
POST
http://sandbox-api2.carmd.com/v2.0/organizations
{
"ExternalId": "TestDept",
"Name": "Testing Dept"
}{
"Message": {
"Code": 0,
"Message": "The organization has been created."
},
"Data": {
"Id": "53617f8180596c20b81ed569",
"ExternalId": "Hoa-TestDept",
"CompanyId": "5342299631ece61eb0d4e051",
"Name": "Testing Dept",
"Path": " Testing Dept,",
"ParentId": null
}
}Removes an organization from your account. All fleets and vehicles will be disassociated as a result of this action.
DELETE
http://sandbox-api2.carmd.com/v2.0/Organizations/{organizationsId}
{
"Message": {
"Code": 0,
"Message": "The organization has been removed."
},
"Data" : []Updates an existing organization.
PUT
http://sandbox-api2.carmd.com/v2.0/Organizations/{organizationsId}
{
"Name":" Technical Services 1 New"
}{
"Message": {
"Code": 0,
"Message": "The organization has been updated."
},
"Data": {
"Id": "534237d331ece61eb0d4e052",
"ExternalId": "technical-services-new",
"CompanyId": "5342299631ece61eb0d4e051",
"Name": "Technical Services 1 New",
"Path": ",Technical Services 1 New,",
"ParentId": null
}
}