The Member API enables third-party systems to create or update member records in Cadmium's registration solution for membership validation and pricing. To learn more about how the member lookup feature works in registration, please speak with your Cadmium project manager (existing customers) or account manager.
The third-party system is responsible for updating Cadmium when a change is made to a member record in the AMS, ideally triggered automatically when membership data changes.
Note, member data is stored in Cadmium at the organization/client level, not at the individual event level. Member records are shared across all events under your organization.
Get Started
API access must be contracted. Once confirmed, Cadmium will provide the credentials required to access the API.
Member category data is tied closely to registration pricing. You'll work closely with your registration project manager to set up your registration form, and Cadmium will provide the necessary level IDs and/or category IDs, if applicable.
Provide the following to your third-party developer:
- API credentials
- This documentation
- Level IDs (if applicable)
- Category IDs (if applicable)
Add/Update Member
Use this endpoint to add new member records or update existing member data in Cadmium's system.
Endpoint: https://www.edgereg.net/er/API/ERPeople/addMember.jsp?
Method: GET (not POST)
Insert/Update: Match on MemberID (external ID) - if the record includes a MemberID that already exists, then the record will be updated instead of created.
Required Parameters:
- AccountToken
Required Fields:
- Status (numerical 0 or 4)
- 0 for Active Member
- 4 for Non-Member
- MemberID (external unique ID)
- Email (if using lookup by email address)
Optional Fields:
- FirstName
- LastName
- Salutation
- MiddleName
- Suffix
- Company
- Title
- Department
- PhoneNumber
- Fax
- Address1
- Address2
- City
- State (see attachment at bottom of this article for acceptable values)
- ZipCode
- Country (ISO 3166-1 alpha-2 or alpha-3 codes)
- Level ID (provided by Cadmium)
- Category ID (provided by Cadmium)
Sample URL:
- https://www.edgereg.net/er/API/ERPeople/addMember.jsp?AccountToken=XXXX&MemberID=XXXX&Level=XXX&Status=0&FirstName=John&LastName=Doe https://www.edgereg.net/er/API/ERPeople/addMember.jsp?AccountToken=XXXXX&MemberID=XXXXX&Category=XXXX&Status=0&FirstName=John&LastName=Smith&Salutation=Mr&MiddleName=Joe&Suffix=Sr&Company=ABC%20Accounting&Title=Vice%20President&Address1=123%20Street&Address2=Apt2&City=Springfield&State=MD&ZipCode=12345&Country=Guam&Email=test@test.com&Department=Accounting&PhoneNumber=(123)123-1234
Response:
- If a member is successfully added or updated, you will receive an XML response containing a MemKeyID which is Cadmium's unique reference ID. Note, since we use the external MemberID for upserts, it's not critical for you to store this value.
Sample Output:
- <Member>
<MemKeyID>1234</MemKeyID>
</Member>
Get Member
Use this endpoint to retrieve and verify member data stored in Cadmium's system.
Endpoint: https://www.edgereg.net/er/API/ERPeople/getMember.jsp?
Method: GET
Required Parameters:
- AccountToken
- MemberID (external unique ID)
Best Practices
- Unique Email Address: Each member record should have a unique email address. If multiple records share the same email address, the email-based lookup feature will not function properly and may return unexpected results.
- Member ID Changes:Since member ID serves as the unique identifier for updates, changing a member's ID requires a two-step process:
- Original Record: Set the email field to empty/null to prevent the outdated record from being returned by the email lookup.
- New Record: Insert a new record with the updated member ID, ensuring all previously mapped optional field values are included.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article