API request field names different than API response

Jeffrey Kaplan 3

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

Jeffrey Kaplan 3

I found that the column names are defined in this XML document detailing the teamraiser record structure, including the participant record: