API Usage

Y-USA STUDIO is organized around REST-based operations. Whether you’re new to the Y-USA STUDIO Platform or seasoned in all things API, this is where you’ll find out what operations and access to data authorized by your subscription access, sync your client's membership and usage data (approved vendors only), and visualize what applications and reports can be generated.

Membership Sync Validations

Schema Validation

1. We are validating records based on key names. If any of the required key names are missing in the payload, the record will be marked as invalid.
   The following key names are required:  

   • "LocalBranchNumber"

   • "AssociationNumber"

   • "MembershipStatus"

   • "LocalMemberID"

   • "FamilyHouseHoldorUnitID"

   • "MembershipType"

   • "MemberFirstName"

   • "MemberMiddleName"

   • "MemberLastName"

   • "MemberEmail"

   • "PrimaryMemberFirstName"

   • "PrimaryMemberMiddleName"

   • "PrimaryMemberLastName"

   • "PrimaryMemberEmail"

   • "DependentMember"

   • "MemberHomePhone"

   • "MemberMobilePhone"

   • "StreetAddressLine1"

   • "StreetAddressLine2"

   • "MemberCity"

   • "MemberState"

   • "MemberCountry"

   • "MemberGender"

   • "MemberDateOfBirth"

   • "MemberBarcode"

   • "MemberEmployer"

   • "EmergencyContact1Name"

   • "EmergencyContact1Phone"

   • "MemberJoinDateOriginal"

   • "MemberJoinDateCurrent"

   • "TerminationDate"

   • "ReciprocityEligible"

   • "MonthlyDuesRate"

   • "MonthlyDiscountRate"

   • "MemberEthnicity"

   • "MemberZip"

   • "DiscountName"

2.  If a required key name exists but its value is missing in the payload, the record will also be marked as invalid.
   The following key names must have values:  

   • "LocalBranchNumber"

   • "AssociationNumber"

   • "MembershipStatus"

   • "LocalMemberID"

   • "FamilyHouseHoldorUnitID"

   • "MemberFirstName"

   • "MemberLastName"

   • "PrimaryMemberFirstName"

   • "PrimaryMemberLastName"

   • "StreetAddressLine1"

   • "MemberCity"

   • "MemberState"

   • "MemberDateOfBirth"

   • "MemberBarcode"

   • "MemberZip"

Data Validation

• Data Validation Rules: Here we will perform the following filtering to the data before passing along for landing table insertion: 

• Non-Human Identity Rules : We will reject member records if the following fields contain the following values. We will maintain two dictionaries, one for "equals terms" and one for "like terms":