Platform

Points

Keeps the points that an org's members earn at events. Officers add members, give points by hand or from an attendance CSV, and read the leaderboard. The points switch turns the module on and off.

In the dashboard

The Points page (Members > Points) has two tabs:

  • Members: the leaderboard with each member's total. Search by name or email. Add a member, or give points to one member.
  • Events: the points given at each event. Upload an attendance CSV for an event, or delete the points of an event.

Attendance CSV

Upload a CSV with an event name and the points for each person. A background job reads it.

ColumnUse
EmailRequired. The member's email. One award for each email
First Name, Last NameRequired. The name of a new member
Checked-In DateRows with no value get no points

A person with no member record becomes a member of the org.

Routes

All routes are under /api/points/<org>.

RouteDoes
GET /users, POST /usersLists the org's members; adds or updates a member
PUT /users/<id>Changes a member's fields
GET /users/<id>/pointsOne member's point entries
POST /assign_pointsGives points to one member: user_identifier, points, event
DELETE /delete_pointsDeletes the points of one event
POST /uploadEventCSVForm fields file, event_name, event_points. Starts the CSV job
GET /get_pointsEvery point entry of the org
GET /leaderboardThe leaderboard. Open to everyone. Emails show only to a signed-in caller
POST /member_login, GET /member_profileMember sign-in and profile for the member site

Officers of the org can use every route except the leaderboard and member routes. getUserPoints, getUserTotalPoints and add_points are older names that SoDA's site still calls.

For agents

The MCP tool points.leaderboard (scope points:read) returns the leaderboard.

Tables

points: one row for each award, with the member, the event, the points and the officer. Members and memberships are in the users module.

On this page