Add Organization (POST)
Adds an organization to your account.
http://api2.carmd.com/v2.0/org
Request Data
{
"orgParentID": "",
"name": "LargeFleets",
"customID": "org-1234"
}
Field | Type | Notes |
orgParentID | string | Required. The parent organization ID. If it does not have a parent, leave empty. Like Highlander, there may only be a single top level Organization. |
name | string | Required. May label this org by user friendly name of your choice. May use the same name on multiple orgs. |
customID | string | Required. May label this org by customID of your choice. customID should be unique. |
Response
{
{
"message": {
"code": 0,
"message": "OK",
"credentials": "Valid",
"version": "v2.0.0",
"account": "Free",
"method": "Add Organization",
"action": "POST",
"counter": 195
},
"data": {
"orgID": "54fd4ef03c108153ecafd554",
"customID": "ABC Marketing",
"orgName": "ABC Organization",
"path": ",ABC Organization,",
"orgParentID": null
}
}
Field | Type | Notes |
message | Message | |
data | Organization |
Message object
Field | Type | Notes |
code | string | Message code. |
message | string | Ok or Failed. |
credentials | string | Valid or Invalid. |
version | string | v2.0.0 |
account | string | Free or Premium |
method | string | Name of the API called |
action | string | returns a GET, POST, PUT, DELETE |
counter | integer | Counter for this request. Increments by one for every request made. This is only important for free users who have a limited number of API requests. |
list<Organization>
Field | Type | Notes |
orgName | string | Null or returns the user friendly name of this org. |
path | string | Organization path to this org. |
orgID | string | CarMD’s generated ID for this organization. This ID will always be unique to this organization. |
orgParentID | string | CarMD’s org ID for the parent of this org. If null, then this org is topmost org. |
customID | string | Null or returns the customID of this org. |
One level becomes tyranny to the individual vital source when it is allied to a!