API Documentation

This is the basic API documentation for HIVE-web.

Login

Request URL: $siteurl/api/$uniqueid/login
Request Method: GET

List

Books

Request URL: $siteurl/api/$uniqueid/list/book
Request Method: GET

Notebooks

Request URL: $siteurl/api/$uniqueid/list/notebook
Request Method: GET

Drawings

Request URL: $siteurl/api/$uniqueid/list/drawing
Request Method: GET

Add

Books

Request URL: $siteurl/api/$uniqueid/add/book
Request Method: POST
Request Vars: {
id_book: $parentbookid
}

Notebooks

Request URL: $siteurl/api/$uniqueid/add/notebook
Request Method: POST
Request Vars: {
name: $name,
style: $style,
color: $color
}

Drawings

Request URL: $siteurl/api/$uniqueid/add/drawing
Request Method: POST
Request Vars: {
name: $name
}

Edit

Notebooks

Request URL: $siteurl/api/$uniqueid/edit/notebook
Request Method: POST
Request Vars: {
item: $notebookid,
name: $name,
style: $style,
color: $color
}

Drawings

Request URL: $siteurl/api/$uniqueid/edit/drawing
Request Method: POST
Request Vars: {
item: $drawingid,
name: $name
}

Delete

Books

Request URL: $siteurl/api/$uniqueid/delete/book
Request Method: POST
Request Vars: {
item: $bookid
}

Notebooks

Request URL: $siteurl/api/$uniqueid/delete/notebook
Request Method: POST
Request Vars: {
item: $notebookid
}

Drawings

Request URL: $siteurl/api/$uniqueid/delete/drawing
Request Method: POST
Request Vars: {
item: $drawingid
}

Output

Books

Request URL: $siteurl/api/$uniqueid/output/book
Request Method: POST
Request Vars: {
item: $bookid,
page: $pageid
}

Notebooks

Request URL: $siteurl/api/$uniqueid/output/notebook
Request Method: POST
Request Vars: {
item: $notebookid,
page: $pageid
}

Drawings

Request URL: $siteurl/api/$uniqueid/output/drawing
Request Method: POST
Request Vars: {
item: $drawingid,
page: $pageid
}

Pull

Books

Request URL: $siteurl/api/$uniqueid/pull/book
Request Method: POST
Request Vars: {
item: $bookid
}

Notebooks

Request URL: $siteurl/api/$uniqueid/pull/notebook
Request Method: POST
Request Vars: {
item: $notebookid
}

Drawings

Request URL: $siteurl/api/$uniqueid/pull/drawing
Request Method: POST
Request Vars: {
item: $drawingid
}

Push

Books

Request URL: $siteurl/api/$uniqueid/push/book/$bookid
Request Method: POST
Request Vars: {
file: $compressedpackage
}

Notebooks

Request URL: $siteurl/api/$uniqueid/push/notebook/$notebookid
Request Method: POST
Request Vars: {
file: $compressedpackage
}

Drawings

Request URL: $siteurl/api/$uniqueid/push/drawing/$drawingid
Request Method: POST
Request Vars: {
file: $compressedpackage
}