GET api/company/{id}
This method gets the details of a specified company.
Error Messages
- 401/Unauthorised - Company Permissions not valid - User does have have permissions to view companies
- 404/Not Found - No companies found - There are no companies in this database
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | The company ID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Company with the id requested
CompanyView| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | The Company ID | integer |
None. |
| CustomProperties | Custom controls created with the Service Designer | Collection of EntityCustomPropertyView |
None. |
| LastUpdated | The date the Company was last updated | date |
None. |
| Name | The name of the company | string |
String length: inclusive between 0 and 50 |
| IsCustomer | Indicates whether the company is a customer | boolean |
None. |
| IsAgent | Indicates whether the company is an Agent | boolean |
None. |
| IsCarrier | Indicates whether the company is a Carrier | boolean |
None. |
| IsReseller | Indicates whether the company is a Reseller | boolean |
None. |
| IsSupplier | Indicates whether the company is a Supplier | boolean |
None. |
| IsOperator | Indicates whether the company is a Operator | boolean |
None. |
| IsProspect | Indicates whether the company is a Prospect | boolean |
None. |
| DateSigned | Date the customer was signed up | date |
None. |
| DateReceived | Date the customer's sign up information was entered into the system | date |
None. |
| DateLive | Date the customer was/will be live | date |
None. |
| LastContacted | Date the customer was last contacted | date |
None. |
| IsConsumer | Indicates whether the company is a consumer | boolean |
None. |