Get Style
Get Style
GET
/api/portal/v1/styles/{id}
Description
Return the style with the given id. The style must belong to the caller’s account.
Authentication
This endpoint requires a Bearer token in the Authorization header.
- Authorization:
Bearer <token>. A valid Portal API session token or API token.
Path Parameters
- id: The
idof the style to retrieve.
Response Schema
The endpoint returns a single style record. The shape matches an entry from List Styles.
Error Responses
- 401 Unauthorized: The
Authorizationheader is missing or the token is not valid. - 404 Not Found: No style exists with the given
idon the caller’s account.
Example Request
GET https://<your-host>:9909/api/portal/v1/styles/42
Authorization: Bearer <token>
Example Response
Status Code: 200 OK
Response Body:
{
"id": 42,
"name": "Vessel Map",
"userEmail": "example@zydromarine.com",
"createdAt": 1736942400000,
"updatedAt": 1736946000000,
"parameters": {
"colors": { ... },
"settings": {
"iconSet": "enc-day",
"soundingOpacity": 0.5,
"showLightSectors": true
}
}
}