EvilFlowers Catalog (0.13.0)

Download OpenAPI specification:Download

EvilFlowersCatalog: jakub.dubec@stuba.sk URL: https://github.com/EvilFlowersCatalog/EvilFlowersCatalog License: MIT

A e-book catalog server compatible with OPDS 1.2, written in Python with a straightforward management REST API for CRUD operations.

API Keys

ApiKeyManagement.get

List ApiKeys

Authorizations:

basicAuthbearerAuth

query Parameters

user_id	string <uuid> User UUID (exact)
name	string API Key Name (unaccent, icontains)
last_seen_at__gte	string <date-time> None (gte)
last_seen_at__lte	string <date-time> None (lte)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"is_active": true,
"last_seen_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

ApiKeyManagement.post

Create ApiKey

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

user_id	string (user_id)
name	string (name) <= 100 characters
is_active	boolean (is_active)

Responses

Request samples

Payload

Content type

application/json

{"user_id": "string",
"name": "string",
"is_active": true
}

Response samples

201
403
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"is_active": true,
"last_seen_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

ApiKeyDetail.delete

Delete ApiKey

Authorizations:

basicAuthbearerAuth

path Parameters

api_key_id

required

string <uuid>

Responses

Response samples

204
404

Content type

application/json

{ }

Users

UserManagement.get

List users

Authorizations:

basicAuthbearerAuth

query Parameters

id	string <uuid> None (exact)
username	string None (icontains)
name	string None (unaccent, icontains)
surname	string None (unaccent, icontains)
is_active	boolean None (exact)
last_login_gte	string <date-time> None (gte)
last_login_lte	string <date-time> None (lte)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string",
"is_superuser": true,
"is_active": true,
"last_login": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

UserManagement.post

Create user

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

name required	string (name) <= 30 characters
surname required	string (surname) <= 150 characters
password required	string (password)
is_active	boolean (is_active)
username required	string (username) <= 200 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"surname": "string",
"password": "string",
"is_active": true,
"username": "string"
}

Response samples

201
403
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string",
"is_superuser": true,
"is_active": true,
"last_login": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

UserMe.get

Return detail of the current User

Authorizations:

basicAuthbearerAuth

Responses

Response samples

200
401

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string",
"is_superuser": true,
"is_active": true,
"last_login": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"permissions": ["string"
],
"catalog_permissions": {"property1": "read",
"property2": "read"
}
}
}

UserDetail.get

User detail

Authorizations:

basicAuthbearerAuth

path Parameters

user_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string",
"is_superuser": true,
"is_active": true,
"last_login": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"permissions": ["string"
],
"catalog_permissions": {"property1": "read",
"property2": "read"
}
}
}

UserDetail.put

Update User

Authorizations:

basicAuthbearerAuth

path Parameters

user_id

required

string <uuid>

Request Body schema: application/json

name required	string (name) <= 30 characters
surname required	string (surname) <= 150 characters
password	string (password)
is_active	boolean (is_active)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"surname": "string",
"password": "string",
"is_active": true
}

Response samples

200
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string",
"is_superuser": true,
"is_active": true,
"last_login": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

UserDetail.delete

Delete User

Authorizations:

basicAuthbearerAuth

path Parameters

user_id

required

string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

Catalogs

CatalogManagement.get

List Catalogs

Authorizations:

basicAuthbearerAuth

query Parameters

title	string None (unaccent, icontains)
url_name	string None (unaccent, icontains)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"url_name": "string",
"title": "string",
"is_public": true,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

CatalogManagement.post

Create Catalog

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

url_name required	string (url_name)
title required	string (title) <= 100 characters
is_public	boolean (is_public)
	Array of objects (users)

Responses

Request samples

Payload

Content type

application/json

{"url_name": "string",
"title": "string",
"is_public": true,
"users": [{"user_id": "string",
"mode": "read"
}
]
}

Response samples

201
403
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"url_name": "string",
"title": "string",
"is_public": true,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_catalogs": [ ]
}
}

CatalogDetail.get

Get Catalog detail

Authorizations:

basicAuthbearerAuth

path Parameters

catalog_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"url_name": "string",
"title": "string",
"is_public": true,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_catalogs": [ ]
}
}

CatalogDetail.put

Update Catalog

Authorizations:

basicAuthbearerAuth

path Parameters

catalog_id

required

string <uuid>

Request Body schema: application/json

url_name required	string (url_name)
title required	string (title) <= 100 characters
is_public	boolean (is_public)
	Array of objects (users)

Responses

Request samples

Payload

Content type

application/json

{"url_name": "string",
"title": "string",
"is_public": true,
"users": [{"user_id": "string",
"mode": "read"
}
]
}

Response samples

200
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"url_name": "string",
"title": "string",
"is_public": true,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_catalogs": [ ]
}
}

CatalogDetail.delete

Delete Catalog

Authorizations:

basicAuthbearerAuth

path Parameters

catalog_id

required

string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

Feeds

FeedManagement.get

List Feeds

Authorizations:

basicAuthbearerAuth

query Parameters

creator_id	string <uuid> None (exact)
catalog_id	string <uuid> None (exact)
title	string None (unaccent, icontains)
kind	string Enum: "navigation" "acquisition" None (exact)
parent_id	string None (exact)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

FeedManagement.post

Create Feed

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

catalog_id required	string (catalog_id)
title required	string (title) <= 100 characters
url_name required	string (url_name) <= 50 characters
kind required	string (kind) Enum: "navigation" "acquisition"
content required	string (content)
per_page	integer (per_page) >= 1
entries	string (entries)
parents	string (parents)

Responses

Request samples

Payload

Content type

application/json

{"catalog_id": "string",
"title": "string",
"url_name": "string",
"kind": "navigation",
"content": "string",
"per_page": 1,
"entries": "string",
"parents": "string"
}

Response samples

201
403
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

FeedDetail.get

Get Feed detail

Authorizations:

basicAuthbearerAuth

path Parameters

feed_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

FeedDetail.put

Update Feed

Authorizations:

basicAuthbearerAuth

path Parameters

feed_id

required

string <uuid>

Request Body schema: application/json

catalog_id required	string (catalog_id)
title required	string (title) <= 100 characters
url_name required	string (url_name) <= 50 characters
kind required	string (kind) Enum: "navigation" "acquisition"
content required	string (content)
per_page	integer (per_page) >= 1
entries	string (entries)
parents	string (parents)

Responses

Request samples

Payload

Content type

application/json

{"catalog_id": "string",
"title": "string",
"url_name": "string",
"kind": "navigation",
"content": "string",
"per_page": 1,
"entries": "string",
"parents": "string"
}

Response samples

200
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

FeedDetail.delete

Delete Feed

Authorizations:

basicAuthbearerAuth

path Parameters

feed_id

required

string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

Authors

AuthorManagement.get

List Authors

Authorizations:

basicAuthbearerAuth

query Parameters

catalog_id	string <uuid> None (exact)
name	string None (unaccent, icontains)
surname	string None (unaccent, icontains)
query	string None (exact)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

AuthorManagement.post

Create Author

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

name required	string (name) <= 255 characters
surname required	string (surname) <= 255 characters
catalog_id required	string (catalog_id)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"surname": "string",
"catalog_id": "string"
}

Response samples

201
403
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AuthorDetail.get

Get Author detail

Authorizations:

basicAuthbearerAuth

path Parameters

author_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AuthorDetail.put

Update Author

Authorizations:

basicAuthbearerAuth

path Parameters

author_id

required

string <uuid>

Request Body schema: application/json

name required	string (name) <= 255 characters
surname required	string (surname) <= 255 characters
catalog_id required	string (catalog_id)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"surname": "string",
"catalog_id": "string"
}

Response samples

200
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AuthorDetail.delete

Delete Author

Authorizations:

basicAuthbearerAuth

path Parameters

author_id

required

string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

CategoryManagement.get

List Categories

Authorizations:

basicAuthbearerAuth

query Parameters

catalog_id	string <uuid> None (exact)
term	string None (unaccent, iexact)
label	string None (unaccent, icontains)
scheme	string None (unaccent, icontains)
query	string None (exact)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"label": "string",
"scheme": "string"
}
]
}

CategoryManagement.post

Create Category

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

catalog_id	string (catalog_id)
term required	string (term) <= 255 characters
label	string (label) <= 255 characters
scheme	string (scheme) <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"catalog_id": "string",
"term": "string",
"label": "string",
"scheme": "string"
}

Response samples

201
403
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"label": "string",
"scheme": "string"
}
}

CategoryDetail.get

Get Category detail

Authorizations:

basicAuthbearerAuth

path Parameters

category_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"label": "string",
"scheme": "string"
}
}

CategoryDetail.put

Update Category

Authorizations:

basicAuthbearerAuth

path Parameters

category_id

required

string <uuid>

Request Body schema: application/json

catalog_id	string (catalog_id)
term required	string (term) <= 255 characters
label	string (label) <= 255 characters
scheme	string (scheme) <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"catalog_id": "string",
"term": "string",
"label": "string",
"scheme": "string"
}

Response samples

200
403
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"label": "string",
"scheme": "string"
}
}

CategoryDetail.delete

Delete Category

Authorizations:

basicAuthbearerAuth

path Parameters

category_id

required

string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

Entries

EntryPaginator.get

List Entries

Authorizations:

basicAuthbearerAuth

query Parameters

creator_id	string <uuid> None (exact)
catalog_id	string <uuid> None (exact)
catalog_title	string None (unaccent, icontains)
author_id	string <uuid> Author (exact)
author	string None (exact)
category_id	string <uuid> Category (exact)
category_term	string None (exact)
language_id	string <uuid> None (exact)
language_code	string Language (exact)
title	string None (unaccent, icontains)
summary	string None (unaccent, icontains)
query	string None (exact)
feed_id	string <uuid> None (exact)
published_at__gte	string None (exact)
published_at__lte	string None (exact)
config__readium_enabled	boolean None (exact)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

EntryIntrospection.get

Entry Introspection

Authorizations:

basicAuthbearerAuth

Responses

Response samples

200

Content type

application/json

{ }

EntryManagement.post

Create Entry object

Authorizations:

basicAuthbearerAuth

path Parameters

catalog_id

required

string <uuid>

Request Body schema: application/json

id	string (id)
language_code required	string (language_code) <= 3 characters
category_ids	string (category_ids)
	Array of objects (authors)
author_ids	string (author_ids)
feeds	string (feeds)
	Array of objects (categories)
title required	string (title) <= 255 characters
publisher	string (publisher) <= 255 characters
published_at	string (published_at)
summary	string (summary)
content	string (content)
	Array of objects (acquisitions)
identifiers	string (identifiers)
image	string <uri> (image)
	object (EntryConfigForm)
citation	string (citation)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"language_code": "str",
"category_ids": "string",
"authors": [{"name": "string",
"surname": "string"
}
],
"author_ids": "string",
"feeds": "string",
"categories": [{"catalog_id": "string",
"term": "string",
"label": "string",
"scheme": "string"
}
],
"title": "string",
"publisher": "string",
"published_at": "string",
"summary": "string",
"content": "string",
"acquisitions": [{"relation": "acquisition",
"prices": [{"currency_code": "string",
"value": 0
}
],
"content": "http://example.com"
}
],
"identifiers": "string",
"image": "http://example.com",
"config": {"evilflowers_ocr_enabled": true,
"evilflowers_ocr_rewrite": true,
"evilflowers_annotations_create": true,
"evilflowers_viewer_print": true,
"evilflowers_share_enabled": true,
"evilflowres_metadata_fetch": true,
"readium_enabled": true,
"evilflowers_render_type": "document"
},
"citation": "string"
}

Response samples

201
403
404
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"published_at": "string",
"publisher": "string",
"content": "string",
"identifiers": { }
}
}

EntryDetail.get

Gent Entry detail

Authorizations:

basicAuthbearerAuth

path Parameters

catalog_id required	string <uuid>
entry_id required	string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"published_at": "string",
"publisher": "string",
"content": "string",
"identifiers": { }
}
}

EntryDetail.post

Create Entry

Authorizations:

basicAuthbearerAuth

path Parameters

catalog_id required	string <uuid>
entry_id required	string <uuid>

Request Body schema: application/json

relation	string (relation) Enum: "acquisition" "open-access"
	Array of objects (prices)

Responses

Request samples

Payload

Content type

application/json

{"relation": "acquisition",
"prices": [{"currency_code": "string",
"value": 0
}
]
}

Response samples

201
400
422

Content type

application/json

{"response": {"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"base64": "string",
"checksum": "string"
}
}

EntryDetail.put

Update Entry

Authorizations:

basicAuthbearerAuth

path Parameters

catalog_id required	string <uuid>
entry_id required	string <uuid>

Request Body schema: application/json

id	string (id)
language_code required	string (language_code) <= 3 characters
category_ids	string (category_ids)
	Array of objects (authors)
author_ids	string (author_ids)
feeds	string (feeds)
	Array of objects (categories)
title required	string (title) <= 255 characters
publisher	string (publisher) <= 255 characters
published_at	string (published_at)
summary	string (summary)
content	string (content)
	Array of objects (acquisitions)
identifiers	string (identifiers)
image	string <uri> (image)
	object (EntryConfigForm)
citation	string (citation)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"language_code": "str",
"category_ids": "string",
"authors": [{"name": "string",
"surname": "string"
}
],
"author_ids": "string",
"feeds": "string",
"categories": [{"catalog_id": "string",
"term": "string",
"label": "string",
"scheme": "string"
}
],
"title": "string",
"publisher": "string",
"published_at": "string",
"summary": "string",
"content": "string",
"acquisitions": [{"relation": "acquisition",
"prices": [{"currency_code": "string",
"value": 0
}
],
"content": "http://example.com"
}
],
"identifiers": "string",
"image": "http://example.com",
"config": {"evilflowers_ocr_enabled": true,
"evilflowers_ocr_rewrite": true,
"evilflowers_annotations_create": true,
"evilflowers_viewer_print": true,
"evilflowers_share_enabled": true,
"evilflowres_metadata_fetch": true,
"readium_enabled": true,
"evilflowers_render_type": "document"
},
"citation": "string"
}

Response samples

200
409
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"published_at": "string",
"publisher": "string",
"content": "string",
"identifiers": { }
}
}

EntryDetail.delete

Delete Entry

Authorizations:

basicAuthbearerAuth

path Parameters

catalog_id required	string <uuid>
entry_id required	string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

Acquisitions

AcquisitionManagement.get

List Acquisitions

Authorizations:

basicAuthbearerAuth

query Parameters

entry_id	string <uuid> None (exact)
relation	string Enum: "acquisition" "open-access" None (exact)
mime	string None (exact)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}

AcquisitionManagement.post

Create Acquisition

Authorizations:

basicAuthbearerAuth

Responses

Response samples

501

Content type

application/json

{"title": "string",
"type": null,
"detail": null,
"trace": null,
"additional_data": null
}

AcquisitionDetail.get

Get Acquisition detail

Authorizations:

basicAuthbearerAuth

path Parameters

acquisition_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"base64": "string",
"checksum": "string"
}
}

AcquisitionDetail.put

Content of Acquisition is imutable from the API users perspective. You can only Acquisition metadata such as it's type (relation) or pricing.

Authorizations:

basicAuthbearerAuth

path Parameters

acquisition_id

required

string <uuid>

Request Body schema: application/json

relation	string (relation) Enum: "acquisition" "open-access"
	Array of objects (prices)

Responses

Request samples

Payload

Content type

application/json

{"relation": "acquisition",
"prices": [{"currency_code": "string",
"value": 0
}
]
}

Response samples

200
422

Content type

application/json

{"response": {"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"base64": "string",
"checksum": "string"
}
}

AcquisitionDetail.delete

Delete acquisition from the database. The related static files will be removed later during the orphans removal process - check GitHub docs.

Authorizations:

basicAuthbearerAuth

path Parameters

acquisition_id

required

string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

Shelf Records

ShelfRecordManagement.get

List ShelfRecords

Authorizations:

basicAuthbearerAuth

query Parameters

catalog_id	string <uuid> None (exact)
catalog_title	string None (unaccent, icontains)
entry_id	string <uuid> None (exact)
user_id	string <uuid> None (exact)
author_id	string <uuid> Author (exact)
author	string None (exact)
category_id	string <uuid> Category (exact)
category_term	string None (exact)
language_id	string <uuid> None (exact)
language_code	string Language (exact)
title	string None (unaccent, icontains)
summary	string None (unaccent, icontains)
query	string None (exact)
feed_id	string <uuid> None (exact)

Responses

Response samples

200
401

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"entry": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

ShelfRecordManagement.post

Create ShelfRecord

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

entry_id

required

string (entry_id)

Responses

Request samples

Payload

Content type

application/json

{"entry_id": "string"
}

Response samples

200
201
401
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"entry": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

ShelfRecordDetail.delete

ShelfRecord detail

Authorizations:

basicAuthbearerAuth

path Parameters

shelf_record_id

required

string <uuid>

Responses

Response samples

204
404

Content type

application/json

{ }

User Acquisitions

UserAcquisitionManagement.get

List UserAcquisitions

Authorizations:

basicAuthbearerAuth

query Parameters

user_id	string <uuid> None (exact)
acquisition_id	string <uuid> None (exact)
type	string None (iexact)
title	string None (unaccent, icontains)
expire_at__gte	string <date-time> None (gte)
expire_at__lte	string <date-time> None (lte)
created_at__gte	string <date-time> None (gte)
created_at__lte	string <date-time> None (lte)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "shared",
"range": "string",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string"
},
"acquisition": {"relation": "acquisition",
"mime": "application/pdf",
"url": null
},
"url": null,
"entry": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"expire_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

UserAcquisitionManagement.post

Create UserAcquisition

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

acquisition_id required	string (acquisition_id)
type required	string (type) Enum: "shared" "personal"
range	string (range)
expire_at	string <date-time> (expire_at)

Responses

Request samples

Payload

Content type

application/json

{"acquisition_id": "string",
"type": "shared",
"range": "string",
"expire_at": "2019-08-24T14:15:22Z"
}

Response samples

201
403
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "shared",
"range": "string",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string"
},
"acquisition": {"relation": "acquisition",
"mime": "application/pdf",
"url": null
},
"url": null,
"entry": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"expire_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

UserAcquisitionDetail.get

Get UserAcquisition

Authorizations:

basicAuthbearerAuth

path Parameters

user_acquisition_id

required

string <uuid>

UserAcquisition UUID

Responses

Response samples

200
403
404

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "shared",
"range": "string",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string"
},
"acquisition": {"relation": "acquisition",
"mime": "application/pdf",
"url": null
},
"url": null,
"entry": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"shelf_record_id": null,
"entry_authors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"surname": "string"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"term": "string"
}
],
"language": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
},
"feeds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"parents": [ ],
"children": [ ],
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"title": "string",
"kind": "navigation",
"url_name": "string",
"url": null,
"content": "string",
"per_page": null,
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"acquisitions": [{"relation": "acquisition",
"mime": "application/pdf",
"url": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"popularity": 0,
"title": "string",
"summary": "string",
"image_url": null,
"image_mime": "string",
"thumbnail_url": null,
"config": { },
"citation": "string",
"touched_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"expire_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Annotations

AnnotationManagement.get

List Annotations

Authorizations:

basicAuthbearerAuth

query Parameters

user_acquisition_id	string <uuid> None (exact)
title	string None (icontains)
user_id	string <uuid> None (exact)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_acquisition_id": "5839a804-7206-46c5-8771-3311902b8d95",
"title": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

AnnotationManagement.post

Create Annotation

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

user_acquisition_id required	string (user_acquisition_id)
title required	string (title)

Responses

Request samples

Payload

Content type

application/json

{"user_acquisition_id": "string",
"title": "string"
}

Response samples

201
403
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_acquisition_id": "5839a804-7206-46c5-8771-3311902b8d95",
"title": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AnnotationDetail.get

Get Annotation detail

Authorizations:

basicAuthbearerAuth

path Parameters

annotation_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_acquisition_id": "5839a804-7206-46c5-8771-3311902b8d95",
"title": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AnnotationDetail.put

Update Annotation

Authorizations:

basicAuthbearerAuth

path Parameters

annotation_id

required

string <uuid>

Request Body schema: application/json

title

required

string (title)

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Response samples

200
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_acquisition_id": "5839a804-7206-46c5-8771-3311902b8d95",
"title": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AnnotationDetail.delete

Delete Annotation

Authorizations:

basicAuthbearerAuth

path Parameters

annotation_id

required

string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

Annotation Items

AnnotationItemManagement.get

List AnnotationItems

Authorizations:

basicAuthbearerAuth

query Parameters

annotation_id	string <uuid> None (exact)
page_number	integer <int32> None (exact)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"annotation_id": "4ed848c0-ec87-421a-9ec8-c4a4b0948c2a",
"page": 0,
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

AnnotationItemManagement.post

Create AnnotationItem

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

annotation_id required	string (annotation_id)
content required	string (content)
page required	integer (page)

Responses

Request samples

Payload

Content type

application/json

{"annotation_id": "string",
"content": "string",
"page": 0
}

Response samples

201
403
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"annotation_id": "4ed848c0-ec87-421a-9ec8-c4a4b0948c2a",
"page": 0,
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AnnotationItemDetail.get

Get AnnotationItem detail

Authorizations:

basicAuthbearerAuth

path Parameters

annotation_item_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"annotation_id": "4ed848c0-ec87-421a-9ec8-c4a4b0948c2a",
"page": 0,
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AnnotationItemDetail.put

Update AnnotationItem detail

Authorizations:

basicAuthbearerAuth

path Parameters

annotation_item_id

required

string <uuid>

Request Body schema: application/json

annotation_id required	string (annotation_id)
content required	string (content)
page required	integer (page)

Responses

Request samples

Payload

Content type

application/json

{"annotation_id": "string",
"content": "string",
"page": 0
}

Response samples

200
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"annotation_id": "4ed848c0-ec87-421a-9ec8-c4a4b0948c2a",
"page": 0,
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

AnnotationItemDetail.delete

Delete AnnotationItem

Authorizations:

basicAuthbearerAuth

path Parameters

annotation_item_id

required

string <uuid>

Responses

Response samples

204

Content type

application/json

{ }

StatusManagement.get

Authorizations:

basicAuthbearerAuth

Responses

Response samples

200
503

Content type

application/json

{ }

Tokens

RefreshTokenManagement.post

Refresh Access Token

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

refresh

required

string (refresh)

Responses

Request samples

Payload

Content type

application/json

{"refresh": "string"
}

Response samples

200
401
422

Content type

application/json

{"response": {"access_token": "string"
}
}

AccessTokenManagement.post

Create Access Token

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

username required	string (username) <= 200 characters
password required	string (password)

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

200
401
422

Content type

application/json

{"response": {"access_token": "string",
"refresh_token": "string",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"name": "string",
"surname": "string",
"is_superuser": true,
"is_active": true,
"last_login": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"permissions": ["string"
],
"catalog_permissions": {"property1": "read",
"property2": "read"
}
}
}
}

Enums

LanguageManagement.get

List languages

Authorizations:

basicAuthbearerAuth

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"alpha2": "string",
"alpha3": "string"
}
]
}

Licenses

LicenseManagement.get

List Licenses

Authorizations:

basicAuthbearerAuth

query Parameters

user_id	string <uuid> User UUID (exact)
entry_id	string <uuid> Entry UUID (exact)
state	string Enum: "draft" "active" "returned" "expired" "revoked" "cancelled" The current state of the license (exact)
starts_at__gte	string <date-time> Licenses that started after the specific datetime (ISO8601) (gte)
starts_at__lte	string <date-time> Licenses that started before the specific datetime (ISO8601) (lte)
expires_at__gte	string <date-time> Licenses that expired after the specific datetime (ISO8601) (gte)
expires_at__lte	string <date-time> Licenses that expired before the specific datetime (ISO8601) (lte)

Responses

Response samples

200

Content type

application/json

{"metadata": {"page": 0,
"limit": 0,
"pages": 0,
"total": 0
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"entry_id": "31513983-613b-4481-b270-ae929f358bae",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"state": "draft",
"starts_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

LicenseManagement.post

Create a new license

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

entry_id required	string (entry_id)
state required	string (state) Enum: "draft" "active" "returned" "expired" "revoked" "cancelled"
duration required	string (duration) ^P(?!P)(?:(\d+Y)?(\d+M)?(\d+D)?(T(?:(\d+H)?(\... Duration in ISO 8601 format. Example: "PT1H30M" for 1 hour and 30 minutes. The format is defined as follows: "P" indicates the period. "Y" for years, "M" for months, "D" for days. "T" indicates the start of the time section. "H" for hours, "M" for minutes, "S" for seconds. Valid examples include: "PT30M" (30 minutes) "P1Y2M10DT5H30M" (1 year, 2 months, 10 days, 5 hours, and 30 minutes)
starts_at	string <date-time> (starts_at)

Responses

Request samples

Payload

Content type

application/json

{"entry_id": "string",
"state": "draft",
"duration": "P14D",
"starts_at": "2019-08-24T14:15:22Z"
}

Response samples

201
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"entry_id": "31513983-613b-4481-b270-ae929f358bae",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"state": "draft",
"starts_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

LicenseDetail.get

Get License detail

Authorizations:

basicAuthbearerAuth

path Parameters

license_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"entry_id": "31513983-613b-4481-b270-ae929f358bae",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"state": "draft",
"starts_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

LicenseDetail.put

Update License

Authorizations:

basicAuthbearerAuth

path Parameters

license_id

required

string <uuid>

Request Body schema: application/json

state

required

string (state)

Enum: "draft" "active" "returned" "expired" "revoked" "cancelled"

duration

required

string (duration) ^P(?!P)(?:(\d+Y)?(\d+M)?(\d+D)?(T(?:(\d+H)?(\...

Duration in ISO 8601 format. Example: "PT1H30M" for 1 hour and 30 minutes. The format is defined as follows:

"P" indicates the period.
"Y" for years, "M" for months, "D" for days.
"T" indicates the start of the time section.
"H" for hours, "M" for minutes, "S" for seconds.
Valid examples include:
- "PT30M" (30 minutes)
- "P1Y2M10DT5H30M" (1 year, 2 months, 10 days, 5 hours, and 30 minutes)

Responses

Request samples

Payload

Content type

application/json

{"state": "draft",
"duration": "P14D"
}

Response samples

200
422

Content type

application/json

{"response": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"entry_id": "31513983-613b-4481-b270-ae929f358bae",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"state": "draft",
"starts_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Files

AcquisitionDownload.get

Download Acquisition content

Authorizations:

basicAuthbearerAuth

path Parameters

acquisition_id

required

string <uuid>

Responses

Response samples

401
403
404

Content type

application/json

{"title": "string",
"type": null,
"detail": null,
"trace": null,
"additional_data": null
}

UserAcquisitionDownload.get

Download UserAcquisition content

Authorizations:

basicAuthbearerAuth

path Parameters

user_acquisition_id

required

string <uuid>

Responses

Response samples

401
403
404

Content type

application/json

{"title": "string",
"type": null,
"detail": null,
"trace": null,
"additional_data": null
}

EntryImageDownload.get

Download Entry cover image

Authorizations:

basicAuthbearerAuth

path Parameters

entry_id

required

string <uuid>

Responses

Response samples

404

Content type

application/json

{"title": "string",
"type": null,
"detail": null,
"trace": null,
"additional_data": null
}

EntryThumbnailDownload.get

Download Entry thumbnail

Authorizations:

basicAuthbearerAuth

path Parameters

entry_id

required

string <uuid>

Responses

Response samples

404

Content type

application/json

{"title": "string",
"type": null,
"detail": null,
"trace": null,
"additional_data": null
}