VOL API v1 Documentation

Introduction

Provide a general description of your APIs here.

AccountApi

API	Description
POST api/AccountApi	No documentation available.
POST api/v1/accounts/registerstaffwithagency	No documentation available.
POST api/v1/accounts/registervolunteerwithagency	No documentation available.

Agencies

API	Description
POST api/Agencies	No documentation available.
POST api/v1/agencies	No documentation available.
GET api/v1/agencies/{agencyId}/blacklisted	No documentation available.
PUT api/v1/agencies/{agencyId}/blacklisted	No documentation available.
GET api/v1/agencies/{agencyId}/canblacklist	No documentation available.
GET api/v1/agencies/{agencyId}/constraints	No documentation available.
PUT api/v1/agencies/{agencyId}/constraints	No documentation available.
GET api/v1/agencies/{agencyId}/tags	No documentation available.
GET api/v1/agencies/tags	No documentation available.

Agency

API	Description
POST api/Agency	No documentation available.
GET api/v1/bvrc/agencies	No documentation available.
GET api/v1/bvrc/agency/{agencyId}/contacts?activeOnly={activeOnly}	No documentation available.
GET api/v1/bvrc/agency/{agencyId}/volunteers?skillId={skillId}&startDate={startDate}&endDate={endDate}&keyword={keyword}&page={page}&pageSize={pageSize}	No documentation available.
GET api/v1/bvrc/user-agencies	No documentation available.

Contacts

API	Description
POST api/Contacts	No documentation available.
GET api/v1/contacts/{personId}?agencyId={agencyId}	Get contact details for the agency
PUT api/v1/contacts/{personId}?agencyId={agencyId}	Edit contact details for the agency
GET api/v1/contacts/basics	Get the basic details (Firstname/Lastname/Email) for the current user
PUT api/v1/contacts/basics	No documentation available.
GET api/v1/contacts/groups?pageIndex={pageIndex}&pageSize={pageSize}&Keyword={Keyword}&PersonId={PersonId}&FirstName={FirstName}&LastName={LastName}&EmailAddress={EmailAddress}&Status={Status}&StateId={StateId}&AgencyPersonAttributeId={AgencyPersonAttributeId}&AgencyId={AgencyId}&VrcSearch={VrcSearch}&GroupId={GroupId}&Unsubscribed={Unsubscribed}	Get contact list for the current user.
GET api/v1/contacts?pageIndex={pageIndex}&pageSize={pageSize}&Keyword={Keyword}&PersonId={PersonId}&FirstName={FirstName}&LastName={LastName}&EmailAddress={EmailAddress}&Status={Status}&StateId={StateId}&AgencyPersonAttributeId={AgencyPersonAttributeId}&AgencyId={AgencyId}&VrcSearch={VrcSearch}&GroupId={GroupId}&Unsubscribed={Unsubscribed}	Get contact list for the current user

Email

API	Description
POST api/Email	No documentation available.
PUT api/v1/bvrc/email/acceptedRole	No documentation available.
PUT api/v1/bvrc/email/declinedRole	No documentation available.
PUT api/v1/bvrc/email/offer	No documentation available.
PUT api/v1/bvrc/email/register	No documentation available.
PUT api/v1/bvrc/email/setup	No documentation available.
PUT api/v1/bvrc/email/welcome	No documentation available.

Emails

API	Description
POST api/Emails	No documentation available.
POST api/v1/emails	No documentation available.
GET api/v1/emails/encrypt?email={email}	No documentation available.
POST api/v1/emails/unsubscribe	No documentation available.

Eoi

API	Description
POST api/Eoi	No documentation available.
POST api/v1/eois	No documentation available.
GET api/v1/eois/{id}	No documentation available.
POST api/v1/eois/{positionId}/answers?volunteerId={volunteerId}&checkBetweenAgeLimit={checkBetweenAgeLimit}	No documentation available.
PUT api/v1/eois/bookings	No documentation available.
POST api/v1/eois/bookings	No documentation available.
GET api/v1/eois/bookings/{id}	No documentation available.
DELETE api/v1/eois/bookings/{id}	No documentation available.
GET api/v1/eois/bookings?PageIndex={PageIndex}&PageSize={PageSize}&ClientName={ClientName}&ConsultationTypes={ConsultationTypes}&FromDate={FromDate}	No documentation available.
GET api/v1/eois/opportunity	No documentation available.
GET api/v1/eois/questions	No documentation available.
GET api/v1/eois?PageIndex={PageIndex}&PageSize={PageSize}&Keywords={Keywords}&ClientName={ClientName}&Status={Status}&SortBy={SortBy}	No documentation available.

GraphQL

API	Description
OPTIONS api/GraphQL	No documentation available.
POST api/GraphQL	No documentation available.
POST graphql	No documentation available.
GET graphql	No documentation available.

Locations

API	Description
POST api/Locations	No documentation available.
GET api/v1/locations/{keyword}/suggestions?maxNumber={maxNumber}	Auto-suggest list for locations
GET api/v1/locations/{postcode}/postcodes	No documentation available.
GET api/v1/locations/{postcode}/suburbs	No documentation available.
GET api/v1/locations/{suburbId}/state	No documentation available.
GET api/v1/locations?keyword={keyword}&isGeolocated={isGeolocated}&includeStateWide={includeStateWide}&minChar={minChar}&maxNumber={maxNumber}	No documentation available.

Lookup

API	Description
POST api/Lookup	No documentation available.
GET api/v1/lookup/{id}/states	No documentation available.
GET api/v1/lookup/aboriginalortorresstraitislanderorigin	No documentation available.
GET api/v1/lookup/categories	No documentation available.
GET api/v1/lookup/causes	No documentation available.
GET api/v1/lookup/classifications	No documentation available.
GET api/v1/lookup/clearCache	No documentation available.
GET api/v1/lookup/commitment	No documentation available.
GET api/v1/lookup/country	No documentation available.
GET api/v1/lookup/dayandtimes	No documentation available.
GET api/v1/lookup/durations	No documentation available.
GET api/v1/lookup/experiences	No documentation available.
GET api/v1/lookup/homelessindicator	No documentation available.
GET api/v1/lookup/interests	No documentation available.
GET api/v1/lookup/languages	No documentation available.
GET api/v1/lookup/notificationFrequencies	No documentation available.
GET api/v1/lookup/phonetypes	No documentation available.
GET api/v1/lookup/programs	No documentation available.
GET api/v1/lookup/programs/explanation	No documentation available.
GET api/v1/lookup/requirements	No documentation available.
GET api/v1/lookup/specialneed	No documentation available.
GET api/v1/lookup/states	No documentation available.
GET api/v1/lookup/subClassifications	No documentation available.
GET api/v1/lookup/suitablesfor	No documentation available.
GET api/v1/lookup/suitablesfor/definition	No documentation available.
GET api/v1/lookup/titles	No documentation available.
GET api/v1/lookup/transports	No documentation available.
GET api/v1/lookup/tShirtSizes	No documentation available.
GET api/v1/lookup/typesOfCar	No documentation available.
GET api/v1/lookup/typesofwork	No documentation available.
GET api/v1/lookup/worktype	No documentation available.

OAuthClient

API	Description
POST api/OAuthClient	No documentation available.
GET api/v1/oauth-clients/{identifier}	No documentation available.
GET api/v1/oauth-clients/clear-cache	No documentation available.

Opportunity

API	Description
POST api/Opportunity	No documentation available.
GET api/v1/bvrc/agency/{agencyId}/opportunities?q={q}&status={status}&sortBy={sortBy}&page={page}&pageSize={pageSize}	No documentation available.
POST api/v1/bvrc/agency/{agencyId}/opportunity	No documentation available.
GET api/v1/bvrc/agency/{agencyId}/opportunity/{opportunityId}	No documentation available.
PUT api/v1/bvrc/agency/{agencyId}/opportunity/{opportunityId}	No documentation available.
GET api/v1/bvrc/agency/{agencyId}/opportunity/{opportunityId}/candidates?q={q}&status={status}&sortBy={sortBy}&page={page}&pageSize={pageSize}	No documentation available.
PUT api/v1/bvrc/agency/{agencyId}/opportunity/{opportunityId}/close	No documentation available.
PUT api/v1/bvrc/agency/{agencyId}/opportunity/{opportunityId}/reopen	No documentation available.
GET api/v1/bvrc/agency/{agencyId}/opportunity/{opportunityId}/timeline	No documentation available.
GET api/v1/bvrc/agency/{agencyId}/opportunity/attention/count	No documentation available.

Positions

API	Description
POST api/Positions	No documentation available.
GET api/v1/positions/{positionId}/tags	No documentation available.
GET api/v1/positions/{positionId}/tags/{agencyId}	No documentation available.

Referral

API	Description
POST api/Referral	No documentation available.
GET api/v1/bvrc/agency/{agencyId}/referral/{referralId}	No documentation available.
PUT api/v1/bvrc/agency/{agencyId}/referral/{referralId}/outcome	No documentation available.
GET api/v1/bvrc/agency/public-referral?email={email}&positionId={positionId}	No documentation available.
GET api/v1/bvrc/agency/referral/{publicId}	No documentation available.

Search

API	Description
POST api/Search	No documentation available.
GET api/v1/searches	No documentation available.
GET api/v1/searches/{keyword}/locations?maxNumber={maxNumber}	No documentation available.
GET api/v1/searches/{keyword}/organisations?maxNumber={maxNumber}	No documentation available.
GET api/v1/searches/featured?NumberOfResult={NumberOfResult}&location={location}&suitablefor={suitablefor}&Random={Random}	No documentation available.
GET api/v1/searches/opportunity	No documentation available.
GET api/v1/searches/opportunity/{opportunityId}	No documentation available.
GET api/v1/searches/opportunity/filters	No documentation available.

Seek

API	Description
POST api/Seek	No documentation available.
GET api/v1/seek/applications/{email}?pageIndex={pageIndex}&pageSize={pageSize}	Get opportunity details for EOIs with 'email'
PUT api/v1/seek/applications/{referralId}	Update application's volunteer status
POST api/v1/seek/experiences	Add volunteer experience for user 'userId'
PUT api/v1/seek/experiences	Update volunteer experience for user 'userId'
GET api/v1/seek/experiences/{email}	Get volunteer experiences for user 'userId'
GET api/v1/seek/experiences/{expId}/details	Get volunteer experience 'expId'
GET api/v1/seek/experiences/{userId}	Get volunteer experiences for user 'userId'
DELETE api/v1/seek/experiences/{userId}/{expId}	Delete volunteer experience 'expId' for user 'userId'
PUT api/v1/seek/experiences/{userId}/{expId}/order/{decrease}	Update volunteer experience order by 1 (increase or decrease)
PUT api/v1/seek/experiences/{userId}/{expId}/order/{order}	Update volunteer experience order with 'order'
GET api/v1/seek/favourites	Get favourite Ids and dates from OppIds and OrgIds
GET api/v1/seek/favourites/{userId}	Get favourite Ids and dates for user 'userId'
POST api/v1/seek/favourites/{userId}/opportunity	Add opportunities to user's favourite
DELETE api/v1/seek/favourites/{userId}/opportunity	Remove opportunities to user's favourite
GET api/v1/seek/favourites/{userId}/opportunity?pageIndex={pageIndex}&pageSize={pageSize}	Get favourite opportunities for user 'userId'
POST api/v1/seek/favourites/{userId}/organisation	Add organisations to user's favourite
DELETE api/v1/seek/favourites/{userId}/organisation	Remove organisations to user's favourite
GET api/v1/seek/favourites/{userId}/organisation?pageIndex={pageIndex}&pageSize={pageSize}	Get favourite organisations for user 'userId'
GET api/v1/seek/favourites/details	Get favourite details from OppIds and OrgIds
GET api/v1/seek/locations?keyword={keyword}&isGeolocated={isGeolocated}&includeStateWide={includeStateWide}&minChar={minChar}&maxNumber={maxNumber}	No documentation available.
GET api/v1/seek/user/{email}/{source}	Get volunteer details based on last EOI with 'email'
GET api/v1/seek/volunteer/{email}/eoi	Get volunteer EOI details based on last EOI with 'email'
GET api/v1/seek/volunteer/{email}?source={source}	Get volunteer details based on last EOI with 'email'

Staff

API	Description
POST api/Staff	No documentation available.
POST api/v1/bvrc/staff	Create user account with the role 'BVRC Skills Bank'
POST api/v1/bvrc/staff/setup	No documentation available.
GET api/v1/bvrc/staff?keyword={keyword}&page={page}&pageSize={pageSize}	Search user account with the role 'BVRC Skills Bank'

Subscriptions

API	Description
POST api/Subscriptions	No documentation available.
POST api/v1/subscriptions	No documentation available.
PUT api/v1/subscriptions/unsubscribe/{id}	No documentation available.

SyncOnlineApplication

API	Description
POST api/SyncOnlineApplication	No documentation available.
POST api/v1/synconlineapplications	No documentation available.

SyncOpportunity

API	Description
POST api/SyncOpportunity	No documentation available.
POST api/v1/syncopportunities	No documentation available.

SyncOrganisation

API	Description
POST api/SyncOrganisation	No documentation available.
POST api/v1/syncorganisations	No documentation available.

SyncToDynamics

API	Description
POST api/SyncToDynamics	No documentation available.
POST api/v1/synctodynamics	No documentation available.

User

API	Description
POST api/User	No documentation available.
GET api/v1/users	Get the current user's data
GET api/v1/users/{id}/roles	No documentation available.
GET api/v1/users/{id}/roles/{roleName}	No documentation available.
GET api/v1/users/{identifier}/password	No documentation available.
GET api/v1/users/{userId}	No documentation available.
PUT api/v1/users/{userId}	No documentation available.
DELETE api/v1/users/{userId}	No documentation available.
GET api/v1/users/{userId}/AccessFailedCount	No documentation available.
PUT api/v1/users/{userId}/email	No documentation available.
GET api/v1/users/{userId}/logins	No documentation available.
POST api/v1/users/{userId}/logins	No documentation available.
DELETE api/v1/users/{userId}/logins?loginProvider={loginProvider}&providerKey={providerKey}	No documentation available.
GET api/v1/users/{userId}/password	No documentation available.
POST api/v1/users/{userId}/password	No documentation available.
PUT api/v1/users/{userId}/password	No documentation available.
PUT api/v1/users/{userId}/password/reset	No documentation available.
GET api/v1/users/{userId}/password/token	No documentation available.
PUT api/v1/users/{userId}/username	No documentation available.
GET api/v1/users/{username}	No documentation available.
GET api/v1/users/Account	No documentation available.
PUT api/v1/users/emailConfirmation	No documentation available.
GET api/v1/users/GetByEmail/{email}	No documentation available.
GET api/v1/users/GetByLogin/{provider}/{providerKey}	No documentation available.
POST api/v1/users/identity	No documentation available.
GET api/v1/users/logins	No documentation available.
POST api/v1/users/logins	No documentation available.
DELETE api/v1/users/logins?loginProvider={loginProvider}&providerKey={providerKey}	No documentation available.
GET api/v1/users/roles	No documentation available.
PUT api/v1/users/secondaryEmailConfirmation	No documentation available.
POST api/v1/users/token	No documentation available.
GET api/v1/users/token/{token}	No documentation available.

Vol

API	Description
POST api/v1/bvrc/volunteer	No documentation available.
GET api/v1/bvrc/volunteer/{volunteerId}/info	No documentation available.
POST api/v1/bvrc/volunteer/registered	No documentation available.
GET api/v1/bvrc/volunteer/registered?email={email}	No documentation available.
PUT api/v1/bvrc/volunteer/skillsbank	No documentation available.
POST api/v1/bvrc/volunteer/token	No documentation available.
GET api/v1/bvrc/volunteer/token?email={email}	No documentation available.
PUT api/v1/bvrc/volunteer/welcome	No documentation available.
GET api/v1/bvrc/volunteer?poolId={poolId}&skillId={skillId}&startDate={startDate}&endDate={endDate}&keyword={keyword}&page={page}&pageSize={pageSize}	No documentation available.
POST api/Vol	No documentation available.

Viktor

API	Description
GET api/v1/viktor/agencies	Get Viktor Agencies for the current user's
GET api/v1/viktor/details	Get Viktor Details for the current user's
POST api/Viktor	No documentation available.

Volunteer

API	Description
GET api/v1/volunteers	No documentation available.
PUT api/v1/volunteers	No documentation available.
POST api/v1/volunteers/addToAgencyPool	No documentation available.
GET api/v1/volunteers/profile?token={token}	No documentation available.
POST api/v1/volunteers/remaininagencypool	No documentation available.
DELETE api/v1/volunteers/removeFromAgencyPool/{volunteerId}/{poolId}	No documentation available.
GET api/v1/volunteers/Thumbnail	No documentation available.
PUT api/v1/volunteers/updateagencyprivateaccess	No documentation available.
POST api/Volunteer	No documentation available.

API	Description
GET api/v1/widget/{publicId}/categories	No documentation available.
POST api/v1/widget/{publicId}/eoi	No documentation available.
POST api/v1/widget/{publicId}/eoi-nolocation	No documentation available.
GET api/v1/widget/{publicId}/interestareas	No documentation available.
GET api/v1/widget/{publicId}/locations/{keyword}?showAll={showAll}	No documentation available.
GET api/v1/widget/{publicId}/opportunities	Get opportunities
GET api/v1/widget/{publicId}/opportunity/{id}	Get opportunity details
GET api/v1/widget/{publicId}/opportunity/{id}/eoidata	No documentation available.
POST api/v1/widget/{publicId}/opportunity/{id}/logeoiview	No documentation available.
GET api/v1/widget/{publicId}/opportunity/{id}/questions	opportunity eoi questions
POST api/v1/widget/{publicId}/preferences	No documentation available.
GET api/v1/widget/{publicId}/preferences/{token}	No documentation available.
GET api/v1/widget/{publicId}/suitabilities	No documentation available.
GET api/v1/widget/{publicId}/typesofwork	No documentation available.
PUT api/v1/widget/{publicId}/unsubscribe/{token}	No documentation available.
POST api/Widget	No documentation available.

Introduction

AccountApi

Agencies

Agency

Contacts

Email

Emails

Eoi

GraphQL

Locations

Lookup

OAuthClient

Opportunity

Positions

Referral

Search

Seek

Staff

Subscriptions

SyncOnlineApplication

SyncOpportunity

SyncOrganisation

SyncToDynamics

User

Vol

Viktor

Volunteer

Widget