POST api/v1/subscriptions

Request Information

URI Parameters

None.

Body Parameters

PostSubscription
NameDescriptionTypeAdditional information
Filters

OpportunitySearchFilters

None.

Url

string

None.

Email

string

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "filters": {
    "pageIndex": 1,
    "pageSize": 2,
    "keywords": "sample string 3",
    "categories": "sample string 4",
    "typesofwork": "sample string 5",
    "commitments": "sample string 6",
    "interestAreas": "sample string 7",
    "postcode": 8,
    "suburb": "sample string 9",
    "cities": "sample string 10",
    "states": "sample string 11",
    "location": "sample string 12",
    "radius": 13,
    "suitabilities": "sample string 14",
    "dayandtimes": "sample string 15",
    "tags": "sample string 16",
    "organisationId": 17,
    "opportunityId": 18,
    "opportunityIds": [
      1,
      2
    ],
    "doBlacklist": true,
    "includeInternalCorporate": true,
    "excludePublic": true,
    "excludeExtendedEOI": true,
    "includeEOIRedirectUrl": true,
    "includeTags": true,
    "returnMarkDown": true,
    "volunteerId": 26,
    "includeNotCurrentlyAdvertised": true,
    "onlyPrivate": true
  },
  "url": "sample string 1",
  "email": "sample string 2"
}

application/xml, text/xml

Sample:
<PostSubscription 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>26</VolunteerId>
    <categories>sample string 4</categories>
    <cities>sample string 10</cities>
    <commitments>sample string 6</commitments>
    <dayandtimes>sample string 15</dayandtimes>
    <doBlacklist>true</doBlacklist>
    <excludeExtendedEOI>true</excludeExtendedEOI>
    <includeEOIRedirectUrl>true</includeEOIRedirectUrl>
    <includeNotCurrentlyAdvertised>true</includeNotCurrentlyAdvertised>
    <includeTags>true</includeTags>
    <interestAreas>sample string 7</interestAreas>
    <keywords>sample string 3</keywords>
    <location>sample string 12</location>
    <onlyPrivate>true</onlyPrivate>
    <opportunityId>18</opportunityId>
    <opportunityIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </opportunityIds>
    <organisationId>17</organisationId>
    <pageIndex>1</pageIndex>
    <pageSize>2</pageSize>
    <postcode>8</postcode>
    <radius>13</radius>
    <states>sample string 11</states>
    <suburb>sample string 9</suburb>
    <suitabilities>sample string 14</suitabilities>
    <tags>sample string 16</tags>
    <typesofwork>sample string 5</typesofwork>
  </Filters>
  <Url>sample string 1</Url>
</PostSubscription>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.