GET api/sitecontact/{id}

This API method returns a list of site contacts by its site ID.

Error Messages
  • 401/Unauthorized - Invalid company permissions
  • 404/Not Found - No Site Contact not found for id= x - Specified ID is not assigned to a Site Contact

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id Siteid - The unique identifier for the Site being queried. integer

Required

Body Parameters

None.

Response Information

Resource Description

SiteContactView
NameDescriptionTypeAdditional information
Id The ID for the contact being queried integer

None.
SiteID The ID of the returned site integer

None.
LastUpdated The date/time that the site contact was last updated date

None.
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
Email 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.