Click here for a complete list of routes.

/clubs

GET /clubs

This request returns a list of clubs.

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

Request example

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

Response example

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

{
    "success": true,
    "count": 2,
    "clubs": [
        {
            "id": 1,
            "name": "Aarau",
            "type": "LIONS_CLUB",
            "district": {
                "id": 293,
                "name": "102 C",
                "fullName": "Lions District 102 Centro - Nord-, Zentral- und S\u00fcdschweiz"
            },
            "zone": {
                "id": 28,
                "name": "102 C-12"
            },
            "lci": 18834,
            "address": "",
            "website": "https://aarau.lionsclub.ch",
            "gps": {
                "latitude": 47.38892,
                "longitude": 8.040064
            },
            "socialNetworks": null,
            "charterNight": "1956-05-12",
            "dateFoundation": "1956-05-12",
            "email": "aarau@example.com",
            "meetings": [
                {
                    "dayTime": "1. Mi 18.30 h",
                    "description": "",
                    "address": "Gasthof zum Sch\u00fctzen\nSchachen\nCH-5000 Aaarau"
                }
            ],
            "sponsorClubs": [
                {
                    "id": 214,
                    "name": "LC Olten",
                    "type": "LIONS_CLUB"
                }
            ],
            "reverseSponsorClubs": [],
            "twinningClubs": {
                "name": "LC Zweibr\u00fccken (DE)",
                "type": "LIONS_CLUB"
            }
        },
        {
            "id": 2,
            "name": "Club Name #2",
            "...": "..."
        }
    ]
}

GET /clubs/id

This request returns the club 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/clubs/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": "Club Name",
    "type": "LIONS_CLUB",
    "district": {
        "id": 293,
        "name": "102 C",
        "fullName": "Lions District 102 Centro - Nord-, Zentral- und S\u00fcdschweiz"
    },
    "zone": {
        "id": 28,
        "name": "102 C-12"
    },
    "lci": 18834,
    "address": "",
    "website": "https://clubsite.lionsclub.ch",
    "gps": {
        "latitude": 47.38892,
        "longitude": 8.040064
    },
    "socialNetworks": null,
    "charterNight": "1956-05-12",
    "dateFoundation": "1956-05-12",
    "email": "clubsite@example.com",
    "meetings": [
        {
            "dayTime": "1. Mi 18.30 h",
            "description": "",
            "address": "Gasthof zum Sch\u00fctzen\nSchachen\nCH-5000 Aaarau"
        }
    ],
    "sponsorClubs": [
        {
            "id": 214,
            "name": "LC Olten",
            "type": "LIONS_CLUB"
        }
    ],
    "reverseSponsorClubs": [],
    "twinningClubs": {
        "name": "LC Zweibr\u00fccken (DE)",
        "type": "LIONS_CLUB"
    }
}
Name Type Description
type string One of LIONS_CLUB, LEO_CLUB_ALPHA, LEO_CLUB_OMEGA
socialNetworks array Array of pair of "type": "public URL" where type is one of skype, twitter, facebook, linkedIn, xing, instagram, flickr, youtube, pinterest.

GET /clubs/id/members restricted

This request returns the members of the club 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/clubs/id/members HTTP/1.1
Host: api.lionsclubs.ch
X-Authorization: access-token

Response example

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

{
    "success": true,
    "count": 2,
    "members": [
        {
            "id": 5,
            "fullName": "Franz Muster",
            "...": "..."
        },
        {
            "id": 9,
            "fullName": "Franz Mustermann",
            "...": "..."
        }
    ]
}

GET /clubs/id/committee restricted

This request returns the committee of the club 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/clubs/id/committee HTTP/1.1
Host: api.lionsclubs.ch
X-Authorization: access-token
Optional parameters
Name Type Description
locale string de, fr, ... to get localized function names. Defaults to English.
year int Lions Year of the committee. Bound to range 1917 – 2023. Defaults to current Lions Year.

Response example

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

{
    "success": true,
    "groups": [
        {
            "name": "Executive board",
            "members": [
                {
                    "function": "President",
                    "id": 5,
                    "fullName": "Franz Muster",
                    "...": "..."
                },
                {
                    "function": "Secretary",
                    "id": 11,
                    "fullName": "Sybil Muehlemann",
                    "...": "..."
                }
            ]
        }
    ]
}

GET /clubs/id/activities restricted

This request returns the social activities of the club 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/clubs/id/activities HTTP/1.1
Host: api.lionsclubs.ch
X-Authorization: access-token
Optional parameters
Name Type Description
locale string de, fr, ... to get localized categories. Defaults to English.

Response example

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

{
    "success": true,
    "activities": [
        {
            "id": 123,
            "title": "Title of the activity",
            "description": "",
            "...": "..."
        }
    ]
}

PUT /clubs/id/activities restricted

This request creates a new social activity for the club with the given identifier.

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

Request example

PUT /v2/clubs/id/activities HTTP/1.1
Host: api.lionsclubs.ch
X-Authorization: access-token
Content-Type: application/json
Content-Length: length

{
    "title": "string",
    "description": "string",
    "beneficiary": "string",
    "link": "string",
    "startDate": "YYYY-MM-DD",
    "endDate": "YYYY-MM-DD",
    "amountCollected": "int",
    "amountDonated": "int",
    "personsServed": "int",
    "volunteers": "int",
    "hoursWorked": "int",
    "status": 0,
    "category": "int"
}

Response example

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

{
    "success": true
}

POST /clubs/id/activities/activity-id restricted

This request updates the social activity for the club with the given identifiers.

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

Request example

POST /v2/clubs/id/activities/activity-id HTTP/1.1
Host: api.lionsclubs.ch
X-Authorization: access-token
Content-Type: application/json
Content-Length: length

{
    "title": "string",
    "description": "string",
    "beneficiary": "string",
    "link": "string",
    "startDate": "YYYY-MM-DD",
    "endDate": "YYYY-MM-DD",
    "amountCollected": "int",
    "amountDonated": "int",
    "personsServed": "int",
    "volunteers": "int",
    "hoursWorked": "int",
    "status": "int",
    "category": "int"
}

Response example

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

{
    "success": true
}

DELETE /clubs/id/activities/activity-id restricted

This request deletes the social activity for the club with the given identifiers.

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

Request example

DELETE /v2/clubs/id/activities/activity-id HTTP/1.1
Host: api.lionsclubs.ch
X-Authorization: access-token

Response example

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

{
    "success": true
}