GET /api/v2/pay/donor_information_report SESSION
Get information for all pay donors

Learn how to use Suran API on the Suran Help Center.

Headers

Header name Description
Cookie
required 		Login session cookie
Provision
required 		Web/Mobile/API Provision UUID

Returns

Code: 200

Description:

Donor Information Report

Param name Description
data
required

donor information report

Validations:

  • Must be a Hash
data[id]
required

ID of the donor information report

Validations:

  • Must be a number.
data[type]
required

Type of record

Validations:

  • Must be a String
data[attributes]
required

Attributes of the donor information report

Validations:

  • Must be a Hash
data[attributes][DonorGUID]
required

GUID of the donor

Validations:

  • Must be a String
data[attributes][DonorID]
required

ID of the donor

Validations:

  • Must be a number.
data[attributes][DonorCode]
required

Donor Code

Validations:

  • Must be a String
data[attributes][Prefix]
required

title of individual

Validations:

  • Must be a String
data[attributes][FirstName]
required

donor first name

Validations:

  • Must be a String
data[attributes][Middlename]
required

donor middle name

Validations:

  • Must be a String
data[attributes][LastName]
required

donor last name

Validations:

  • Must be a String
data[attributes][Suffix]
required

suffix

Validations:

  • Must be a String
data[attributes][Address1]
required

address 1

Validations:

  • Must be a String
data[attributes][Address2]
required

address 2

Validations:

  • Must be a String
data[attributes][Address1]
required

address 3

Validations:

  • Must be a String
data[attributes][City]
required

city

Validations:

  • Must be a String
data[attributes][StateCode]
required

state code

Validations:

  • Must be a String
data[attributes][StateProvince]
required

state province

Validations:

  • Must be a String
data[attributes][PostalCode]
required

postal code

Validations:

  • Must be a String
data[attributes][CountryCode]
required

country code

Validations:

  • Must be a String
data[attributes][CountryName]
required

country name

Validations:

  • Must be a String
data[attributes][contact_information]
required

contact information

Validations:

  • Must be a Hash
data[attributes][contact_information][contactnum]
required

contact number

Validations:

  • Must be a String
data[attributes][contact_information][extension]
required

contact extension

Validations:

  • Must be a String
data[attributes][contact_information][typecode_desc]
required

contact type code description

Validations:

  • Must be a String

Code: 401

Description:

Unauthorized

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 404

Description:

Not Found

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 422

Description:

Unprocessable Entity

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 500

Description:

Internal Server Error

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Errors

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