Release News: Church Volunteer API (beta)
Published
The Church Volunteer API (beta) was released on 07/08/2020. The API enables developers to manage volunteer, opportunity, and position information in Church Management. This initial release includes endpoints to add, edit, and delete volunteers, opportunities, and positions. It also includes endpoints to manage teams, requirements, assignments, and emergency contacts.
For more updates, see the changelog.
For more updates, see the changelog.
News
SKY Developer Announcements
07/08/2020 3:47pm EDT
Leave a Comment
Much better, Luke Stitzinger , thanks. You still have the version (v1/) in the element path but I guess that's your call.
We just updated the API names. Take a look and let us know what you think!
I just noticed that you have the API version prefixing each element path rather than the base path.
Eg
Church Volunteer API
Base path: /volunteer, Element path: /v1/volunteers/{volunteer_id}
Constituent API
Base path: /constituent/v1, Element path: /constituents/{constituent_id}
This seems to be quite a random thing with the SKY APIs. The base path should contain the version, ala the General Ledger, Account Payable, Constituent, etc APIs and NOT like the Event, School, Payments, etc APIs. You would only have the version in the element paths if you intended to individually version endpoints and that's a pretty strange thing to do. In any case, the variation between APIs represents a whole bunch of unnecessary inconsistency.
Luke Stitzinger can we assume that the names will have the "BlackbaudVolunteerSkyApiServiceServiceClientsVolunteerDataService" part lopped off the front, leaving names like VolunteerAdd and VolunteerEdit? If so, we can make a manual edit and publish the API to our SKYLib.NET library.
And will the namespace remain "volunteer" or will it change?
The OpenAPI definition for this API generates some very weird model objects compared to other APIs.
For example models from the Constituent API look like this:
ConstituentAdd, ConstituentEdit, etc.
Models from the Church Volunteer API look like this:
BlackbaudVolunteerSkyApiServiceServiceClientsVolunteerDataServiceVolunteerAdd, BlackbaudVolunteerSkyApiServiceServiceClientsVolunteerDataServiceVolunteerEdit, etc.
This means that derived code objects are ridiculously unwieldy. Would whoever created the definition please consider using a schema more like one of the more mature APIs, such as Constituent?