Category API

Endpoints related to Categories.

Get all Categories

get

Get all the categories saved on the server.

Responses

200

Categories

application/json

Category metadata.

archivesstring[]Optional

Array of archive IDs (if this is a static category, empty otherwise)

idstring · min: 14 · max: 14Required

ID of the category

namestringOptional

Name of the category

pinnedint · enumOptional

Whether this category should be pinned in the UI

Possible values:

searchstring · nullableOptional

Category search filter (if this is a dynamic category, empty otherwise)

get

/categories

HTTPcURLJavaScriptPython

GET /api/categories HTTP/1.1
Host: lrr.tvc-16.science
Accept: */*

200

Categories

[
  {
    "id": "SET_1613080290",
    "name": "My great category",
    "pinned": 0,
    "search": null,
    "archives": [
      "0d50858d727723d856d2ab78564bb8e906e65f14",
      "7f03b8b1f337e1e42b2c2890533c0de7479d41ca"
    ]
  }
]

🔑 Create a Category

put

Create a new Category.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Body

application/x-www-form-urlencodedmultipart/form-data

namestringRequired

Name of the Category.

searchstringOptional

Matching predicate, if creating a Dynamic Category.

pinnedbooleanOptional

Add this parameter if you want the created category to be pinned.

Responses

200

Success response

application/json

operationstring · enumOptionalPossible values:

category_idstring · min: 14 · max: 14Optional

ID of the created Category

successinteger · enumOptionalPossible values:

400

Error response

application/json

put

/categories

HTTPcURLJavaScriptPython

PUT /api/categories HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 45

"name='text'&search='text'&pinned=true"

application/x-www-form-urlencodedmultipart/form-data

{
  "operation": "create_category",
  "category_id": "text",
  "success": 0
}

Get bookmark-linked Category

get

Retrieves the ID of the category currently linked to the bookmark feature. Returns an empty string if no category is linked.

Responses

200

Link

application/json

operationstring · enumOptionalPossible values:

successinteger · enumOptionalPossible values:

category_idany ofOptional

string · min: 14 · max: 14Optional

or

string · enumOptionalPossible values:

get

/categories/bookmark_link

HTTPcURLJavaScriptPython

GET /api/categories/bookmark_link HTTP/1.1
Host: lrr.tvc-16.science
Accept: */*

200

Link

{
  "operation": "get_bookmark_link",
  "success": 0,
  "category_id": "text"
}

🔑 Disable bookmark feature

delete

Disables the bookmark feature by removing the link to any category. Returns the ID of the previously linked category.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Responses

200

Success response

application/json

operationstringOptional

category_idany ofOptional

ID of the previously linked category.

string · min: 14 · max: 14Optional

or

string · enumOptionalPossible values:

successinteger · enumOptionalPossible values:

delete

/categories/bookmark_link

HTTPcURLJavaScriptPython

DELETE /api/categories/bookmark_link HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

200

Success response

{
  "operation": "text",
  "category_id": "text",
  "success": 0
}

🔑 Update bookmark-linked Category

put

Links the bookmark feature to the specified static category. This determines which category archives are added to when using the bookmark button.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstring · min: 14 · max: 14Required

Responses

200

Success response

application/json

operationstringOptional

category_idstring · min: 14 · max: 14Optional

ID of the category that was linked

successinteger · enumOptionalPossible values:

400

Error response

application/json

404

Category with specified ID does not exist

application/json

put

/categories/bookmark_link/{id}

HTTPcURLJavaScriptPython

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

{
  "operation": "text",
  "category_id": "text",
  "success": 0
}

Get a single Category

get

Get the details of the specified category ID.

Path parameters

idstring · min: 14 · max: 14Required

Responses

200

Category

application/json

Category metadata.

archivesstring[]Optional

Array of archive IDs (if this is a static category, empty otherwise)

idstring · min: 14 · max: 14Required

ID of the category

namestringOptional

Name of the category

pinnedint · enumOptional

Whether this category should be pinned in the UI

Possible values:

searchstring · nullableOptional

Category search filter (if this is a dynamic category, empty otherwise)

get

/categories/{id}

HTTPcURLJavaScriptPython

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

200

Category

{
  "id": "SET_1613080290",
  "name": "My great category",
  "pinned": 0,
  "search": null,
  "archives": [
    "0d50858d727723d856d2ab78564bb8e906e65f14",
    "7f03b8b1f337e1e42b2c2890533c0de7479d41ca"
  ]
}

🔑 Update Category

put

Modify a Category.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Body

application/x-www-form-urlencodedmultipart/form-data

namestringOptional

New name of the Category

searchstringOptional

Predicate. Trying to add a predicate to a category that already contains Archives will give you an error.

pinnedbooleanOptional

Add this argument to pin the Category. If you don't, the category will be unpinned on update.

Responses

200

Success response

application/json

operationstring · enumOptionalPossible values:

category_idstring · min: 14 · max: 14Optional

successinteger · enumOptionalPossible values:

400

Error response

application/json

423

The Category is currently locked for modification

application/json

put

/categories/{id}

HTTPcURLJavaScriptPython

PUT /api/categories/{id} HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 45

"name='text'&search='text'&pinned=true"

application/x-www-form-urlencodedmultipart/form-data

{
  "operation": "update_category",
  "category_id": "text",
  "success": 0
}

🔑 Delete Category

delete

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

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:

423

The category ID is currently locked for modification

application/json

delete

/categories/{id}

HTTPcURLJavaScriptPython

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

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

🔑 Add an Archive to a Category

put

Adds the specified Archive ID (see Archive API) to the given Category.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstring · min: 14 · max: 14Required

Archive ID to add.

archivestring · min: 40 · max: 40Required

Responses

200

Result

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:

423

The category ID is currently locked for modification

application/json

put

/categories/{id}/{archive}

HTTPcURLJavaScriptPython

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

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

🔑 Remove an Archive from a Category

delete

Remove an Archive ID from a Category.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstring · min: 14 · max: 14Required

Archive ID to remove.

archivestring · min: 40 · max: 40Required

Responses

200

Result

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:

423

The category ID is currently locked for modification

application/json

delete

/categories/{id}/{archive}

HTTPcURLJavaScriptPython

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

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