Skip to content
Last updated

Wellpass Admission: API reference

This Wellpass Admission flow uses operations in the generated MMS API V2 reference. The specification is maintained outside this repository and is not edited here.

Request and response specifications

The code samples below show example requests. Open an operation to see its request fields, response payloads, and HTTP error responses.

OperationSpecification
Create a member accountCreate an account
Assign an RFID cardUpdate RFIDs of a user
Validate admissionMember Admission
List corporate fitness member accountsList accounts

See Wellpass admission error codes for denial reasons and handling guidance.

These links open the shared MMS API reference and its navigation. They do not mean that every MMS operation is required for Wellpass Admission.

Create a member account

Use publishAccount to create an account with membershipType: CORPORATE_FITNESS and a verificationTAN.

curl -i -X POST \
  https://mms.api.ed.ts.egym.coffee/api/v2/accounts \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "string",
    "firstName": "John",
    "lastName": "Wick",
    "dateOfBirth": "2019-08-24",
    "gender": "MALE",
    "contact": {
      "phone": "string",
      "street": "string",
      "streetNumber": "string",
      "zipCode": "string",
      "city": "string",
      "state": "string",
      "country": "DE"
    },
    "membership": {
      "membershipId": "string",
      "agreementNumber": "string",
      "membershipType": "BASIC",
      "membershipSubType": "string",
      "endOfContract": "2019-08-24",
      "startOfContract": "2019-08-24",
      "referringMemberId": "string",
      "barcode": "string",
      "verificationTAN": "string"
    }
  }'

Assign an RFID card

Use the existing MMS API V2 operation to assign an RFID card to the member.

curl -i -X PUT \
  'https://mms.api.ed.ts.egym.coffee/api/v2/accounts/{accountId}/rfids' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "rfids": [
      {
        "rfid": "string",
        "tagFormat": "HITAG1"
      }
    ]
  }'

Validate admission

Use checkAdmission to verify whether a Wellpass member can enter the gym.

curl -i -X POST \
  'https://mms.api.ed.ts.egym.coffee/api/v2/accounts/{accountId}/admissions' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

List corporate fitness member accounts

Use getCorporateFitnessMemberAccounts to identify memberships that are ending.

curl -i -X GET \
  'https://mms.api.ed.ts.egym.coffee/api/v2/accounts/corporate-fitness?endDateFrom=2022-09-22&endDateTo=2022-09-23' \
  -H 'x-api-key: YOUR_API_KEY_HERE'