Filters

>>>

GET /api/filters
Bekijk alle filters

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
limited true, false
location string
location_id integer
organization string
organization_id integer
override true, false
permission string
resource string
role string
role_id integer
search text
unlimited true, false
>>>

GET /api/filters/:id
Bekijk een filter

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/filters
Maak een filter

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
filter
Required

Validations:

  • Must be a Hash
filter[role_id]
Required

Validations:

  • Must be a String
filter[search]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
filter[override]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0
filter[permission_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
filter[organization_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
filter[location_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
>>>

PUT /api/filters/:id
Wijzig een filter

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 a String
filter
Required

Validations:

  • Must be a Hash
filter[role_id]
Optional

Validations:

  • Must be a String
filter[search]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
filter[override]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0
filter[permission_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
filter[organization_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
filter[location_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
>>>

DELETE /api/filters/:id
Verwijder een filter

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 a String