List of pools/spas
The list of pools/spas endpoint shall be used to retrieve the list of the pools/spas owned by the
user or shared with him.
The returned information includes the identifier of the pool/spa, needed further to requesting
pool/spa data, the name of the pool/spa, its type, volume, type of disinfection (chlorine, bromine
or salt) with information on the use of UV sanitizer or ozonator, its address and the date of last
modification.
Request
Method |
GET |
URL |
{{ url_prefix }}/pools |
Headers |
Authorization: Bearer {{ access_token }}
Accept: application/json
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate |
Example
GET /api/customer/v1/pools HTTP/1.1
Authorization: Bearer 4fc86e46a11abbb3914b90af3e21f2858f3376f5
Accept: application/json
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate
Response
Requests to the pools/spas list endpoint will generate the following JSON response:
[
{
"id": 234,
"name": "John's Pool",
"type": "outdoor_inground_pool",
"volume": 15,
"disinfection": {
"primary":
"chlorine",
"secondary": {
"uv_sanitizer":
true,
"ozonator":
false
}
},
"address": {
"street": "162 Avenue
Robert Schuman",
"zipcode":
"13760",
"city":
"Saint-Cannat",
"country":
"France",
"latitude":
43.612282,
"longitude":
5.3179397
},
"updated_at": "2019-11-27T23:00:21+0000"
},
{
...
}
]
Please note that volume is expressed in cubic meters (m3)
Pool/spa device
The pool/spa device endpoint shall be used to retrieve information about the device attached to a
pool/spa.
The returned information includes the universal unique identifier (UUID) of the device, its serial
number and firmware version.
Request
Method |
GET |
URL |
{{ url_prefix }}/pools/{{ pool_id }}/device |
Headers |
Authorization: Bearer {{ access_token }}
Accept: application/json
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate |
Example
GET /api/customer/v1/pools/234/device HTTP/1.1
Authorization: Bearer 4fc86e46a11abbb3914b90af3e21f2858f3376f5
Accept: application/json
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate
Response
Requests to the pool/spa device endpoint will generate the following JSON response:
{
"uuid": "1234567890ABCDEF",
"serial_number": "SN00001",
"sw_version": "1.5.1-stable"
}
Pool/spa configuration
The pool/spa configuration endpoint shall be used to retrieve information about the pool/spa settings
set by the user.
The returned information includes the ranges of temperature, pH, ORP, salt and TDS, as well as the
preferred maintenance weekday and the phone number of the pool guy (Service Company).
The maintenance day is a weekday expressed as a 0 to 6 value, 0 meaning Monday and 6 Sunday.
Request
Method |
GET |
URL |
{{ url_prefix }}/pools/{{ pool_id }}/configuration |
Headers |
Authorization: Bearer {{ access_token }}
Accept: application/json
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate |
Example
GET /api/customer/v1/pools/234/configuration HTTP/1.1
Authorization: Bearer 4fc86e46a11abbb3914b90af3e21f2858f3376f5
Accept: application/json
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate
Response
Requests to the pool/spa configuration endpoint will generate the following JSON response:
{
"temperature_low": 10,
"temperature_high": 30,
"ph_low": 7.6,
"ph_high": 8.5,
"orp_low": 400,
"orp_high": 900,
"salt_low": 3000,
"salt_high": 5000,
"tds_low": 250,
"tds_high": 2000,
"pool_guy_number": "0123456789",
"maintenance_day": 2
}
Please note that values are expressed in the following units:
- Temperature: Celsius degrees (°C)
- ORP: millivolts (mV)
- Salt: milligrams per liter (mg/L)
- TDS: parts per million (ppm)
Pool/spa shares
The pool/spa shares endpoint shall be used to retrieve the list of users with whom the pool/spa is
shared.
The returned information includes the first name, last name and email of the user and the date of
the share.
Request
Method |
GET |
URL |
{{ url_prefix }}/pools/{{ pool_id }}/shares |
Headers |
Authorization: Bearer {{ access_token }}
Accept: application/json
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate |
Example
GET /api/customer/v1/pools/234/shares HTTP/1.1
Authorization: Bearer 4fc86e46a11abbb3914b90af3e21f2858f3376f5
Accept: application/json
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate
Response
Requests to the pool/spa shares endpoint will generate the following JSON response:
[
{
"lastname": "Doe",
"firstname": "Jane",
"email": "jane@doe.org",
"shared_since": "2019-12-06T11:29:36+0000"
},
{
...
}
]