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

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=11",
    "previous": "https://demo.lizard.net/api/v4/organisations/?format=api&page=9",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/organisations/89ccc56e-4424-4aac-ba27-01dcad8db538/?format=api",
            "uuid": "89ccc56e-4424-4aac-ba27-01dcad8db538",
            "name": "HDSR_test"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/05f05532-cfe3-4778-b32e-454fc24f2a56/?format=api",
            "uuid": "05f05532-cfe3-4778-b32e-454fc24f2a56",
            "name": "HHNK Logic"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/8723b82e-39b9-4b22-bf45-a4ba8c7dd533/?format=api",
            "uuid": "8723b82e-39b9-4b22-bf45-a4ba8c7dd533",
            "name": "HJUAV"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/bb454ac7-4523-4aa5-a94f-4b06144dafe5/?format=api",
            "uuid": "bb454ac7-4523-4aa5-a94f-4b06144dafe5",
            "name": "HLTsamen"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/2ebb37d7-baa4-45c9-8bcd-ddd29ef60551/?format=api",
            "uuid": "2ebb37d7-baa4-45c9-8bcd-ddd29ef60551",
            "name": "HLTsamen KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/7cc5c566-d653-470e-9e02-ff5c3b3a758b/?format=api",
            "uuid": "7cc5c566-d653-470e-9e02-ff5c3b3a758b",
            "name": "HVFMS"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/7be42995-fcab-43b1-9bfe-e402a262fb5d/?format=api",
            "uuid": "7be42995-fcab-43b1-9bfe-e402a262fb5d",
            "name": "Haarlemmermeer KA"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/1f6655ea-5274-49d6-b3d0-74217eac3024/?format=api",
            "uuid": "1f6655ea-5274-49d6-b3d0-74217eac3024",
            "name": "Hedensted"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/f677796c-8bf2-47ce-9457-c30f8ec3faf4/?format=api",
            "uuid": "f677796c-8bf2-47ce-9457-c30f8ec3faf4",
            "name": "Hedwige-Prosperpolder"
        },
        {
            "url": "https://demo.lizard.net/api/v4/organisations/bdb6fc4b-03cf-43c7-afe4-d307750eb4f6/?format=api",
            "uuid": "bdb6fc4b-03cf-43c7-afe4-d307750eb4f6",
            "name": "Heemskerk"
        }
    ]
}