GET /api/bookmarks
Toon alle bladwijzers

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer

search
optional

filter resultaten

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Pagineer de resultaten

Validations:

  • Must be a String

per_page
optional

Aantal items per aanvraag

Validations:

  • Must be a String

Search fields

Field name Type Possible values
controller string
name string

GET /api/bookmarks/:id
Toon een bladwijzer

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer

id
required

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
Maak een bladwijzer

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer

bookmark
required

Validations:

  • Must be a Hash

bookmark[name]
required

Validations:

  • Must be a String

bookmark[controller]
required

Validations:

  • Must be a String

bookmark[query]
required

Validations:

  • Must be a String

bookmark[public]
optional , nil allowed

Validations:

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


PUT /api/bookmarks/:id
Bewerk een bladwijzer

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer

id
required

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
required

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 allowed

Validations:

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


DELETE /api/bookmarks/:id
Verwijder een bladwijzer

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer

id
required

Validations:

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