Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vereinfachung der Objekt API #4

Merged
merged 5 commits into from
Oct 12, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,30 @@ von objekten.

### `/ths/search`

- method: `POST`
- method: `GET`

Man sucht eintraege deren `name` feld mit dem angegebenen `term` beginnen. Das ergebnis ist eine liste von objekten, enthalten im `results`-feld der `application/json`-response. Die einzelnen results enthalten jeweils `id`, `name` und `type`.
Man sucht eintraege deren `name` feld mit dem angegebenen `term` beginnen oder ihn
beinhalten. Das ergebnis ist eine liste von objekten, enthalten im `results`-feld der
`application/json`-response. Die einzelnen results enthalten jeweils `id`, `name` und
`type`.

Im body koennen/muessen folgende parameter angegeben werden:
Folgende parameter müssen oder können angegeben werden:

|name|range|funktion|default|
|---|---|---|---|
|`term`|mindestens 2 zeichen lang|suchbegriff der im `name` vorkommen soll|**required**|
|`search`|`{prefix\|contains}`|ob `term` am anfang von `name` oder irgendwo steht|`prefix`|
|`mode`|`{prefix\|contains}`|ob `term` am anfang von `name` oder irgendwo steht|`prefix`|
|`limit`|1-50, `int`|wie viele ergebnisse maximal|`50`|
funkyfuture marked this conversation as resolved.
Show resolved Hide resolved
|`type`|einzelner string oder liste von strings|man kriegt nur ergebnisse, deren `type` im parameter genannt ist|
|`offset`| |Index des ersten Items in den Gesamtergebnissen|`0`|
|`type`|liste von strings|man kriegt nur ergebnisse, deren `type` im parameter kommagetrent genannt sind|`[]`|

Die ergebnisse werden alphabetisch sortiert nach `name` und auf `limit` oder `50` stueck begrenzt. Beispiel:
Die ergebnisse werden alphabetisch sortiert nach `name` und auf `limit` oder `50` stueck
begrenzt. Beispiel:

```bash
curl -XPOST -HContent-Type:application/json http://tladev.bbaw.de:5002/ths/search -d '{"term":"h","limit":5}'
curl http://tladev.bbaw.de:5002/ths/search?term=ha&limit=5
funkyfuture marked this conversation as resolved.
Show resolved Hide resolved
```

```json
{
"length": 5,
Expand Down