Headers

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

Params

Param name Description
donor_guid
required

guid of the donor

Validations:

  • Must be a String

Returns

Code: 200

Description:

check gift reports with matching donorguid

Param name Description
data
required

donor information one

Validations:

  • Must be a Hash

data[id]
required

ID of the donor information one

Validations:

  • Must be a number.

data[type]
required

Type of record

Validations:

  • Must be a String

data[attributes]
required

Attributes of the donor information one

Validations:

  • Must be a Hash

data[attributes][DonorGUID]
required

ID of the transaction

Validations:

  • Must be a String

data[attributes][DonorID]
required

account holder id

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

individual first name

Validations:

  • Must be a String

data[attributes][Middlename]
required

individual middle name

Validations:

  • Must be a String

data[attributes][LastName]
required

individual last name

Validations:

  • Must be a String

data[attributes][Suffix]
required

address 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

address city

Validations:

  • Must be a String

data[attributes][StateCode]
required

address state code

Validations:

  • Must be a String

data[attributes][StateProvince]
required

state code

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 code

Validations:

  • Must be a String

data[attributes][contact_information]
required

Attributes of the donor information one

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 number extension

Validations:

  • Must be a String

data[attributes][contact_information][typecode_desc]
required

contact type

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