API docs by Redocly

API Documentation (1.0.0)

Download OpenAPI specification:Download

search_paintings

This endpoint handles the search for paintings and retrieves paintings.

query Parameters
query
string

The query string to search for paintings.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

split_view

The endpoint for retrieving images for split view.

path Parameters
pk
required
integer

The ID for the painting.

Responses

raking_view

The endpoint for raking view.

path Parameters
painting_id
required
integer

The ID of the painting

Responses

overlay

Endpoint to retrieve overlay data for a specific painting.

path Parameters
pk
required
integer

The ID of the painting

Responses

process_image

Endpoint to process an image with optional compression

query Parameters
image_path
required
string

The path to the image to be processed.

compress
integer >= 0

The compression value for resizing the image.

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

painting_view

Endpoint to retrieve the painting view page.

path Parameters
painting_id
required
integer

The ID of the painting to be viewed.

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

process annotation

Endpoint to process annotation actions including creation, deletion, and update. This is part of post request in painting view.

path Parameters
painting_id
required
integer

The ID of the painting.

Request Body schema: application/json
required
action
string
Enum: "getAnnotation" "createAnnotation" "deleteAnnotation" "updateAnnotation"
annotation
string
previous
string

Responses

Request samples

Content type
application/json
{
  • "action": "getAnnotation",
  • "annotation": "string",
  • "previous": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { }
}

logout

Endpoint to logout the current user and clear the session.

Responses