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=22

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

{
    "count": 305,
    "next": "https://demo.lizard.net/api/v4/organisations/?format=api&page=23",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=21",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/281993a6-c3c2-40ef-9513-388ad14d12e0/?format=api",
            "uuid": "281993a6-c3c2-40ef-9513-388ad14d12e0",
            "name": "Regio Alkmaar"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/ab33da9a-f0cb-4bac-9d4d-746ca4b6fe9a/?format=api",
            "uuid": "ab33da9a-f0cb-4bac-9d4d-746ca4b6fe9a",
            "name": "Rijksvastgoedbedrijf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/38b30b5a-292c-416a-a909-c94549d22109/?format=api",
            "uuid": "38b30b5a-292c-416a-a909-c94549d22109",
            "name": "Rijkswaterstaat"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/f9512ff9-15b1-4a25-9e29-b1958e584de2/?format=api",
            "uuid": "f9512ff9-15b1-4a25-9e29-b1958e584de2",
            "name": "Rijkswaterstaat_matroos"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/2af27dd5-e009-462f-be01-7d24ebcbf23f/?format=api",
            "uuid": "2af27dd5-e009-462f-be01-7d24ebcbf23f",
            "name": "Rijswijk"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/f855892a-d17f-475a-b983-f86271e1f158/?format=api",
            "uuid": "f855892a-d17f-475a-b983-f86271e1f158",
            "name": "Rivierenland"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/55146dc2-969a-4ab2-9565-5d6b8ce9bab3/?format=api",
            "uuid": "55146dc2-969a-4ab2-9565-5d6b8ce9bab3",
            "name": "Roermond"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/29eda604-5d52-4fae-ad13-3acb687cb9b5/?format=api",
            "uuid": "29eda604-5d52-4fae-ad13-3acb687cb9b5",
            "name": "Rotterdam"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/33cd296f-d54f-464d-836e-726a18801808/?format=api",
            "uuid": "33cd296f-d54f-464d-836e-726a18801808",
            "name": "Rotterdam_test"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/424de8d8-2278-4528-9c0a-33327f69bc42/?format=api",
            "uuid": "424de8d8-2278-4528-9c0a-33327f69bc42",
            "name": "S&T"
        }
    ]
}