Sign in

v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB
Public URLs

Create Certificate URL

Create a public access URL for a set of certificates.

Certificates can be associated with a site, or with a list of works, but not both. In either case, the certificates can be restricted to certain certificate types, and will be grouped by user.

So, a public certificate link will list all certificates with the specified certificate types associated with the specified site grouped by user; or it will list all certificates with the specified certificate type associated with the specified users regardless of site.

post/v1/public-access/certificate/

Request body

namestring required

A name that will be used when a user navigates to the public certificate URL

certificateTypeIdsinteger[]

IDs of the certificate types to display at the public certificate URL. If left blank, will include all certificate types

siteIdinteger nullable

ID of the site that the certificates are for. Either this or user_ids should be provided

userIdsinteger[] nullable

IDs of the workes to list certificates for. Either this or site_id should be provided

Example request

{
  "name": "Downtown Site Certificates",
  "certificateTypeIds": [
    123,
    45,
    2034
  ],
  "siteId": 1,
  "userIds": [
    1,
    123,
    2055
  ]
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "id": 1,
    "url": "https://portal.salussafety.io/public/action/86E69EFA-2A59-4A38-BBC6-AA6AA62BFB08",
    "name": "Downtown Info Packet",
    "entity": "bundle",
    "shortCode": "de8b0x"
  }
}