Request
|
Endpoint:
|
/api/sipt/sites/{site_id}
|
|
Example:
|
/api/sipt/sites/85
|
|
Method:
|
GET
|
|
Headers:
|
Accept: application/vnd.cloudlx.v1+json
|
|
Authorization: Bearer <access_token>
|
Response
Example:
{
"id": 85,
"customer_id": 165,
"customer_name": "My SIPT Customer",
"site_name": "HQ",
"address_1": "10a Customer House",
"address_2": "Customer Street",
"city": "New York",
"state": "NY",
"postcode": "10036",
"country_iso": "US",
"country_name": "United States",
"main_contact_first_name": "David",
"main_contact_last_name": "Baker",
"main_contact_job_title": "Sales Executive",
"main_contact_email": "m.contact@company.com",
"main_contact_phone": "07924589754",
"technical_contact_first_name": "Jane",
"technical_contact_last_name": "Smith",
"technical_contact_job_title": "Technical Officer",
"technical_contact_email": "t.contact@company.com",
"technical_contact_phone": "07924589755",
"emergency_contact_first_name": "John",
"emergency_contact_last_name": "Doe",
"emergency_contact_job_title": "Site Manager",
"emergency_contact_email": "e.contact@company.com",
"emergency_contact_phone": "07924589756",
"equipment_details": "Some details about the equipment installed here"
}
|
id
|
Description
|
The id for the customer site, used to perform actions on the site
|
|
Type
|
Number
|
|
Example
|
85
|
|
customer_id
|
Description
|
The id of the customer this site belongs to
|
|
Type
|
Number
|
|
Example
|
165
|
|
customer_name
|
Description
|
The name of the customer this site belongs to
|
|
Type
|
String
|
|
Example
|
My SIPT Customer
|
|
site_name
|
Description
|
The name of the site
|
|
Type
|
String
|
|
Example
|
HQ
|
|
address_1
|
Description
|
First line of the site address
|
|
Type
|
String
|
|
Example
|
10a Customer House
|
|
address_2
|
Description
|
Second line of the site address
|
|
Type
|
String
|
|
Example
|
Customer Street
|
|
cite
|
Description
|
The site town or city
|
|
Type
|
String
|
|
Example
|
New York
|
|
state
|
Description
|
The site state or county
|
|
Type
|
String
|
|
Example
|
NY
|
|
postcode
|
Description
|
The site postal code
|
|
Type
|
String
|
|
Example
|
10036
|
|
country_iso
|
Description
|
The ISO code of the country the site resides in
|
|
Type
|
Number
|
|
Example
|
US
|
|
country_name
|
Description
|
The name of the country the site resides in
|
|
Type
|
String
|
|
Example
|
United States
|
|
main_contact_first_name
|
Description
|
The first name of the site main contact
|
|
Type
|
String
|
|
Example
|
David
|
|
main_contact_last_name
|
Description
|
The last name of the site main contact
|
|
Type
|
String
|
|
Example
|
Baker
|
|
main_contact_job_title
|
Description
|
The job title of the site main contact
|
|
Type
|
String
|
|
Example
|
Sales Executive
|
|
main_contact_email
|
Description
|
The email address of the site main contact
|
|
Type
|
String
|
|
Example
|
m.contact@company.com
|
|
main_contact_phone
|
Description
|
The phone number of the site main contact
|
|
Type
|
String
|
|
Example
|
07924589754
|
|
technical_contact_first_name
|
Description
|
The first name of the site technical contact
|
|
Type
|
String
|
|
Example
|
Jane
|
|
technical_contact_last_name
|
Description
|
The last name of the site technical contact
|
|
Type
|
String
|
|
Example
|
Smith
|
|
technical_contact_job_title
|
Description
|
The job title of the site technical contact
|
|
Type
|
String
|
|
Example
|
Technical Officer
|
|
technical_contact_email
|
Description
|
The email address of the site technical contact
|
|
Type
|
String
|
|
Example
|
t.contact@company.com
|
|
technical_contact_phone
|
Description
|
The phone number of the site technical contact
|
|
Type
|
String
|
|
Example
|
07924589755
|
|
emergency_contact_first_name
|
Description
|
The first name of the site emergency contact
|
|
Type
|
String
|
|
Example
|
John
|
|
emergency_contact_last_name
|
Description
|
The last name of the site emergency contact
|
|
Type
|
String
|
|
Example
|
Doe
|
|
emergency_contact_job_title
|
Description
|
The job title of the site emergency contact
|
|
Type
|
String
|
|
Example
|
Site Manager
|
|
emergency_contact_email
|
Description
|
The email address of the site emergency contact
|
|
Type
|
String
|
|
Example
|
e.contact@company.com
|
|
emergency_contact_phone
|
Description
|
The phone number of the site emergency contact
|
|
Type
|
String
|
|
Example
|
07924589756
|
|
equipment_details
|
Description
|
The details of the equipment supplied to the site
|
|
Type
|
String
|
|
Example
|
Some details about the equipment installed here
|