Skip to main content

Create Lab Visit Short Link (v1)

Method & Path​

POST /api/v1/workspace/{workspaceId}/labs/visits/{labVisitId}/short-link

Description​

Creates (or reuses) a 10-character alphanumeric short code for the lab visit public print page. The short code is later resolved via the public endpoint and used by the client app as base/links/{code}.

Backend path

The backend is mounted under /v1, so the actual path is: POST /v1/workspace/{workspaceId}/labs/visits/{labVisitId}/short-link

Authentication​

Required: Workspace session auth (cookie)

Persona access:

  • Workspace Owner (root persona)
  • Staff (role-based) with permission: labs.view

Headers​

  • Content-Type: application/json
  • Cookie: placio_session=... (workspace session)

Path Parameters​

NameTypeRequiredDescription
workspaceIdstringYesWorkspace ID
labVisitIdstringYesLab visit ID

Query Parameters​

None

Request Body​

None

Response 201 Created​

{
  "code": "A1b2C3d4E5",
  "targetPath": "/public/labs/visits/3f2c.../print"
}

Common Errors​

  • 400 Bad Request: Invalid identifiers
  • 401 Unauthorized: Missing/invalid session
  • 403 Forbidden: Missing labs.view permission
  • 404 Not Found: Lab visit not found
  • 422 Unprocessable Entity: Validation error
  • 500 Internal Server Error: Unexpected failure