Bookmarks

>>>

GET /api/bookmarks
Alle Lesezeichen auflisten

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer
organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer
search
optional

Ergebnisse filtern

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String
per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String

Search fields

Feld Name Typ Mögliche Werte
controller string
name string
>>>

GET /api/bookmarks/:id
Lesezeichen anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer
organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer
id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/bookmarks
Lesezeichen erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer
organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer
bookmark
verpflichtend

Validations:

  • Must be a Hash
bookmark[name]
verpflichtend

Validations:

  • Must be a String
bookmark[controller]
verpflichtend

Validations:

  • Must be a String
bookmark[query]
verpflichtend

Validations:

  • Must be a String
bookmark[public]
optional , nil erlaubt

Validations:

  • Must be one of: true, false, 1, 0.
>>>

PUT /api/bookmarks/:id
Lesezeichen Aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer
organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer
id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
bookmark
verpflichtend

Validations:

  • Must be a Hash
bookmark[name]
optional

Validations:

  • Must be a String
bookmark[controller]
optional

Validations:

  • Must be a String
bookmark[query]
optional

Validations:

  • Must be a String
bookmark[public]
optional , nil erlaubt

Validations:

  • Must be one of: true, false, 1, 0.
>>>

DELETE /api/bookmarks/:id
Lesezeichen löschen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer
organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer
id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.