Tankoubon API

Get all tankoubons

GET http://lrr.tvc-16.science/api/tankoubons

Get list of Tankoubons paginated.

Query Parameters

Name	Type	Description
page	string	Page of the list of Tankoubons.

200

{
    "filtered": 2,
    "result": [
        {
            "archives": [
                "28697b96f0ac5858be2614ed10ca47742c9522fd",
                "4857fd2e7c00db8b0af0337b94055d8445118630",
                "fa74bc15e7dd2b6ec0dc2e10cc7cd4942867318a"
            ],
            "id": "TANK_1688616437",
            "name": "Test 1",
            "summary": "",
            "tags": ""
        },
        {
            "archives": [
                "fa74bc15e7dd2b6ec0dc2e10cc7cd4942867318a"
            ],
            "id": "TANK_1688693913",
            "name": "Test 2",
            "summary": "",
            "tags": ""
        }
    ],
    "total": 2
}

Get a single tankoubon

GET http://lrr.tvc-16.science/api/tankoubons/:id

Get the details of the specified tankoubon ID, with the archives list paginated.

Path Parameters

Name	Type	Description
id*	string	ID of the Tankoubon desired.

Query Parameters

Name	Type	Description
include_full_data	string	If set in 1, it appends a full_data array with Archive objects.
page	string	Page of the Archives list.

200 include_full_data = 0

{
    "filtered": 3,
    "result": {
        "archives": [
            "fa74bc15e7dd2b6ec0dc2e10cc7cd4942867318a",
            "28697b96f0ac5858be2614ed10ca47742c9522fd",
            "4857fd2e7c00db8b0af0337b94055d8445118630"
        ],
        "id": "TANK_1688616437",
        "name": "Test 1",
        "summary": "",
        "tags": ""
    },
    "total": 3
}

200 include_full_data = 1

{
    "filtered": 3,
    "result": {
        "archives": [
            "fa74bc15e7dd2b6ec0dc2e10cc7cd4942867318a",
            "28697b96f0ac5858be2614ed10ca47742c9522fd",
            "4857fd2e7c00db8b0af0337b94055d8445118630"
        ],
        "full_data": [
            {
                "arcid": "fa74bc15e7dd2b6ec0dc2e10cc7cd4942867318a",
                "extension": "zip",
                "isnew": "true",
                "lastreadtime": 0,
                "pagecount": 30,
                "progress": 0,
                "tags": "date_added:1688608157",
                "lastreadtime": 0,
                "title": "(C95) [wadamemo (WADA Rco)] Fate GO MEMO 3 (Fate Grand Order)"
            },
            {
                "arcid": "28697b96f0ac5858be2614ed10ca47742c9522fd",
                "extension": "zip",
                "isnew": "true",
                "lastreadtime": 0,
                "pagecount": 30,
                "progress": 0,
                "tags": "date_added:1688608157",
                "lastreadtime": 0,
                "title": "FateGOMEMO"
            },
            {
                "arcid": "4857fd2e7c00db8b0af0337b94055d8445118630",
                "extension": "zip",
                "isnew": "true",
                "lastreadtime": 0,
                "pagecount": 26,
                "progress": 0,
                "tags": "date_added:1688608157",
                "lastreadtime": 0,
                "title": "gits (2)"
            }
        ],
        "id": "TANK_1688616437",
        "name": "Test 1",
        "summary": "",
        "tags": ""
    },
    "total": 3
}

400

{
  "error": "The given tankoubon does not exist.",
  "operation": "get_tankoubon",
  "success": 0
}

🔑Create a Tankoubon

PUT http://lrr.tvc-16.science/api/tankoubons

Create a new Tankoubon or updated the name of an existing one.

Query Parameters

Name	Type	Description
name*	string	Name of the Category.

200

{
    "operation": "create_tankoubon",
    "success": 1,
    "tankoubon_id": "TANK_1690056313"
}

400

{
  "error": "Tankoubon name not specified.",
  "operation": "create_tankoubon",
  "success": 0
}

🔑Update a Tankoubon

PUT http://lrr.tvc-16.science/api/tankoubons/:id

Update a Tankoubon.

Path Parameters

Name	Type	Description
id*	string	ID of the Tankoubon to update.

Request Body

Name	Type	Description
archives*	json	Json with 2 optional keys "archives" and "metadata" defining: archives: Ordered array with the IDs of the archives. metadata: Json with the metadata parameters: name, summary, tags. Note: If there is no need to update something in one of the keys, do not send the key, otherwise can result on unwanted results.

200

{
    "error": "",
    "operation": "update_tankoubon",
    "success": 1,
    "successMessage": "Updated tankoubon \"Test 1\"!"
}

400

{
  "error": "rr doesn't exist in the database!",
  "operation": "update_tankoubon",
  "success": 0
}

🔑Add an archive to a Tankoubon

PUT http://lrr.tvc-16.science/api/tankoubons/:id/:archive

Append an archive at the final position of a Tankoubon.

Path Parameters

Name	Type	Description
id*	string	ID of the Tankoubon to update.
archive*	string	ID of the Archive to append.

200

{
    "error": "",
    "operation": "add_to_tankoubon",
    "success": 1,
    "successMessage": "Added \"(C95) [wadamemo (WADA Rco)] Fate GO MEMO 3 (Fate Grand Order)\" to tankoubon \"Test 1\"!"
}

400

{
  "error": "rr doesn't exist in the database!",
  "operation": "add_to_tankoubon",
  "success": 0
}

🔑Remove an archive from a Tankoubon

DELETE http://lrr.tvc-16.science/api/tankoubons/:id/:archive

Remove an archive from a Tankoubon.

Path Parameters

Name	Type	Description
id*	string	ID of the Tankoubon to update.
archive*	string	ID of the archive to remove.

200

{
    "error": "",
    "operation": "remove_from_tankoubon",
    "success": 1,
    "successMessage": "Removed \"(C95) [wadamemo (WADA Rco)] Fate GO MEMO 3 (Fate Grand Order)\" from tankoubon \"Test 1\"!"
}

400

{
  "error": "rr doesn't exist in the database!",
  "operation": "remove_from_tankoubon",
  "success": 0
}

🔑Delete a Tankoubon

DELETE http://lrr.tvc-16.science/api/tankoubons/:id

Remove a Tankoubon.

Path Parameters

Name	Type	Description
id*	string	ID of the Tankoubon to delete.

200

{
    "error": "",
    "operation": "delete_tankoubon",
    "success": 1,
    "successMessage": null
}