Organisation List – Django REST framework

Endpoint for interacting with organisations.

Query parameters

name Text filter on the name field. Filter methods like startswith, endswith and contains are supported. For case-insensitive filtering, use istartswith, iendswith and icontains.

uuid UUIDs must be separated by commas and must be specified in their canonical textual representation (in their 8-4-4-4-12 form, that is). Filtering on this field is always case insensitive. UUID fractions are supported too.

Subendpoints

/api/v4/organisations/{uuid}/contract returns contract information of the organisation. Only accessible by members of the organisation.

/api/v4/organisations/{uuid}/usage/ returns the count and total size of time series, rasters and scenarios for a specific organisation. Only accessible by members of the organisation.

/api/v4/organisations/{uuid}/users/ returns all users in the specified organisation and their roles. Only accessible by members of the organisation. User roles may be patched by managers.

Examples

/api/v4/organisations/?name__icontains=schuur

/api/v4/organisations/?uuid=61f5a464-c350-44c1-9bc7-d4b42d7f58cb

/api/v4/organisations/?uuid=C350-44C1-9BC7,9C6C-40A9-A5FC

/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/contract/

/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/usage/

/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/users/

GET /api/v4/organisations/?format=api&page=31

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 305,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=30",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/cdec289a-4533-4f54-820a-9a2da957cd4b/?format=api",
            "uuid": "cdec289a-4533-4f54-820a-9a2da957cd4b",
            "name": "eLEAF"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/f4d66470-3631-4bfb-abd2-0de47b2755d0/?format=api",
            "uuid": "f4d66470-3631-4bfb-abd2-0de47b2755d0",
            "name": "huygenhoek_taxaties"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/f206d169-7a5b-4d4e-982c-184d5f0aafc4/?format=api",
            "uuid": "f206d169-7a5b-4d4e-982c-184d5f0aafc4",
            "name": "ihw"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/85e22f2e-d450-4a32-952b-f959ef8817a3/?format=api",
            "uuid": "85e22f2e-d450-4a32-952b-f959ef8817a3",
            "name": "test Provincie Noord-Brabant"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/cd36e283-09d5-4713-b026-59b7681bb15b/?format=api",
            "uuid": "cd36e283-09d5-4713-b026-59b7681bb15b",
            "name": "test_3di_organisation"
        }
    ]
}