Donor System Mobile Web Api
Using The API
-
All API's need to receive a custom http header called ApiKey.
To obtain an API team please contact the donor system developers.
- All calls except for account creation and session creation must pass a custom header called AccessToken.
This value is obtained from the session creation API's.
Session
API | Description |
PUT api/Session/Social |
Login a user to establish a session from a social login
|
PUT api/Session |
Login a user to establish a session
|
Login
The API responsible for maintaining login data.
API | Description |
POST api/Login |
Change a donor's login email address
|
Account
Api's for Donor Accounts
API | Description |
GET api/Account |
Get an account by its ID
|
POST api/Account/{id} |
Update an existing account
|
PUT api/Account/{id} |
Register a new account
|
FamilyMember
The web api that allows getting, changing, and deleting family members
API | Description |
GET api/FamilyMember |
Get a list of family members for the logged in account
|
POST api/FamilyMember |
Updates or Adds a family member to an account
|
DELETE api/FamilyMember/{id} |
Delete a specified family member
|
Pledge
Api for creating, changing, and cancelling pledges.
API | Description |
POST api/Pledge |
Change some detail of a pledge
|
PUT api/Pledge |
Create a new pledge
|
DELETE api/Pledge |
Cancel a pledge
|
Password
Api responsible for maintaining password
API | Description |
POST api/Password |
Change a password
|
OnPremSync
API | Description |
PUT api/OnPremSync/{id} |
No documentation available.
|
TaxStatement
Allows retrival of tax data
API | Description |
GET api/TaxStatement/{id} |
Get the tax data for a given year
|
PaymentInfo
Allows deletation of stored payment types
API | Description |
DELETE api/PaymentInfo/{id} |
Deletes a stored payment type / card
|
BusinessPartner
Api's related to a donor accounts business partner data
API | Description |
POST api/BusinessPartner |
Upserts a business partner for an account
|
Lookup
Fetch lookup values
API | Description |
GET api/Lookup/{id} |
Get all the values for a given company
|
Phone
Allows changing of phone numbers
API | Description |
POST api/Phone |
Updates or Adds a phone number on an account
|
AccountB2C
Api's for Donor Accounts
API | Description |
POST api/AccountB2C |
Get an account by Username and Password
|
GET api/AccountB2C?UserName={UserName}&Password={Password} |
Check to see if a login is a valid email in the database
|