GET api/company/{id}/Site
This method returns a list of the sites for the specified company. This method will make it easier to display information on a particular site if the company ID is known
Error Messages
- 404/Not Found - No Sites found - No sites found on company with specified ID
- 401/Unauthorised - Company permissions invalid - User does not have the required permissions to view this company
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | The unique identifer for the company being queried. | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of sites for the company requested
Collection of SiteView| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | The unique identifier for the site. | integer |
None. |
| CompanyId | The unique identifier of the parent company. | integer |
None. |
| BillingAddress | The site ID of the billing site i.e. any billable items for this site will be invoiced to the billing site. | integer |
None. |
| CustomProperties | Custom controls created with the Service Designer | Collection of EntityCustomPropertyView |
None. |
| BillRunIDLocal | Site Bill Run ID | integer |
None. |
| BillRunNameLocal | Site Bill Run Name | string |
None. |
| BillRunIDInherited | Default Bill Run ID | integer |
None. |
| BillRunNameInherited | Default Bill Run Name | string |
None. |
| LastUpdated | The date and time the CLI has been updated | date |
None. |
| SiteName | The name for the site. | string |
Required String length: inclusive between 0 and 255 |
| ShortName | A reference name for the site. | string |
Required String length: inclusive between 0 and 255 |
| Address | Address information for the site. | string |
String length: inclusive between 0 and 255 |
| Town | Address information for the site. | string |
String length: inclusive between 0 and 50 |
| County | Address Information for the site. | string |
String length: inclusive between 0 and 50 |
| PostCode | The Postcode for the site. | string |
String length: inclusive between 0 and 20 |
| Fax | The main fax number for the site. | string |
String length: inclusive between 0 and 30 |
| Telephone | The main telephone number for the site. | string |
String length: inclusive between 0 and 30 |
| MainSite | The site is the main site for the Company. | boolean |
None. |
| AccountRef | The Account Reference number | string |
String length: inclusive between 0 and 30 |