SWIMS Terms
- competitionCategory:
- Stated as male or female for the purpose of athlete swimming eligibility, competition, selection and records. An athlete's stated competition category shall be referred to as "gender."
- contactRelationship:
- Denotes the relationship between the member and their primary contact.
- emailAddress:
- Denotes a valid email address.
- isUsCitizen:
- Denotes whether or not the member is a US Citizen.
- memberships:
- Denotes which offering instances (e.g. Coach, Official, Premium Athlete, etc.) are included in a registration.
- phoneType:
- Denotes which type of phone has been entered (cell, home, or work).
- athleteOfferingsOptIn:
- Denotes a club’s decision to use the Club Bulk Renewal tool for athlete renewals. When true, clubs handle all athlete renewals. When false, athletes handle their own renewals.
- nonAthleteOfferingsOptIn:
- Denotes a club’s decision to use the Club Bulk Renewal tool for non-athlete renewals. When true, clubs handle all non-athlete renewals. When false, non-athletes handle their own renewals.
- memberId:
- New randomly-generated 14 alphanumeric ID that will be a member’s unique identifier
- oldUsasId :
- Old USA Swimming 14 character ID using first name, middle initial, last name, and birthdate
- firstName:
- The first name of a Member as listed in SWIMS
- preferredName:
- The name of a Member that the member would prefer to be called as listed in SWIMS
- middleName:
- The middle name of a Member as listed in SWIMS
- lastName:
- The last name of a Member as listed in SWIMS
- suffix:
- The suffix will follow the member’s full name and provide additional information about the member. This information includes generational designations, such as Sr. or Jr., but will also denote education or honors, such as Esq. or Ph.D.
- maidenName:
- The maiden name of a Member as listed in SWIMS
- birthDate:
- The date of birth of a Member as listed in SWIMS
- competitionCategory:
- New terminology used for Gender
- contactInformation / primaryContactInfo:
- A Member’s primary contact (Guardian/Emergency Contact depending on age) listed in SWIMS
- contactFirstName:
- The first name of a Member’s primary contact (Guardian/Emergency Contact depending on age) listed in SWIMS
- contactLastName:
- The last name of a Member’s primary contact (Guardian/Emergency Contact depending on age) listed in SWIMS
- contactEmail:
- The email address of a Member’s primary contact (Guardian/Emergency Contact depending on age) listed in SWIMS
- contactPhone:
- The phone number of a Member’s primary contact (Guardian/Emergency Contact depending on age) listed in SWIMS
- registrationDate:
- The date of a member registration
- expirationDate:
- The date that a member’s registration expires. This date is inclusive, meaning that the member’s registration is in good standing through that date.
- offeringId:
- The ID of the registration type
- registrationId:
- This is an internal Primary Key (PK) reference to the registration
- registrationType:
- Descriptor for the registration type
- registrationTypeId:
- This is a reference to the type of registration that occurred (Coach, Premium Athlete, Flex, etc.)
- transactionType:
- Registration, Upgrade, or Cancel
- usasFee:
- USA Swimming’s membership fee. For Upgrades, this field will show the delta between original USAS Fee and the upgraded membership USAS Fee.
- lscFee:
- The member’s Local Swimming Committee membership fee. For Upgrades, this field will show the delta between original LSC Fee and the upgraded membership LSC Fee.
- lscCode:
- The alphabetic code that identifies the LSC (eg. CO, AZ, AD, etc.).
- isRenewal:
- Is the registration for an existing member or a new member
- isAttached:
- Refers to if the member is attached to a club at that moment in time, there are x days between when a member is a member of a club and when they transfer clubs.
- attachedDate:
- The date they attach to a club and officially become a member
- memberGoodStandingExpirationDate:
- The date that a member is no longer “In Good Standing”. This date is inclusive, meaning that the member is in good standing through that date.
- In Good Standing:
- Used to describe all member requirements by registration type are met. For example, an 18+ year old athlete must complete Athlete Protection Training to be a “Member in Good Standing”
- clubId:
- Alphanumeric ID that is a club’s unique identifier
- clubCode:
- A Globally Unique Identifier (GUID) that represents the club
- clubName:
- The name of the club.
- vendorId:
- Alphanumeric ID that is a vendor’s unique identifier
- vendorRecordId:
- A value that the vendors send to USAS so they can better track members registrations
- Upgrade:
- When a member upgrades their membership, their initial membership will expire (expiration date is set to yesterday). There will be a new registration record with a registration date of today and an expiration date of the end of the season.
Event Terms
- eventSequence:
- A calculated value that is distinct by vendor to define the sequence in which events occur
- eventTypeId:
- This is an internal Primary Key (PK) reference to the event Type
- eventType:
- The name of the event that occurred (ie, Member Updated, etc.)
- eventData:
- A stringified JSON object that contains different data depending on the event