API Reference

login 登录

Description

• Get and return one user based on current user openid. Create and return the user if it does not exist.

Parameters

None

Return

{
  "id": "000000"
}

user 用户

getUserById

Description

• Get and one user based on user id

Parameters

{
  "action": "getUserById",
  "data": {
    "id": "000000",
  }
}

Return

{
  "id": String,
  "name": String,
  "avatar": String,
  "alias": String,
  "roles": Array[String],
  "balance": Number,
  "visits": Number,
  "wallet": Array[Card {
    "id": String,
    "type": String,
    "activation": Date,
    "expiration": Date,
    "balance": Number
  }]
}

updateUserInfo

Description

• Update a user's basic info given id.

Parameters

{
  "action": "updateUserInfo",
  "data": {
    "id": "000000",
    "name": "mynewname", # optional
    "balance": -10, # optional
    "alias": "some alias", # optional
    "avatar": "some link" # optional
  }
}

Return

{
  "id": "000000",
  "name": "meeple000000",
  "balance": -10,
  "alias": "some alias",
  "avatar": "some link"
}

grantAdminById

Description

• Grant or revoke admin right of a user

Parameters

{
  "action": "grantAdminById",
  "data": {
    "id": "000000",
    "grant": true # [optional] default: true
  }
}

Return

{
  "id": "000000"
}

card 卡

addCardByType

Description

• Add a card to a user's wallet.

Parameters

{
  "action": "addCardByType",
  "data": {
    "id": "000000",
    "cardType": "seasonal" #"annual", "times"
  }
}

Return

{
  "id": String,
  "wallet": Array[Card {
    "id": String,
    "type": String,
    "activation": Date,
    "expiration": Date,
    "balance": Number
  }]
}

removeCardById

Description

• Remove a card from a user's wallet.

Parameters

{
  "action": "removeCardById",
  "data": {
    "id": "000000",
    "cardId": "1683641095812"
  }
}

Return

{
  "id": String,
  "wallet": Array[Card {
    "id": String,
    "type": String,
    "activation": Date,
    "expiration": Date,
    "balance": Number
  }]
}

activateCardById

Description

• Activate a card from a user's wallet. Note: only seasonal card can be activated at this time.

Parameters

{
  "action": "activateCardById",
  "data": {
    "id": "000000",
    "cardId": "1683641095812"
  }
}

Return

{
   "id": String,
   "type": String,
   "activation": Date,
   "expiration": Date,
   "balance": Number
}

chargeCardById

Description

• Charge a card given card id based on date. (Or give back credit if revoke is true)

Parameters

{
  "action": "chargeCardById",
  "data": {
    "id": "000000",
    "cardId": "1683641095812",
    "date": "2023-05-01" # [optional] default: today
    "revoke": false # [optional] default: false
  }
}

Return

{
   "id": String,
   "type": String,
   "activation": Date,
   "expiration": Date,
   "balance": Number
}

getValidCards

Description

• Get a list of valid cards for a user, including ones activate-able.

Parameters

{
  "action": "getValidCards",
  "data": {
    "id": "000000",
    "date": "2023-05-01" # [optional] default: today
  }
}

Return

Array[Card {
   "id": String,
   "type": String,
   "activation": Date,
   "expiration": Date,
   "balance": Number
}]

checkin 签到

getCheckInStatus

Description

• Get user's checkin status.

Parameters

{
  "action": "getCheckInStatus",
  "data": {
    "id": "000000",
    "date": "2023-05-01" # [optional] default: today
  }
}

Return

{
  "isCheckedIn": Boolean,
  "cardId": String,
  "date": Date
}

checkin

Description

• Check in a user with given card. This will automatically create a new visit record for this user and charge the card or user depending on card and date.

Parameters

{
  "action": "checkin",
  "data": {
    "id": String,
    "cardId": String,
    "date": "2023-05-01" # [optional] default: today
  }
}

Return

{
  "id": String,
  "cardId": String,
  "userId": String,
  "date": Date
}

revokeCheckIn

Description

• Revoke a user's checkin on specified date. This will automatically delete the visit record and revoke the charge on card or user depending on card type and date.

Parameters

{
  "action": "revokeCheckIn",
  "data": {
    "id": String,
    "date": "2023-05-01" # [optional] default: today
  }
}

Return

{
  "revoked": Boolean
}