Get S-63 Permit

Get S-63 Permit

GET

/api/portal/v1/charts/getPermit

Description

Return the S-63 user permit currently assigned to the account. The permit is the identifier you provide to a chart distributor when requesting encrypted S-63 charts. The distributor uses the permit to encrypt charts so that they can only be decrypted by your OEM instance.

If a chart distributor has issued you a .prm file, upload it through Upload Chart to install the permit on the account.

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

On success, the endpoint returns the permit assigned to the account.

  • permitId: The S-63 user permit string.

Error Responses

  • 401 Unauthorized: The Authorization header is missing or the token is not valid.
  • 404 Not Found: No S-63 permit has been installed on the account.
Example Request
GET https://<your-host>:9909/api/portal/v1/charts/getPermit
Authorization: Bearer <token>

Example Response
Status Code: 200 OK
Response Body:
{
    "permitId": "01234567ABCDEF0123456789ABCDEF01"
}
VectorCharts.com © 2024, Zydro Marine Technologies, Inc. · vectorcharts.com