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

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=16",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=14",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/1f98db14-07d4-4e0a-b7e7-e57168df43e6/?format=api",
            "uuid": "1f98db14-07d4-4e0a-b7e7-e57168df43e6",
            "name": "Landsmeer"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/6caba295-6130-44af-8d3f-a6e57da4cc14/?format=api",
            "uuid": "6caba295-6130-44af-8d3f-a6e57da4cc14",
            "name": "Langedijk"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/e6cbfa92-5115-44ae-bf96-1d5fd4cfc861/?format=api",
            "uuid": "e6cbfa92-5115-44ae-bf96-1d5fd4cfc861",
            "name": "Leiden"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/6d571bfe-ddbe-4dfa-a0a7-555cc01546f8/?format=api",
            "uuid": "6d571bfe-ddbe-4dfa-a0a7-555cc01546f8",
            "name": "Leidschendam-Voorburg"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/9b463da2-bcd0-4cdf-afd6-d4b84cd522d1/?format=api",
            "uuid": "9b463da2-bcd0-4cdf-afd6-d4b84cd522d1",
            "name": "Leidschendam-Voorburg KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/3c6a9ffc-af11-4c54-a71b-942881a1c759/?format=api",
            "uuid": "3c6a9ffc-af11-4c54-a71b-942881a1c759",
            "name": "Lelystad"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/3c8c15c5-7fc1-482e-ae5f-a85c965a3f37/?format=api",
            "uuid": "3c8c15c5-7fc1-482e-ae5f-a85c965a3f37",
            "name": "Lemvig"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/ad227939-118e-4108-a469-0f68437dfd53/?format=api",
            "uuid": "ad227939-118e-4108-a469-0f68437dfd53",
            "name": "Limmel-Heugem"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/925cbb1d-5320-465a-8613-71b64e6200b5/?format=api",
            "uuid": "925cbb1d-5320-465a-8613-71b64e6200b5",
            "name": "Lizard - 3Di"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/6012003a-a14b-46d4-9dea-6ca8d2e54618/?format=api",
            "uuid": "6012003a-a14b-46d4-9dea-6ca8d2e54618",
            "name": "Lizard - NRR"
        }
    ]
}