Organisations

Organisation description here

Endpoint

/api/v1/organisations/
class viitata.api.views.OrganisationViewSet(*args, **kwargs)

A ViewSet that provides create, list, retrieve, update, partial_update and destroy for Organisation objects.

Actions:
list:
  • Return a list of all the Organisations.
  • Requires the IsAuthenticated permission.
retrieve:
  • Return the given Organisation.
  • Requires the IsAuthenticated permission.
create:
  • Create a given Organisation.
  • Requires the IsAuthenticated permission.
update:
  • Update the given Organisation.
  • Requires the IsAuthenticated permission.
partial_update:
  • Update a fragment of the given Organisation.
  • Requires the IsAuthenticated permission.
destroy:
  • Delete a given Organisation.
  • Requires the IsAuthenticated permission.

Filters

class viitata.api.filters.OrganisationFilterSet(data=None, queryset=None, *, request=None, prefix=None)

Filters for /api/v1/organisations/ endpoint.

Ordering:
id
name
active
accepts_referrals
Search:
name
parent name
address address_1
address address_2
address town_city
address county
address postcode
phone_number
website
description
criteria
service_offer
skype
contact_email
Filters:
parent
address
active
accepts_referrals
accepts_referrals_from
accepted_issues
accepted_secondary_issues
local_authorities
gender
minimum_age
maximum_age
case_match
issue_match
tags