1

stamp

Interitio edited this page 2025-06-18 19:33:50 +10:00

Table of Contents

• Stamp

Stamp

Represents a document stamp.

field	type	required	description
stamp_id	integer	-	UID for this stamp (unique amongst all stamps on all documents)
document_id	integer	yes	UID for the Document that this stamp belongs to.
stamp_type	string	yes	Stamp type, can be any string
pos_x	integer	yes	x coordinate
pos_y	integer	yes	y coordinate
rotation	float	yes	Rotation

• POST /stamps
  • Create and return a Stamp.
  • Should generally not be used directly. Instead, create the Stamp with the Document or with POST /documents/{document_id}/stamps
• PUT /stamps
  • Create and return a list of Stamps.
  • Should generally not be used directly. Instead, create the Stamps with the Document or with PUT /documents/{document_id}/stamps
• GET /stamps
  • Get all Stamps matching the given parameters.
  • Supported filter parameters: stamp_id, document_id, stamp_type
• GET /stamps/{stamp_id}
  • Returns a Stamp with the given stamp_id, or raises Not Found if no stamp exists.
• PATCH /stamps/{stamp_id}
  • Updates the given Stamp.
  • Supports any settable field.
• DELETE /stamps/{stamp_id}
  • Delete the specified Stamp.