operation | explain |
endpoint | . |
name | explain |
description | explain API functionality |
endpoint | article | |
name | list | |
description | lists all articles | |
param | startAt | the record to start from |
param | max | the maximum number of records to be displayed |
param | category | filter articles by category |
param | author | filter articles by author name |
param | status | filter articles by status |
param | title | filter articles by beginning of title |
endpoint | article/$id | |
name | get | |
description | get one article with ID $id | |
param | startAt | the record to start from |
param | max | the maximum number of records to be displayed |
param | category | filter articles by category |
param | author | filter articles by author name |
param | status | filter articles by status |
endpoint | query | |
name | query | |
description | full text query on articles | |
param (mandadory!) | q | the search string |
param | field | where to search in an article. Possible values are: "title" (only article heading), "all" (everywhere in the text, default) |
param | startAt | the record to start from |
param | max | the maximum number of records to be displayed |
param | category | filter articles by category |
param | author | filter articles by author name |
param | status | filter articles by status |
endpoint | authors | |
name | authors | |
description | lists all authors | |
param | startAt | the record to start from |
param | max | the maximum number of records to be displayed |
endpoint | literature | |
name | literature | |
description | lists cited literature | |
param | title | filter bibliography by beginning of short citation |
param | startAt | the record to start from |
param | max | the maximum number of records to be displayed |