POST api/v2.0/Volunteer/VolunteerForOpportunityByLegacyContactKey?volunteerOpportunityKey={volunteerOpportunityKey}&legacyContactKey={legacyContactKey}&comments={comments}
Volunteer a Contact for a specific Volunteer Opportunity. Administrative access is required.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
volunteerOpportunityKey |
Unique Key for the Volunteer Opportunity to Volunteer for. |
globally unique identifier |
Required |
legacyContactKey |
Unique Integration Key for the Contact to Volunteer for the Opportunity. |
string |
Required |
comments |
Any comments to add to the Volunteer Opportunity record. |
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": "e431184c-60b4-4f35-8d4d-74781c6ce96e", "Title": "sample string 2", "Description": "sample string 3", "Deadline": "sample string 4", "AdditionalRequirements": "sample string 5", "Location": "sample string 6", "VolunteersNeeded": 7, "CreatedOn": "2021-01-19T08:35:59.3201469Z", "CloseDate": "2021-01-19T08:35:59.3201469Z", "UpdatedOn": "2021-01-19T08:35:59.3201469Z", "EstimatedHours": 11.0, "SkillMultiplier": 12.0, "StartDateTime": "2021-01-19T08:35:59.3201469Z", "EndDateTime": "2021-01-19T08:35:59.3201469Z", "Community": { "AllowMemberCreatedEvents": true, "AllowTickets": true, "CanMembersInviteOthers": true, "CommunityKey": "3929fa88-9869-4bf7-903f-4d23a4415900", "LegacyGroupKey": "sample string 5", "CommunityName": "sample string 6", "CommunitySize": 7, "CommunityType": "sample string 8", "CommunityTypeKey": "9c61e17f-c825-42e3-9bd6-0a5123fe68c8", "CommunityTypeName": "sample string 10", "CreatedByContactKey": "6818bef9-ecd9-424f-94a8-eae7c3d4b8f6", "CreatedOn": "2021-01-19T08:35:59.3201469Z", "Description": "sample string 13", "Html": "sample string 14", "IsSubscribedToDiscussion": true, "IsOnCommunitySync": true, "JoinPermissionKey": "f726b7c1-5f17-4c66-811e-7a890282e78f", "LibraryKey": "8dd13b2f-1ac9-40f0-a566-5fae0ef23994", "LibraryName": "sample string 19", "LinkToCommunity": "sample string 20", "LinkToCommunityCalendar": "sample string 21", "LinkToDiscussion": "sample string 22", "LinkToLibrary": "sample string 23", "LinkToWebsite": "sample string 24", "DiscussionKey": "733644ff-ef53-43de-9cd2-dc7421832b5d", "DiscussionName": "sample string 26", "MicrositeGroupKey": "04cedc73-0d61-48ed-ac1c-4f005e2c1ba6", "SiteName": "sample string 28", "ViewPermissionKey": "d2834e32-2122-4112-9752-6895d9eca9c5", "Statistics": { "BlogCount": 1, "DocumentCount": 2, "MemberCount": 3, "DiscussionPostCount": 4, "CurrentYearAnnouncementCount": 5, "CurrentYearEventCount": 6, "LastDocumentUpdatedDate": "2021-01-19T08:35:59.3201469Z", "LastMemberJoinedDate": "2021-01-19T08:35:59.3201469Z", "LastPostingDate": "2021-01-19T08:35:59.3201469Z", "LastBlogPublishedDate": "2021-01-19T08:35:59.3201469Z", "LastAnnouncementUpdatedOnDate": "2021-01-19T08:35:59.3201469Z", "LastEventUpdatedOnDate": "2021-01-19T08:35:59.3201469Z", "MaxActivityDate": "2021-01-19T08:35:59.3201469Z", "MinActivityDate": "2021-01-19T08:35:59.3201469Z" }, "CreatedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "17cc10fe-ba4c-47e8-8bfe-33307edf5bdc", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2021-01-19T08:35:59.3201469Z", "UpdatedByContactKey": "84311dab-3773-439c-bfad-28df82796b5d", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2021-01-19T08:35:59.3201469Z" }, "IntegrationKey": "sample string 30", "IntegrationTypeKey": "sample string 31", "ParentCommunityKey": "c8c68038-872c-4376-8654-4d20951064e1" }, "RequiresApproval": true, "Status": 0, "StatusText": "sample string 16", "CanSignUpViaApi": true, "ApplicationStatus": 0, "ApplicationStatusText": "sample string 18", "VolunteerOpportunityTypeKey": "82d44373-98e7-42f8-a7e0-24fddbaf6911", "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>2021-01-19T03:35:59.3201469-05:00</CloseDate> <CreatedOn>2021-01-19T03:35:59.3201469-05:00</CreatedOn> <Deadline>sample string 4</Deadline> <Description>sample string 3</Description> <EndDateTime>2021-01-19T03:35:59.3201469-05: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>2021-01-19T03:35:59.3201469-05:00</StartDateTime> <StatusText>sample string 16</StatusText> <Title>sample string 2</Title> <UpdatedOn>2021-01-19T03:35:59.3201469-05:00</UpdatedOn> <VolunteerOpportunityKey>e431184c-60b4-4f35-8d4d-74781c6ce96e</VolunteerOpportunityKey> <VolunteerOpportunityTypeKey>82d44373-98e7-42f8-a7e0-24fddbaf6911</VolunteerOpportunityTypeKey> <VolunteerSpotsAvailable>25</VolunteerSpotsAvailable> <VolunteersNeeded>7</VolunteersNeeded> </VolunteerOpportunity>