POST api/v1/widget/{publicId}/preferences

Request Information

URI Parameters

NameDescriptionTypeAdditional information
publicId

string

None.

Body Parameters

PostEmailPreferenceModel
NameDescriptionTypeAdditional information
Filters

EmailPreferenceModelCriteria

None.

SearchResultsUrlRelativeReference

string

None.

Email

string

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "filters": {
    "availableMorning": true,
    "availableAfternoon": true,
    "availableEvening": true,
    "availableWeekday": true,
    "availableWeekend": true,
    "pageIndex": 6,
    "pageSize": 7,
    "keywords": "sample string 8",
    "categories": "sample string 9",
    "typesofwork": "sample string 10",
    "commitments": "sample string 11",
    "interestAreas": "sample string 12",
    "postcode": 13,
    "suburb": "sample string 14",
    "cities": "sample string 15",
    "states": "sample string 16",
    "location": "sample string 17",
    "radius": 18,
    "suitabilities": "sample string 19",
    "dayandtimes": "sample string 20",
    "tags": "sample string 21",
    "organisationId": 22,
    "opportunityId": 23,
    "opportunityIds": [
      1,
      2
    ],
    "doBlacklist": true,
    "includeInternalCorporate": true,
    "excludePublic": true,
    "excludeExtendedEOI": true,
    "includeEOIRedirectUrl": true,
    "includeTags": true,
    "returnMarkDown": true,
    "volunteerId": 31,
    "includeNotCurrentlyAdvertised": true,
    "onlyPrivate": true
  },
  "searchResultsUrlRelativeReference": "sample string 1",
  "email": "sample string 2"
}

application/xml, text/xml

Sample:
<PostEmailPreferenceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VOL.API.Models">
  <Email>sample string 2</Email>
  <Filters>
    <ExcludePublic>true</ExcludePublic>
    <IncludeInternalCorporate>true</IncludeInternalCorporate>
    <ReturnMarkDown>true</ReturnMarkDown>
    <VolunteerId>31</VolunteerId>
    <categories>sample string 9</categories>
    <cities>sample string 15</cities>
    <commitments>sample string 11</commitments>
    <dayandtimes>sample string 20</dayandtimes>
    <doBlacklist>true</doBlacklist>
    <excludeExtendedEOI>true</excludeExtendedEOI>
    <includeEOIRedirectUrl>true</includeEOIRedirectUrl>
    <includeNotCurrentlyAdvertised>true</includeNotCurrentlyAdvertised>
    <includeTags>true</includeTags>
    <interestAreas>sample string 12</interestAreas>
    <keywords>sample string 8</keywords>
    <location>sample string 17</location>
    <onlyPrivate>true</onlyPrivate>
    <opportunityId>23</opportunityId>
    <opportunityIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </opportunityIds>
    <organisationId>22</organisationId>
    <pageIndex>6</pageIndex>
    <pageSize>7</pageSize>
    <postcode>13</postcode>
    <radius>18</radius>
    <states>sample string 16</states>
    <suburb>sample string 14</suburb>
    <suitabilities>sample string 19</suitabilities>
    <tags>sample string 21</tags>
    <typesofwork>sample string 10</typesofwork>
    <AvailableAfternoon>true</AvailableAfternoon>
    <AvailableEvening>true</AvailableEvening>
    <AvailableMorning>true</AvailableMorning>
    <AvailableWeekday>true</AvailableWeekday>
    <AvailableWeekend>true</AvailableWeekend>
  </Filters>
  <SearchResultsUrlRelativeReference>sample string 1</SearchResultsUrlRelativeReference>
</PostEmailPreferenceModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, text/html

Sample:

Sample not available.