Convention volunteers.
Volunteers are accessed via /api/volunteer.
See "Object Properties" in Introduction for basic shared properties.
Complete details in VolunteerProperties. It also has these extra read-only properties:
The Volunteer's firstname and lastname joined by a space,
e.g.
if firstname is "Joe",
and lastname is "Volunteer",
name is "Joe Volunteer".
See "Related Objects" in Introduction for how to use them.
The Convention this Volunteer belongs to.
The User this Volunteer belongs to.
See "Relationships" in Introduction for how to use them.
The list of Shifts applied for by the Volunteer (via their "volunteershifts").
The list of VolunteerShifts associated with the Volunteer.
The conventionday_id field in the VolunteerShift's related Shift record.
You must include parameter _include_related_objects=shift with the request for this to work.
See "Includes" in Introduction for how to use them.
Returns a "1" or a "0" (zero). "1" means the Volunteer has scheduled shifts, "0" means the Volunteer has no scheduled shifts.
Returns the list of shifts for which the Volunteer is scheduled.
The services used to fetch and manipulate Volunteers.
Searching across all conventions is not enabled. To search within a single convention's Volunteers, see "Relationships" in Convention.
POST /api/volunteer
This is automatically set to the current session's user's id. Users cannot create Volunteer records for others. Convention organizers can create volunteers with the "Administratively Create Volunteer" service.
A Volunteer's name must be unique for the convention.
Returns the same as a normal read.
GET /api/volunteer/xxx
Returns:
{
"id" : "xxx",
"firstname" : "Joe",
"lastname" : "Volunteer",
...
}
PUT /api/volunteer/xxx
Returns the same as a normal read.
DELETE /api/volunteer/xxx
You cannot delete a Volunteer who has scheduled shifts.
Returns:
{
"success" : 1
}
POST /api/volunteer/xxx/submit
Alerts organizers with the volunteers privilege that there is a new volunteer application.
POST /api/volunteer/xxx/message-managers
Sends an email message to all convention Volunteer Managers.
Sends the message to the volunteer's contact email as a test.
Returns:
{
"success" : 1
}
POST /api/volunteer/by-organizer
This will create a volunteer record for another user (not the organizer).
Same as a normal volunteer creation.
Using the email_address field, one of two things will happen. If the email address is already in use by one of Tabletop.Events' users, the volunteer record will be attached to that user account. If the email address is not in use, then an account with that email address will be created and the user will be emailed asking them to set a password for their account.
Note that the email address a person uses in a volunteer application can be different from their user account email address.
If the email address is already in use by a volunteer for the convention, the volunteer creation will fail (and no user account will be generated).
Returns the same as a normal read.