|
|
These notes largely based on the [research and documentation for the *Go* Radar bindings](https://godoc.org/github.com/goapunk/radar-api-go).
|
|
|
|
|
|
* [General](#General)
|
|
|
* [Entity Endpoints](#Entity-Endpoints)
|
|
|
* [Search Endpoints](#Search-Endpoints)
|
|
|
* [Fields](#Fields)
|
|
|
* [Field references](#Field-references)
|
|
|
* [Facets](#Facets)
|
|
|
* [Filters](#Filters)
|
|
|
* [Authentication](#Authentication)
|
|
|
* [Posting Entities](#Posting-Entities)
|
|
|
|
|
|
# General
|
|
|
|
|
|
The radar database consists of the following entities:
|
|
|
|
|
|
```
|
|
|
* events : any kind of event, e.g. a party, workshop, etc.
|
|
|
* groups : a group organizes events. Some groups just act as promoters and add events to the
|
|
|
database without actually organzing them, e.g. "Stressfaktor". An event can be linked to multiple groups.
|
|
|
* groups : a group organizes events. Some groups just act as promoters and add events to the database without actually organzing them, e.g. "Stressfaktor". An event can be linked to multiple groups.
|
|
|
* location : a place where an event happens.
|
|
|
* taxonomy term : a category for events, groups and locations, e.g. "party",
|
|
|
"workshop", "bar/cafe", etc. Any of the above entities can be linked to
|
|
|
multiple taxonomy terms.
|
|
|
```
|
|
|
* taxonomy term : a category for events, groups and locations, e.g. "party", "workshop", "bar/cafe", etc. Any of the above entities can be linked to multiple taxonomy terms.
|
|
|
|
|
|
Each entity comes with a set of fields. The list of available fields for each entity can be found in the corresponding subpackages (see subdirectories). All entities have a common field UUID which uniquely identifies an entity instance.
|
|
|
Each entity comes with a set of fields. All entities have a common field UUID which uniquely identifies an entity instance.
|
|
|
|
|
|
# Endpoints
|
|
|
# Entity Endpoints
|
|
|
|
|
|
This documentation follows json only, it is possible to change to other formats including xml by altering the extension.
|
|
|
|
... | ... | @@ -371,4 +376,10 @@ A field can't be used in more than one equals filter, i.e. you can't filter for |
|
|
|
|
|
filter[~and][field_offline:field_address:locality][~eq]=Berlin&filter[~or][field_offline:field_address:locality
|
|
|
|
|
|
This is where there will usually be facets to cover the requirement. |
|
|
\ No newline at end of file |
|
|
This is where there will usually be facets to cover the requirement.
|
|
|
|
|
|
# Available fields
|
|
|
|
|
|
# Logging in
|
|
|
|
|
|
# Posting entities |
|
|
\ No newline at end of file |