Changes to the Event API (Beta)

Kimberly Coughlin

The Event API (Beta) was updated on 7/10/2020. We added new post, patch, and delete Event category endpoints. We also introduced a breaking change. The Get event categories endpoint no longer accepts the limit or offset parameters.

See our Changelog entries for more information.  

 

Steven Cinquegrana

Sometime between the May 24, 2020 release and this one the OpenAPI definition has breaking changes to derived-code.


There're now model names changed to have a "V2" suffix, specifically CreateParticipantV2, EditParticipantV2 and ParticipantV2 which constitute breaking changes to derived code.


Would someone please check these things before you release an update? It makes our life harder than it has to be finding and manually correcting these errors.

 

Steven Cinquegrana

The Event API OpenAPI definition also contains a namespace/type conflict for Event. Other APIs (generally) differentiate the type from the namespace by naming the type, for example, EventRead, EventAdd, etc.


Please consider sticking to the schema of the more mature APIs such as Constituent, Gift, General Ledger, etc to avoid these kinds of issues.


As this API already departs from the others in naming convention, in the Event API's case, please also consider renaming the Event model ReadEvent to align with CreateEvent, EditEvent etc. (With associated changes to the methods.)

 

Samantha McGuin

Steven Cinquegrana‍  Thank you for this feedback!


We will be releasing a change today on the v2 suffixes. We have passed on your point about the namespace/type conflict with the team and we are evaluating a future change on this topic.


Stay tuned to the Announcements for the v2 change, and thank you for providing feedback to our Beta Events API release!


 

Steven Cinquegrana

Samantha McGuin Was there any more regarding the namespace/type conflicts? This is still evident in the latest release.