Get Event Participants returns "The list field 'first_name' is not valid"

Mark Ross

I'm making a webservice call to the SKY API to GET the participants for an event. I'm using the fields parameter to tell the function to only return "first_name" fields. When doing so, I'm getting the following error:


[{

"message": "The list field 'first_name' is not valid.",

"

"error_name": "ListFieldNotValid",

"

"error_code": 39,

"

"raw_message": "The list field '{0}' is not valid.",

"

"error_args": ["first_name"]

}]

Here's the call that I'm making:

<a href="https://api.sky.blackbaud.com/event/v1/events/59/participants?fields=first_name" target="_blank">https://api.sky.blackbaud.com/<wbr />event/v1/events/59/<wbr />participants?fields=first_name</a>

Here's a JSON record from when I used fields=name :

{

"name": "Eric Arndt",

"first_name": "Eric",

"last_name": "Arndt",

"class_of": ""

},

So, first_name is a valid field. Is it not?

Steven Cinquegrana

Hi Mark,


I can confirm the problem; seems that a lot of the supposedly-supported fields such as preferred_name, former_name, title, etc are not (yet).


The parameter ({0}) in raw_message needs filling as well.


Needs proper testing/fixing or doco corrected I'd say.


BTW, I think this belongs under the Event API discussion group, rather than Fundraising.


Cheers,

Steve Cinquegrana | CEO and Principal Developer | Protégé Solutions

Samantha McGuin

Hi Mark,


Thank you for your beta feedback! It looks like you caught a miss with our documentation and we've filed a bug to better document the fields that are supported when requesting participants. Currently this endpoint only returns the individual name parts when the name field is requested. Depending on your organization setup in RE configuration, the name parts can include first name, middle name, last name, preferred name, former name, title, suffix and class of.


Would better documentation around what fields can be requested from the list endpoint suffice for your current efforts? Or are you looking to make requests for only certain name parts but not others?


Samantha McGuin

Prinicipal Product Manager, Blackbaud

Mark Ross

Hi Samantha,

Thanks for the reply. Better documentation around what fields can be requested from the list endpoint will work for now. Based on that list, I'll select what fields to query. Ultimately, being able to query for first_name and last_name should be included as queriable field names when using the fields parameter.


Thanks,

Mark