API Reference

Account

API	Description
POST api/Account/ChangePassword	No documentation available.
POST api/Account/Logout	No documentation available.
GET api/Account/ManageInfo?returnUrl={returnUrl}&generateState={generateState}	No documentation available.
POST api/Account/Register	No documentation available.
POST api/Account/RemoveLogin	No documentation available.
POST api/Account/SetPassword	No documentation available.
GET api/Account/UserInfo	No documentation available.

Batch

API	Description
POST api/v1/batch	Add a new batch
GET api/v1/batch/{batchCombo}	Find batch by ID
PUT api/v1/batch/{batchCombo}	Updates a batch in Provision

Code

API	Description
POST api/v1/code/donationcode	Add a new donation code
GET api/v1/code/donationcode/{code}	Find Donation Code by code
PUT api/v1/code/donationcode/{code}	Update Donation code
GET api/v1/code/donationcode?limit={limit}&offset={offset}&inHomeAfter={inHomeAfter}&inHomeBefore={inHomeBefore}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find Donation Code by filter
POST api/v1/code/donorappealcode	Add a new DonorAppeal code
GET api/v1/code/donorappealcode/{code}	Find Donor Appeal Code by code
PUT api/v1/code/donorappealcode/{code}	Update Donor Appeal Code
GET api/v1/code/donorappealcode?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find Donor Appeal Code by filter
POST api/v1/code/donorservicecode	Add a new donor service code
GET api/v1/code/donorservicecode/{code}	Find Donor Service Code by code
PUT api/v1/code/donorservicecode/{code}	Update Donor Service Code
GET api/v1/code/donorservicecode?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find Customer Service Code by filter
POST api/v1/code/donorstatuscode	Add a new DonorStatus code
GET api/v1/code/donorstatuscode/{code}	Find Donor Status Code by code
PUT api/v1/code/donorstatuscode/{code}	Update Donor Status Code
GET api/v1/code/donorstatuscode?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find DonorStatus code by filter
POST api/v1/code/donorstopcode	Add a new DonorStop code
GET api/v1/code/donorstopcode/{code}	Find Donor Stop Code by code
PUT api/v1/code/donorstopcode/{code}	Update Donor Stop Code
GET api/v1/code/donorstopcode?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find DonorStop code by filter
POST api/v1/code/eventcode	Add a new Event code
GET api/v1/code/eventcode/{code}	Find Event Code by code
PUT api/v1/code/eventcode/{code}	Update Event code
GET api/v1/code/eventcode?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find Event Code by filter
POST api/v1/code/fundcode	Add a new Fund code
GET api/v1/code/fundcode/{code}	Find Fund Code by code
PUT api/v1/code/fundcode/{code}	Update Fund Code
GET api/v1/code/fundcode?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find Fund Code by filter
POST api/v1/code/lettercode	Add a new Letter code
GET api/v1/code/lettercode/{code}	Find Letter Code by code
PUT api/v1/code/lettercode/{code}	Update Letter Code
GET api/v1/code/lettercode?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find Letter Code by filter
GET api/v1/code/locationcode/{code}	Find Location Code by code
GET api/v1/code/locationcode?limit={limit}&offset={offset}	Find Location Code by filter
POST api/v1/code/sourcecode	Add a new source code
GET api/v1/code/sourcecode/{code}	Find Source Code by code
PUT api/v1/code/sourcecode/{code}	Update Source code
GET api/v1/code/sourcecode?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find sourcecode by filter

Contact

API	Description
POST api/v1/Contact/EVJob	Adds an Email Validation Job
GET api/v1/Contact/EVJob?jobId={jobId}&limit={limit}&offset={offset}	Checks status of email validation jobs for given client or by specific ID
GET api/v1/Contact/EVJobDetail?jobId={jobId}&limit={limit}&offset={offset}	Gets details on specific emails in an email validation job

Donation

API	Description
POST api/v1/Donation	No documentation available.

Donor

API	Description
POST api/v1/donor	Add a new Donor
GET api/v1/donor/{donorID}	Find Donor by ID
PUT api/v1/donor/{donorID}	Update Donor
GET api/v1/donor?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&addedBefore={addedBefore}&addedAfter={addedAfter}&externalReference={externalReference}&externalOrigin={externalOrigin}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find Donor by filter
POST api/v1/donorassignment	Add a new donor assignment
PUT api/v1/donorassignment?donorID={donorID}&userName={userName}&assignDate={assignDate}	Update donor assignment
GET api/v1/donorassignment?limit={limit}&offset={offset}&before={before}&after={after}&donorID={donorID}&userName={userName}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Find donor assignment by filter
POST api/v1/donormerge	Add a new Donor Merge
GET api/v1/donormerge?limit={limit}&offset={offset}&Before={Before}&After={After}	Find Donor Merges by filter

DonorAccess

API	Description
POST api/v1/donoraccess/donor?token={token}	Update Donor
GET api/v1/donoraccess/donor?token={token}&limit={limit}&offset={offset}	Retrieve Donor Profile
POST api/v1/donoraccess/recurrence?token={token}	Update Recurrence
GET api/v1/donoraccess/recurrence?token={token}&limit={limit}&offset={offset}&transaction={transaction}	Find Recurrence list
POST api/v1/donoraccess/token	Create a Donor Access Token
GET api/v1/donoraccess/token?token={token}	Retrieve a Donor Access Token
GET api/v1/donoraccess/transaction?token={token}&transactionType={transactionType}&transDateAfter={transDateAfter}&transDateBefore={transDateBefore}&transactionTotalBelow={transactionTotalBelow}&transactionTotalAbove={transactionTotalAbove}&transactionCombo={transactionCombo}&sortOrder={sortOrder}&limit={limit}&offset={offset}	Find Transaction by filter

DonorService

API	Description
POST api/v1/donorservice	Add a new Donor Service item
GET api/v1/donorservice?createdAfter={createdAfter}&createdBefore={createdBefore}&modifiedAfter={modifiedAfter}&modifiedBefore={modifiedBefore}&completedAfter={completedAfter}&completedBefore={completedBefore}&donorID={donorID}&transactionCombo={transactionCombo}&creator={creator}&completedStatus={completedStatus}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&limit={limit}&offset={offset}	Find Donor Service item by filter
PUT api/v1/donorservice?DonorID={DonorID}&Created={Created}	Updates a Donor Service item

Inventory

API	Description
POST api/v1/inventory/item	Add a new inventory item
GET api/v1/inventory/item/{code}	Gets a specific item code
PUT api/v1/inventory/item/{code}	Update an inventory item
GET api/v1/inventory/item?updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}&limit={limit}&offset={offset}	Finds a list of items codes
POST api/v1/inventory/package	Add a new inventory package
GET api/v1/inventory/package/{code}	Gets a specific package code
PUT api/v1/inventory/package/{code}	Update an inventory package
GET api/v1/inventory/package?updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}&limit={limit}&offset={offset}	Finds a list of package codes
POST api/v1/inventory/virtual	Add a new virtual inventory
GET api/v1/inventory/virtual/{code}	Gets a specific virtual item code
PUT api/v1/inventory/virtual/{code}	Update a virtual inventory item
GET api/v1/inventory/virtual?updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&limit={limit}&offset={offset}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}	Finds a list of virtual item codes

MediaSchedule

API	Description
GET api/v1/mediaschedule?limit={limit}&offset={offset}&airingAfter={airingAfter}&airingBefore={airingBefore}	Retrieve Media Airing Schedule

Membership

API	Description
GET api/v1/Membership?limit={limit}&offset={offset}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}&donorID={donorID}	Find Memberships by donor

PrayerWall

API	Description
GET api/v1/PrayerWall/Countries?ipAddress={ipAddress}&limit={limit}&offset={offset}	Return list of prayer countries
POST api/v1/PrayerWall/Prayed?deviceID={deviceID}&prayerID={prayerID}&ipAddress={ipAddress}&countryCode={countryCode}	Add a new prayed indicator. Resubmittal remove the prayed indicator.
GET api/v1/PrayerWall/Prayer/{prayerID}?deviceID={deviceID}&ipAddress={ipAddress}	Returns a single prayer
POST api/v1/PrayerWall/Prayer?deviceID={deviceID}&ipAddress={ipAddress}	Add a new prayer
GET api/v1/PrayerWall/Prayer?deviceID={deviceID}&ipAddress={ipAddress}&limit={limit}&offset={offset}	Return list of prayers
PUT api/v1/PrayerWall/PrayerContent?ipAddress={ipAddress}	Update Prayer Wall Content (Prayers and responses)
GET api/v1/PrayerWall/PrayerContent?status={status}&contentType={contentType}&contentID={contentID}&addedAfter={addedAfter}&addedBefore={addedBefore}&searchString={searchString}&ipAddress={ipAddress}&limit={limit}&offset={offset}	Return Prayer Wall Content (Prayers and responses)
POST api/v1/PrayerWall/PrayerFilter	Add Prayer Filter
PUT api/v1/PrayerWall/PrayerFilter	Update Prayer Filter
GET api/v1/PrayerWall/PrayerFilter?filterID={filterID}&deviceID={deviceID}&email={email}&filterStatus={filterStatus}&searchTerm={searchTerm}&ipAddress={ipAddress}&limit={limit}&offset={offset}	Return Prayer Filter List
POST api/v1/PrayerWall/PrayerWallSetting?ipAddress={ipAddress}	Add/Update Prayer Wall Setting
GET api/v1/PrayerWall/PrayerWallSetting?ipAddress={ipAddress}	Return Prayer Wall Setting
POST api/v1/PrayerWall/Response?deviceID={deviceID}&prayerID={prayerID}&ipAddress={ipAddress}	Add a new prayer response
GET api/v1/PrayerWall/Response?deviceID={deviceID}&prayerID={prayerID}&ipAddress={ipAddress}&limit={limit}&offset={offset}	Return list of prayer responses

Transaction

API	Description
GET api/v1/donor/{donorID}/transaction?limit={limit}&offset={offset}	Find Transactions by Donor ID
POST api/v1/recurrence	Add Recurrence
GET api/v1/recurrence/{transactionID}	Find Recurrence
PUT api/v1/recurrence/{transactionID}	Update Recurrence
GET api/v1/recurrence?status={status}&donorID={donorID}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}&reference={reference}&limit={limit}&offset={offset}	Find Recurrence by filter
POST api/v1/shipment	Add a new Shipment
GET api/v1/shipment?shippedAfter={shippedAfter}&shippedBefore={shippedBefore}&transactionCombo={transactionCombo}&donorID={donorID}&limit={limit}&offset={offset}	Find Shipment by filter
POST api/v1/transaction	Add a new Transaction
GET api/v1/transaction/{transactionCombo}	Find Transaction by ID
PUT api/v1/transaction/{transactionCombo}	Updates a Transaction
PUT api/v1/transaction/lineitem/{transactionLineItemCombo}	Updates a Transaction Line Item ship status
GET api/v1/transaction/lineitem?transDateAfter={transDateAfter}&transDateBefore={transDateBefore}&location={location}&shipStatus={shipStatus}&prodCode={prodCode}&summaryOnly={summaryOnly}&limit={limit}&offset={offset}	Find Transaction Line Item by filter
GET api/v1/transaction?postedAfter={postedAfter}&postedBefore={postedBefore}&shippedAfter={shippedAfter}&shippedBefore={shippedBefore}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&createdAfter={createdAfter}&createdBefore={createdBefore}&createdBy={createdBy}&excludeCreatedBy={excludeCreatedBy}&status={status}&donorID={donorID}&externalReference={externalReference}&externalOrigin={externalOrigin}&limit={limit}&offset={offset}	Find Transaction by filter

Trip

API	Description
GET api/v1/donor/{donorID}/trip?limit={limit}&offset={offset}	Find Trip by Donor ID
POST api/v1/trip	Add a new Trip
DELETE api/v1/trip/{tripID}	Deletes a Trip
GET api/v1/trip/{tripID}	Find Trip by ID
GET api/v1/trip?limit={limit}&offset={offset}&donorID={donorID}&addedBefore={addedBefore}&addedAfter={addedAfter}&updatedAfter={updatedAfter}&updatedBefore={updatedBefore}&updatedBy={updatedBy}&excludeUpdatedBy={excludeUpdatedBy}&firstTripID={firstTripID}&lastTripID={lastTripID}&externalReference={externalReference}	Find Trip by filter

WebApp

API	Description
GET api/v1/WebApp/Content?type={type}&search={search}&contentID={contentID}&limit={limit}&offset={offset}&devUser={devUser}	Returns Content lists
GET api/v1/WebApp/ContentType?limit={limit}&offset={offset}	Returns App Content Types
GET api/v1/WebApp/FanCount?limit={limit}&offset={offset}	Return live counter
GET api/v1/WebApp/Home?limit={limit}&offset={offset}&appVersion={appVersion}&devUser={devUser}	Returns App home content
GET api/v1/WebApp/NotificationHistory?deviceID={deviceID}&notificationToken={notificationToken}&limit={limit}&offset={offset}&appVersion={appVersion}	Return list of Notifications for a particular device or token
POST api/v1/WebApp/RedirectURL?limit={limit}&offset={offset}	Return Redirect URL for a Short Code
GET api/v1/WebApp/RedirectURL?shortCode={shortCode}&limit={limit}&offset={offset}	Return Redirect URL for a Short Code
POST api/v1/WebApp/Setting?deviceID={deviceID}&appVersion={appVersion}	Adds or updates WebApp settings
GET api/v1/WebApp/Setting?deviceID={deviceID}&appVersion={appVersion}&limit={limit}&offset={offset}	Returns App Settings
GET api/v1/WebApp/URL?type={type}&limit={limit}&offset={offset}	Returns URLs