After obtaining a valid Thumbprint from USA Swimming, vendors can begin testing API requests using Postman. The Thumbprint must be included in the request headers, as demonstrated below.

• If a request is made without the Thumbprint, the endpoint will return a 403 - Forbidden response
• If a request is made with an invalid Thumbprint, the endpoint will return a 401 - Unauthorized response
• If a request is made with a valid Thumbprint, the endpoint will return a 200 OK response along with the requested data

We will provide the ability for a vendor to "subscribe" to certain events that happen in SWIMS.

Vendors using events will also need to provide:

• The URL where we will send the events
• Optional: Vendors will create a certificate and provide to SWIMS the following, which will be sent with each event to ensure the security of our event endpoint:
  • ClientCertificate.pfx
  • Client Certificate Password

Member Actions

• Member Registers
• Member Renewal
• Member Updated
• Member Upgrade
• Member Merges
• Member Transfer From Club
• Member Transfer To Club
• Member Cancels

Generated when a member registers in SWIMS via the Online Member Registration (OMR).

Event Example:

{
    "eventSequence": 1234,
    "eventType": "Member Registration Complete",
    "clubId": "EFD6F74613444017B0DB1884AADBC117",
    "modifiedDatetime": "2022-09-13T22:52:28.882Z",
    "eventData": {
        "vendorId": "DB1884AADBC117",
        "memberId": "string"
    }
}

After Receiving the Above Event

GET: /swims/getMemberDetails/{clubId}/?memberId={memberId}&lastModified={lastModified}

• IF: new member → Add member data to the roster.
• IF: renewing member → Update member data in the roster.

Generated when a member is updated within SWIMS.

Event Example:

{
    "eventSequence": 1234,
    "eventType": "Member Updated",
    "clubId": "EFD6F74613444017B0DB1884AADBC117",
    "modifiedDatetime": "2022-09-13T22:52:28.882Z",
    "eventData": {
        "memberId": "string"
    }
}

After Receiving the Above Event

GET: /swims/getMemberDetails/{clubId}/?memberId={memberId}

Update member data in the roster.

Generated when two Member IDs are merged within SWIMS.

Event Example:

{
  "eventSequence": 1234,
  "eventType": "Member Merge",
  "clubId": "1500B689DCAA42BD9484618C634DDEF0",
  "modifiedDatetime": "2022-09-13T22:52:28.882Z",
  "eventData": {
    "oldClubId": "1500B689DCAA42BD9484618C634DDEF0",
    "oldMemberId": "B71E543DBAB6BE",
    "newClubId": "6C5D210FBE0549C3A9F269E07A411E95",
    "newMemberId": "7F5564C5585A97"
  }
}

After Receiving the Above Event

GET: /swims/getMemberDetails/{clubId}/?memberId={memberId}

• IF: Member Merge is within the same club → One event if you are the vendor of the club.
• IF: Member Merge is across clubs and you are the vendor for the destination club → One event if you are not the vendor for the source club.
• IF: Member Merge is across clubs and you are the vendor for the source club → One event if you are not the vendor for the destination club.
• IF: Member Merge is across clubs → Two events if you are the vendor for both the source and destination clubs. Ignore the second event.

A special set of events occurs when a member transfers clubs.

• In SWIMS, the transfer is initiated from the Member Details Page by clicking the Initiate Transfer link.
• The new club is entered, along with other necessary transfer details.
• This process creates two new events:
  • Member Transfer From Club Event → Sent to the club the member is transferring out of.
  • Member Transfer To Club Event → Sent to the club the member is transferring into.

Note:
The Vendor Software will only receive both events if both clubs are activated for the vendor.

Similar to the Member Registration Event, the vendor software must reconcile the member data in their system.

Vendor Actions for Transfers:

• IF: the member is not found in the vendor’s system
  THEN: Create the member in the vendor’s system.
• IF: the member already exists in the vendor’s system
  THEN: Update the member information and perform any necessary club transfer procedures in the vendor’s system.

In both cases, the vendor must call the following endpoint to retrieve updated member details:

GET: /swims/getMemberDetails/{clubId}/?memberId={memberId}

The Member Cancels Event notifies the vendor that a member has canceled their membership with the club associated with the vendor.

A club activates or deactivates a vendor in SWIMS. This event is generated when a club selects and approves a vendor in SWIMS.

Event Example:

{
  "eventSequence": "002",
  "eventType": "Member Updated",
  "clubId": "EFD6F74613444017B0DB1884AADBC117",
  "modifiedDatetime": "2022-09-13T22:52:28.882Z",
  "eventData": {
    "clubId": "string"
  }
}

After Receiving the Event

1. Get a list of clubs for a vendor
   GET: /swims/getVendorClubs/vendor
2. For all new clubs, add members to the club roster
   GET: /swims/getMemberDetails/club/{clubId}
3. Populate tables with a complete club roster

eventSequence:
A calculated value that is distinct per vendor, defining the sequence in which events occur.

eventTypeId:
An internal Primary Key (PK) reference to the event type.

eventType:
The name of the event that occurred (e.g., Member Updated).

eventData:
A stringified JSON object containing various event-related data, depending on the event type.