Paper Letters

Get paper letter generation

Get the status and result of an owned paper letter generation

get/v1/paper-letters/generations/{generationId}

Request

  • Base URL: https://dev.api.bb.tricirc.de (the document declares no server; this is the origin it was published from)
  • URL: https://dev.api.bb.tricirc.de/v1/paper-letters/generations/{generationId}
  • Auth: session-cookie (a scheme the document does not define)

Path parameters

generationIdstring required

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

clientRequestIdstring required
completedAtstring date-time
createdAtstring date-time required
errorMessagestring
generationIdstring required
localestring required
modestring required
modelstring required
refundedboolean required
sourceCaseIdstring nullable required
sourceDocumentIdstring nullable required
startedAtstring date-time
statusstring required
updatedAtstring date-time required

Example response

{
  "$schema": "https://example.com/schemas/GenerationBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.