Company
Company provides access to the company resource. This is where all conmpany details are held.
Company Properties
Property | Example | Description |
---|---|---|
id | "7AE1E6..." | Unique id for the company |
code | "ILEVEL" | Company code |
name | "i.Level Software Limited" | Company name |
detail | object | Object containing address, email, telephone and terms and conditions |
company_sponsor | related entity | Releted sponser that is hosting the service for this company |
company_brand | [related entities] | A collection of brand details for the company see Brand resource |
Company Methods
GET | /api/company |
---|
Returns all companies applicable to the current user scope.
Example
Example of a returned company entity with included related entities
{
"response": {
"page": 1,
"pageCount": 1,
"recordsSent": 1,
"recordsFound": 1,
"company": [
{
"id": "7AE1E6E5FAE546499B36C013916DDEEC",
"name": "i.Level Software Limited",
"detail": {
"address": {
"line1": "2nd Floor Broadway House",
"line2": "The Broadway",
"line3": "Line 3",
"town": "Bedford",
"county": "Bedfordshire",
"postcode": "MK42 2TE",
"countryCode": "GB"
},
"email": "help@ilevelsupport.co.uk",
"telephone": "01234 761757",
"terms": "i.LEVEL's terms and conditions"
},
"code": "ILEVEL",
"company_sponsor": {
"id": "9197BDF4B09F8543B4247E525EBD64A6",
"name": "Test",
"detail": null
},
"company_brand": [
{
"id": "17076BDDE29E96478A3F1C8E711BF122",
"name": "i.LEVEL",
"detail": null,
"code": "ILEVEL",
"brand_company": {
"__KEY": "7AE1E6E5FAE546499B36C013916DDEEC"
}
}
]
}
]
}
}