New API available - faster and more powerful!

Check it out!
Perfect Gym api
Deprecated - API v1 will be switched off on 01.07.2022. Please upgrade to API v2

Membership details

Membership details is detaild representation of single membership type in your company.

Membership details properties

Club details holds the same data as Membership plus some detailed attributes of a membership. Only membership details specyfic properties are described here.

Name Type Description
startDate string Club display name.
endDate string Club detailed description.
accessRules array An array of Access rules objects, each representing club access rules for membership holder.
allowedZoneTypes array An array of Club Zone Types objects, each representing club zone type membership holder has access to.
paymentPlans array An array of Payment Plans objects, each representing payment plan available with given membership type.

Retrive detailed information about specyfic membership type alt text

GET Memberships/Membership

Returns detailed membership type informations.

Parameters

Name Type Description
membershipId long Membership type identifier.

Example request

In this example we fetch membership type with id = 20 detailed information.

curl -i 
     -X GET 
     -H "Authorization: Bearer  $ACCESS_TOKEN"  
     http://yoursubdomain.perfectgym.com/Api/Memberships/Membership
        ?membershipId=20        

Example response

Status: 200 OK
{
  "elemenst": [
    {
      "startDate": "2015-01-01T00:00:00",
      "endDate": "2016-12-31T23:59:59",
      "accessRules": [
        {
          "id": 18,
          "timestamp": 280591,
          "name": "Access rule",
          "description": "",
          "allowedClubs": [
            {
              "id": 2,
              "timestamp": 271990,
              "name": "Fibo Cyberbotics",
              "shortName": "Cyberbotics",
              "symbol": "FCBR",
              "type": "Normal",
              "openDate": "2015-01-01",
              "latitude": 52.51038,
              "longitude": 13.39763,
              "email": "club@cyberbotics.com",
              "phoneNumber": "+49 12 123 456 789",
              "timezone": "Central European Standard Time",
              "address": {
                "line1": "Leipziger Str. 46/47",
                "line2": "",
                "city": "Berlin",
                "postalCode": "10-117",
                "country": "Germany"
              },
              "isDeleted": false,
              "isHidden": false
            },
            {
              "id": 9,
              "timestamp": 255968,
              "name": "Club Monaco",
              "shortName": "Monaco",
              "symbol": "MON",
              "type": "Platinum",
              "openDate": "2015-01-01",
              "latitude": 52.51038,
              "longitude": 13.39763,
              "email": "club@clubmonaco.com",
              "phoneNumber": "+49 12 123 456 789",
              "timezone": "Central European Standard Time",
              "address": {
                "line1": "Rue Grimaldi 47",
                "line2": "",
                "city": "Monaco",
                "postalCode": "10-117",
                "country": "Monaco"
              },
              "isDeleted": false,
              "isHidden": false
            }
          ],
          "allowedZoneTypes": [
            {
              "id": 1,
              "timestamp": 50009,
              "name": "SPA",
              "description": "SPA",
              "dailyLimit": ""
            },
            {
              "id": 2,
              "timestamp": 2009,
              "name": "Gym",
              "description": "Gym",
              "dailyLimit": ""
            },
            {
              "id": 4,
              "timestamp": 2011,
              "name": "Cafeteria",
              "description": "Cafeteria",
              "dailyLimit": ""
            }
          ]
        }
      ],
      "paymentPlans": [
        {
          "id": 41,
          "timestamp": 447620,
          "name": "Open 3m",
          "isActive": true,
          "isAddOnPaymentPlan": false,
          "isDeleted": false
        },
        {
          "id": 42,
          "timestamp": 447621,
          "name": "Open 6m",
          "isActive": true,
          "isAddOnPaymentPlan": false,
          "isDeleted": false
        },
        {
          "id": 43,
          "timestamp": 447622,
          "name": "Open 12m",
          "isActive": true,
          "isAddOnPaymentPlan": false,
          "isDeleted": false
        },
        {
          "id": 44,
          "timestamp": 447623,
          "name": "Open 24m",
          "isActive": true,
          "isAddOnPaymentPlan": false,
          "isDeleted": false
        }
      ],
      "id": 20,
      "timestamp": 280599,
      "name": "High5 Full",
      "isActive": true,
      "isDeleted": false
    }
  ]
}
Perfect Gym api