Stamps API

Endpoints related to Stamps.

Get Stamp

get

Get a stamp from an Archive.

Path parameters

idstringRequired

ID of the stamp.

Responses

200

Success response

application/json

JSON object for the Stamp model

idstringOptional

ID of the stamp

positionstringRequired

Position of the stamp in the page in normalized coordinates (0-100)

contentstringRequired

Text of the stamp

400

Error response

application/json

423

The Stamp is currently locked for modification

application/json

get/stamps/{id}

GET /api/stamps/{id} HTTP/1.1
Host: lrr.tvc-16.science
Accept: */*

{
  "position": "12,34",
  "content": "Lorem ipsum dolore"
}

🔑 Update Stamp

put

Update a stamp from an Archive.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstringRequired

ID of the stamp.

Query parameters

contentstringOptional

Text of the stamp.

positionstringOptional

Position of the stamp in the page.

Responses

200

Success response

application/json

operationstringRequired

Name of operation

errorstringOptional

Error message if any

successMessagestringOptional

Success message if any

successinteger · enumRequired

Returns 1 if operation was successful, else 0

Possible values:

400

Error response

application/json

423

The Stamp is currently locked for modification

application/json

put/stamps/{id}

PUT /api/stamps/{id} HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

{
  "operation": "text",
  "error": "text",
  "successMessage": "text",
  "success": 0
}

🔑 Delete Stamp

delete

Remove a stamp from an Archive.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstringRequired

ID of the stamp.

Responses

200

Success response

application/json

operationstringRequired

Name of operation

errorstringOptional

Error message if any

successMessagestringOptional

Success message if any

successinteger · enumRequired

Returns 1 if operation was successful, else 0

Possible values:

400

Error response

application/json

423

The Stamp is currently locked for modification

application/json

delete/stamps/{id}

DELETE /api/stamps/{id} HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

{
  "operation": "text",
  "error": "text",
  "successMessage": "text",
  "success": 0
}