GET /regions

This request returns a list of regions.

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request example

GET /v2/regions HTTP/1.1
Host: api.lionsclubs.ch

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[
    {
        "id": 1,
        "name": "Region Name #1",
        "...": "...",
        "zones": [
            {
                "id": 1,
                "name": "Zone Name #1",
                "...": "..."
            }
        ]
    },
    {
        "id": 2,
        "name": "Region Name #2",
        "...": "...",
        "zones": [
            {
                "id": 4,
                "name": "Zone Name #4",
                "...": "..."
            }
        ]
    }
]

GET /regions/id

This request returns the region with a given identifier.

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request example

GET /v2/regions/id HTTP/1.1
Host: api.lionsclubs.ch

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
    "id": id,
    "name": "Region Name",
    "...": "...",
    "zones": [
        {
            "id": 1,
            "name": "Zone Name #1",
            "...": "..."
        }
    ]
}

GET /regions/id/committee restricted

This request returns the committee of the region with the given identifier.

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request example

GET /v2/regions/id/committee HTTP/1.1
Host: api.lionsclubs.ch
X-Authorization: access-token

Optional parameters

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
    "success": true,
    "groups": [
        {
            "name": "Executive board",
            "members": [
                {
                    "function": "Region President",
                    "id": 7,
                    "firstName": "John",
                    "middleName": "",
                    "lastName": "Doo",
                    "fullName": "John Doo",
                    "active": true,
                    "photo": "",
                    "club": 123
                },
                {
                    "...": "..."
                }
            ]
        }
    ]
}