GET api/company/{id}/Site/{siteid}/SiteContact
This method returns a list of site contacts for specific site of a specified company
Error Message
- 401/Unauthorised - Company permissions not valid - user does not have the permissions to view thie site
- 401/Unauthorised - Company permissions not valid to view site contacts
- 404/Not Found - Site contacts not found for ID - There are no site contacts for this ID x
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | The unique identifer for the company being queried. | integer |
Required |
siteid | The ID of the site being queried | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of site contacts for the company and site requested
Collection of SiteContactBaseName | Description | Type | Additional information |
---|---|---|---|
Title | The Title of the returned contact | string |
String length: inclusive between 0 and 4 |
Surname | The Surname of the returned contact | string |
String length: inclusive between 0 and 40 |
Christian | The Christian name of the returned contact | string |
Required String length: inclusive between 0 and 40 |
DDI | The DDI of the returned contact | string |
String length: inclusive between 0 and 34 |
Mobile | The Mobile number of the returned contact | string |
Data type: PhoneNumber String length: inclusive between 0 and 17 |
The Email Address of the returned contact | string |
Required Matching regular expression pattern: ^([a-zA-Z0-9_\-\.]+)@((\[?[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\]?)|(([a-zA-Z0-9\-]+\.)+)([a-zA-Z0-9]{2,63}))$ String length: inclusive between 0 and 255 |
|
Extension | The Extension of the returned contact | string |
String length: inclusive between 0 and 5 |
MainContact | Indicates whether the returned contact is the main contact | boolean |
None. |
PreventSDeskNotify | Prohibit incident emails | boolean |
None. |