GET api/v2.0/Volunteer/GetVolunteerOpportunityTypeList

Returns a list of Volunteer Opportunity Types.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of VolunteerOpportunityType
NameDescriptionTypeAdditional information
VolunteerOpportunityTypeKey

The Unique Identifier for the Volunteer Opportunity Type.

globally unique identifier

None.

VolunteerOpportunityTypeName

The Title of the Volunteer Opportunity Type.

string

None.

IsActive

Indicates whether or not the Volunteer Opportunity Type can be used.

boolean

None.

IsRsvp

Indicates whether or not you must RSVP to Volunteer Opportunities Under this Volunteer Opportunity Type.

boolean

None.

AcceptNominations

Indicates if you are able to accept nominations under this type.

boolean

None.

IsVirtual

Indicates if the Volunteer Opportunities under this type are held online.

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "VolunteerOpportunityTypeKey": "2902c5b6-e87f-4b76-9032-991802e07d56",
    "VolunteerOpportunityTypeName": "sample string 2",
    "IsActive": true,
    "IsRsvp": true,
    "AcceptNominations": true,
    "IsVirtual": true
  },
  {
    "VolunteerOpportunityTypeKey": "2902c5b6-e87f-4b76-9032-991802e07d56",
    "VolunteerOpportunityTypeName": "sample string 2",
    "IsActive": true,
    "IsRsvp": true,
    "AcceptNominations": true,
    "IsVirtual": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfVolunteerOpportunityType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Volunteer">
  <VolunteerOpportunityType>
    <AcceptNominations>true</AcceptNominations>
    <IsActive>true</IsActive>
    <IsRsvp>true</IsRsvp>
    <IsVirtual>true</IsVirtual>
    <VolunteerOpportunityTypeKey>2902c5b6-e87f-4b76-9032-991802e07d56</VolunteerOpportunityTypeKey>
    <VolunteerOpportunityTypeName>sample string 2</VolunteerOpportunityTypeName>
  </VolunteerOpportunityType>
  <VolunteerOpportunityType>
    <AcceptNominations>true</AcceptNominations>
    <IsActive>true</IsActive>
    <IsRsvp>true</IsRsvp>
    <IsVirtual>true</IsVirtual>
    <VolunteerOpportunityTypeKey>2902c5b6-e87f-4b76-9032-991802e07d56</VolunteerOpportunityTypeKey>
    <VolunteerOpportunityTypeName>sample string 2</VolunteerOpportunityTypeName>
  </VolunteerOpportunityType>
</ArrayOfVolunteerOpportunityType>