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

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=6",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=4",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/d11edfaf-045c-4138-a1b2-eba78cf395f4/?format=api",
            "uuid": "d11edfaf-045c-4138-a1b2-eba78cf395f4",
            "name": "Castricum"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/33b32fe8-0317-4390-9ef9-259744c32cc1/?format=api",
            "uuid": "33b32fe8-0317-4390-9ef9-259744c32cc1",
            "name": "City of Parramatta"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/6b7df72b-879a-4576-8a54-ca353468fbbd/?format=api",
            "uuid": "6b7df72b-879a-4576-8a54-ca353468fbbd",
            "name": "Civicon"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/768684c9-692f-4a36-95e0-14211d7fab41/?format=api",
            "uuid": "768684c9-692f-4a36-95e0-14211d7fab41",
            "name": "Course_A"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/5226d564-0598-42cf-b613-b505438132b4/?format=api",
            "uuid": "5226d564-0598-42cf-b613-b505438132b4",
            "name": "Course_B"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/dc7b7cf6-5fe6-4230-903d-42e4dd0a3786/?format=api",
            "uuid": "dc7b7cf6-5fe6-4230-903d-42e4dd0a3786",
            "name": "Course_C"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/460d3102-7411-4e2d-8c3f-f3a6a22d24dc/?format=api",
            "uuid": "460d3102-7411-4e2d-8c3f-f3a6a22d24dc",
            "name": "DDSC"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/a67b9c1d-d967-4fb1-8687-c1da630491cf/?format=api",
            "uuid": "a67b9c1d-d967-4fb1-8687-c1da630491cf",
            "name": "DDT-demo"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/0be98db0-0290-4a41-aec6-857a782255e6/?format=api",
            "uuid": "0be98db0-0290-4a41-aec6-857a782255e6",
            "name": "De BUCH"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/a73d02c3-2800-47a8-9d4d-362df1914352/?format=api",
            "uuid": "a73d02c3-2800-47a8-9d4d-362df1914352",
            "name": "Deltares"
        }
    ]
}