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

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=27",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=25",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/236d6b99-107c-4814-b276-e4a428849e4d/?format=api",
            "uuid": "236d6b99-107c-4814-b276-e4a428849e4d",
            "name": "Uitgeest"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/db8889dc-a4cc-4528-a3ea-bf5287fabe6f/?format=api",
            "uuid": "db8889dc-a4cc-4528-a3ea-bf5287fabe6f",
            "name": "Uptime"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/03c748dc-62b1-401b-8794-e34a52c4713b/?format=api",
            "uuid": "03c748dc-62b1-401b-8794-e34a52c4713b",
            "name": "Urk"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/9766a45f-9c6c-40a9-a5fc-f321e65afb1a/?format=api",
            "uuid": "9766a45f-9c6c-40a9-a5fc-f321e65afb1a",
            "name": "Utrecht"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/7683822e-2096-4588-85f5-d55b492d1da6/?format=api",
            "uuid": "7683822e-2096-4588-85f5-d55b492d1da6",
            "name": "Vaals"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/d8c69e8f-88c5-4ff9-abbf-22b94b22202e/?format=api",
            "uuid": "d8c69e8f-88c5-4ff9-abbf-22b94b22202e",
            "name": "Valkenburg"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/2c419b2e-2eec-4bea-9421-917494cc0e8f/?format=api",
            "uuid": "2c419b2e-2eec-4bea-9421-917494cc0e8f",
            "name": "VanderSat"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/c652bb95-ffc9-4ae0-a421-1b9548171337/?format=api",
            "uuid": "c652bb95-ffc9-4ae0-a421-1b9548171337",
            "name": "Veenendaal"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/132ae853-d0c6-408d-a440-32e90be24472/?format=api",
            "uuid": "132ae853-d0c6-408d-a440-32e90be24472",
            "name": "Velsen KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/c29ec599-39d0-49a4-a2d6-4f01715c496b/?format=api",
            "uuid": "c29ec599-39d0-49a4-a2d6-4f01715c496b",
            "name": "Venray"
        }
    ]
}