| Donor information report |
| GET /api/v2/pay/donor_information_report |
| Header name | Description |
|---|---|
|
Cookie required |
Login session cookie |
|
Provision required |
Web/Mobile/API Provision UUID |
Donor Information Report
| Param name | Description |
|---|---|
|
data required |
donor information report Validations:
|
|
data[id] required |
ID of the donor information report Validations:
|
|
data[type] required |
Type of record Validations:
|
|
data[attributes] required |
Attributes of the donor information report Validations:
|
|
data[attributes][DonorGUID] required |
GUID of the donor Validations:
|
|
data[attributes][DonorID] required |
ID of the donor Validations:
|
|
data[attributes][DonorCode] required |
Donor Code Validations:
|
|
data[attributes][Prefix] required |
title of individual Validations:
|
|
data[attributes][FirstName] required |
donor first name Validations:
|
|
data[attributes][Middlename] required |
donor middle name Validations:
|
|
data[attributes][LastName] required |
donor last name Validations:
|
|
data[attributes][Suffix] required |
suffix Validations:
|
|
data[attributes][Address1] required |
address 1 Validations:
|
|
data[attributes][Address2] required |
address 2 Validations:
|
|
data[attributes][Address1] required |
address 3 Validations:
|
|
data[attributes][City] required |
city Validations:
|
|
data[attributes][StateCode] required |
state code Validations:
|
|
data[attributes][StateProvince] required |
state province Validations:
|
|
data[attributes][PostalCode] required |
postal code Validations:
|
|
data[attributes][CountryCode] required |
country code Validations:
|
|
data[attributes][CountryName] required |
country name Validations:
|
|
data[attributes][contact_information] required |
contact information Validations:
|
|
data[attributes][contact_information][contactnum] required |
contact number Validations:
|
|
data[attributes][contact_information][extension] required |
contact extension Validations:
|
|
data[attributes][contact_information][typecode_desc] required |
contact type code description Validations:
|
Unauthorized
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Not Found
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Unprocessable Entity
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Internal Server Error
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
| Code | Description |
|---|---|
| 404 | Data source query failed |
| 422 | Invalid parameter(s) |
| 422 | Provision header missing |
| 422 | Invalid provision |
| 422 | Under maintenance |
| 422 | Incorrect host for provision |
| 422 | Establishing session failed |
| 422 | Privilege to perform the action was not found |
| 422 | Not logged in |
| 422 | Provision does not match logged in provision |
| 500 | No connection to data source |