API request field names different than API response
Is there any documentation on the proper field names for sorting and filtering API requests?
I ask because the columns are often named differently in the API request than in the API response, and the API documentation at open.convio.com only lists the response values, not the request values.
For example, when using the Teamraiser getParticipants API method, the response is structured with the following key/value pairs:
participant: [{
"aTeamCaptain":"false",
"amountRaised":"5180",
badges: { },
"consId":"1001000",
donationUrl: http://example.com/donateurl,
ecommercePurchaseUrl: null,
eventId: "1000",
eventName: "Event 1000",
goal: "105060",
name: {
last: Sample01,
first: Participant
},
personalPagePrivate: false,
personalPageUrl: "http://example.com/personalpageurl",
teamEcommercePurchaseUrl: null,
teamName: { },
teamPageUrl: { },
}]
But if you try to sort or filter your API request using the “list_sort_column” or “list_filter_column” parameters, the names provided in the API response only work for some fields. Some fields have different name formats or event different phrasing, and some I can't figure out at all.
- getParticipants
- request name → response name
- goal → goal
- teamName → team_name
- consId → cons_id
- first → first_name
- last → last_name
- aTeamCaptain → is_captain
- eventName → title
- eventId → fr_id
- amountRaised → total
Comments
-
I found that the column names are defined in this XML document detailing the teamraiser record structure, including the participant record:
0
Categories
- All Categories
- 6 Blackbaud Community Help
- 211 bbcon®
- 1.4K Blackbaud Altru®
- 402 Blackbaud Award Management™ and Blackbaud Stewardship Management™
- 1.1K Blackbaud CRM™ and Blackbaud Internet Solutions™
- 15 donorCentrics®
- 360 Blackbaud eTapestry®
- 2.6K Blackbaud Financial Edge NXT®
- 655 Blackbaud Grantmaking™
- 576 Blackbaud Education Management Solutions for Higher Education
- 3.2K Blackbaud Education Management Solutions for K-12 Schools
- 940 Blackbaud Luminate Online® and Blackbaud TeamRaiser®
- 84 JustGiving® from Blackbaud®
- 6.7K Blackbaud Raiser's Edge NXT®
- 3.7K SKY Developer
- 248 ResearchPoint™
- 120 Blackbaud Tuition Management™
- 165 Organizational Best Practices
- 240 Member Lounge (Just for Fun)
- 34 Blackbaud Community Challenges
- 37 PowerUp Challenges
- 3 (Open) PowerUp Challenge: Grid View Batch
- 3 (Closed) PowerUp Challenge: Chat for Blackbaud AI
- 3 (Closed) PowerUp Challenge: Data Health
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Product Update Briefing
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Standard Reports+
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Email Marketing
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Gift Management
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Event Management
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Home Page
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Standard Reports
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Query
- 796 Community News
- 3K Jobs Board
- 54 Blackbaud SKY® Reporting Announcements
- 47 Blackbaud CRM Higher Ed Product Advisory Group (HE PAG)
- 19 Blackbaud CRM Product Advisory Group (BBCRM PAG)
