List Styles

List Styles

GET

/api/portal/v1/styles

Description

List all styles on the account, ordered most recent first.

Authentication

This endpoint requires a Bearer token in the Authorization header.

  • Authorization: Bearer <token>. A valid Portal API session token or API token.

Response Schema

The endpoint returns an array of style records.

  • id: The unique identifier for the style. Use this in the Core API as ?styleId=<id> to render with this style.
  • name: The display name of the style.
  • userEmail: The email of the user who created the style.
  • createdAt: Timestamp when the style was created, in milliseconds since unix epoch.
  • updatedAt: Timestamp when the style was last modified, in milliseconds since unix epoch.
  • parameters: The rendering parameters for the style. See Styles for the schema.

Error Responses

  • 401 Unauthorized: The Authorization header is missing or the token is not valid.
Example Request
GET https://<your-host>:9909/api/portal/v1/styles
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
            }
        }
    }
]
VectorCharts.com © 2024, Zydro Marine Technologies, Inc. · vectorcharts.com