POST api/v2.0/Volunteer/VolunteerForOpportunityByContactKey?volunteerOpportunityKey={volunteerOpportunityKey}&contactKey={contactKey}&comments={comments}
Volunteer a Contact for a specific Volunteer Opportunity. Can only be accessed by an Admin user.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
volunteerOpportunityKey |
Unique Key for the Volunteer Opportunity to Volunteer for. |
globally unique identifier |
Required |
contactKey |
Unique Higher Logic Contact Key for the Contact to Volunteer for the Opportunity. |
globally unique identifier |
Required |
comments |
Any comments to add to the Volunteer |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
VolunteerOpportunityName | Description | Type | Additional information |
---|---|---|---|
VolunteerOpportunityKey |
The Unique Identifier for the Volunteer Opportunity. |
globally unique identifier |
None. |
Title |
The Title of the Volunteer Opportunity. |
string |
None. |
Description |
Descriptions for the Volunteer Opportunity. |
string |
None. |
Deadline |
Sign-up deadline for the Volunteer Opportunity. |
string |
None. |
AdditionalRequirements |
Additional Volunteer Requirements for this Volunteer Opportunity. |
string |
None. |
Location |
Location for the Volunteer Opportunity. |
string |
None. |
VolunteersNeeded |
Number of Volunteers needed for this Volunteer Opportunity. |
integer |
None. |
CreatedOn |
Date the Volunteer Opportunity was created. |
date |
None. |
CloseDate |
Date that registration as a Volunteer Closes. |
date |
None. |
UpdatedOn |
Date this Volunteer Opportunity was last updated. |
date |
None. |
EstimatedHours |
Estimated Hours required for the Volunteer Opportunity. |
decimal number |
None. |
SkillMultiplier | decimal number |
None. |
|
StartDateTime |
Date and Time the Volunteer Opportunity begins. |
date |
None. |
EndDateTime |
Date and Time the Volunteer Opportunity ends. |
date |
None. |
Community |
If the Volunteer Opportunity is linked to a specific Community, this will contain the Community data for that Community. |
Community |
None. |
RequiresApproval |
Indicates whether the Volunteer Opportunity requires approval by an administrator. **Note that at this time, only Volunteer Opportunities where this value is FALSE can be Volunteered for via the API. |
boolean |
None. |
Status |
Enumeration for the Volunteer Opportunity's Status. May be null. See the Status Object documentation for additional information about possible values. |
Status |
None. |
StatusText |
The Volunteer Opportunity's Status. |
string |
None. |
CanSignUpViaApi |
Tells whether a user can Volunteer for this Opportunity via the API. |
boolean |
None. |
ApplicationStatus |
The status of the Volunteer Opportunity Application/Sign-up for the current user. |
VolunteerApplicationStatuses |
None. |
ApplicationStatusText |
The Application Status text. |
string |
None. |
VolunteerOpportunityTypeKey |
Indicates the opportunity type that the Volunteer Opportunity is associated with |
globally unique identifier |
None. |
LinkToListOfOpportunities |
Link to reach the volunteer opportunities page |
string |
None. |
PictureUrl |
Thumbnail image src associated to Volunteer Opportunity |
string |
None. |
LinkToOpportunity |
Link to reach the specific Volunteer Opportunity |
string |
None. |
OpportunityName |
Name of the Volunteer Opportunity |
string |
None. |
OpportunityAddress |
Exact Address for the Volunteer Opportunity |
string |
None. |
VolunteerSpotsAvailable |
The number of volunteer spots that are left for the Volunteer Opportunity |
integer |
None. |
Points |
The total points that will be awarded to the Volunteer for the Volunteer Opportunity |
integer |
None. |
VolunteerOpportunityIntegrationCode |
The unique AMS code for this Volunteer Opportunity |
string |
None. |
Response Formats
application/json, text/json
{ "VolunteerOpportunityKey": "5bc28b95-2257-4be8-9ac2-321e7c289db4", "Title": "sample string 2", "Description": "sample string 3", "Deadline": "sample string 4", "AdditionalRequirements": "sample string 5", "Location": "sample string 6", "VolunteersNeeded": 7, "CreatedOn": "2024-11-02T15:31:00.1717532Z", "CloseDate": "2024-11-02T15:31:00.1717532Z", "UpdatedOn": "2024-11-02T15:31:00.1717532Z", "EstimatedHours": 11.0, "SkillMultiplier": 12.0, "StartDateTime": "2024-11-02T15:31:00.1717532Z", "EndDateTime": "2024-11-02T15:31:00.1717532Z", "Community": null, "RequiresApproval": true, "Status": 0, "StatusText": "sample string 16", "CanSignUpViaApi": true, "ApplicationStatus": 0, "ApplicationStatusText": "sample string 18", "VolunteerOpportunityTypeKey": "60531988-74cf-41b1-ae68-74b93f6dfc19", "LinkToListOfOpportunities": "sample string 20", "PictureUrl": "sample string 21", "LinkToOpportunity": "sample string 22", "OpportunityName": "sample string 23", "OpportunityAddress": "sample string 24", "VolunteerSpotsAvailable": 25, "Points": 26, "VolunteerOpportunityIntegrationCode": "sample string 27" }
application/xml, text/xml
<VolunteerOpportunity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Volunteer"> <AdditionalRequirements>sample string 5</AdditionalRequirements> <ApplicationStatusText>sample string 18</ApplicationStatusText> <CloseDate>2024-11-02T11:31:00.1717532-04:00</CloseDate> <CreatedOn>2024-11-02T11:31:00.1717532-04:00</CreatedOn> <Deadline>sample string 4</Deadline> <Description>sample string 3</Description> <EndDateTime>2024-11-02T11:31:00.1717532-04:00</EndDateTime> <EstimatedHours>11</EstimatedHours> <LinkToListOfOpportunities>sample string 20</LinkToListOfOpportunities> <LinkToOpportunity>sample string 22</LinkToOpportunity> <Location>sample string 6</Location> <OpportunityAddress>sample string 24</OpportunityAddress> <OpportunityName>sample string 23</OpportunityName> <PictureUrl>sample string 21</PictureUrl> <Points>26</Points> <RequiresApproval>true</RequiresApproval> <SkillMultiplier>12</SkillMultiplier> <StartDateTime>2024-11-02T11:31:00.1717532-04:00</StartDateTime> <StatusText>sample string 16</StatusText> <Title>sample string 2</Title> <UpdatedOn>2024-11-02T11:31:00.1717532-04:00</UpdatedOn> <VolunteerOpportunityKey>5bc28b95-2257-4be8-9ac2-321e7c289db4</VolunteerOpportunityKey> <VolunteerOpportunityTypeKey>60531988-74cf-41b1-ae68-74b93f6dfc19</VolunteerOpportunityTypeKey> <VolunteerSpotsAvailable>25</VolunteerSpotsAvailable> <VolunteersNeeded>7</VolunteersNeeded> </VolunteerOpportunity>