POST api/v2.0/Volunteer/AddToPoolByLegacyKey?legacyContactKey={legacyContactKey}

Add a new user to the General Volunteer Pool. Can only be accessed by an Admin user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
legacyContactKey

LegacyContactKey (Source System ID) of the user to add to the Volunteer Pool.

string

Required

Body Parameters

None.

Response Information

Resource Description

Volunteer
NameDescriptionTypeAdditional information
VolunteerKey

The Unique Identifier for a Volunteer.

globally unique identifier

None.

ContactKey

The Unique Identifier for the Contact associated with this Volunteer record.

globally unique identifier

None.

VolunteerOpportunityTravelKey

The Unique Identifier for the Travel Information for this Volunteer record.

globally unique identifier

None.

Bio

Volunteer Biography information.

string

None.

StartOn

Volunteer availability start date.

date

None.

EndOn

Volunteer availability end date.

date

None.

VolunteerExperienceLevel

Level of Volunteer Experience.

VolunteerExperienceLevel

None.

VolunteerOpportunityTravel

Volunteer Travel preferences.

VolunteerOpportunityTravel

None.

Response Formats

application/json, text/json

Sample:
{
  "VolunteerKey": "9119c778-1a9d-4b57-9cc3-c6c83f713179",
  "ContactKey": "9ddecb96-1bf3-4c90-a90a-71468d6a48f4",
  "VolunteerOpportunityTravelKey": "8ce48336-e239-46da-9306-da2166448fe4",
  "Bio": "sample string 4",
  "StartOn": "2019-07-21T06:14:04.9143072Z",
  "EndOn": "2019-07-21T06:14:04.9153087Z",
  "VolunteerExperienceLevel": {
    "ExperienceLevel": "sample string 1",
    "SkillsMultiplier": 2.0,
    "HourlyRate": 1.0
  },
  "VolunteerOpportunityTravel": {
    "Description": "sample string 1",
    "Distance": 2
  }
}

application/xml, text/xml

Sample:
<Volunteer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Volunteer">
  <Bio>sample string 4</Bio>
  <ContactKey>9ddecb96-1bf3-4c90-a90a-71468d6a48f4</ContactKey>
  <EndOn>2019-07-21T02:14:04.9153087-04:00</EndOn>
  <StartOn>2019-07-21T02:14:04.9143072-04:00</StartOn>
  <VolunteerExperienceLevel>
    <ExperienceLevel>sample string 1</ExperienceLevel>
    <HourlyRate>1</HourlyRate>
    <SkillsMultiplier>2</SkillsMultiplier>
  </VolunteerExperienceLevel>
  <VolunteerKey>9119c778-1a9d-4b57-9cc3-c6c83f713179</VolunteerKey>
  <VolunteerOpportunityTravel>
    <Description>sample string 1</Description>
    <Distance>2</Distance>
  </VolunteerOpportunityTravel>
  <VolunteerOpportunityTravelKey>8ce48336-e239-46da-9306-da2166448fe4</VolunteerOpportunityTravelKey>
</Volunteer>