CMS Web Services - v4.0.6550.31684 [cms-a]

<back to all web services

ArsfiDonationSearch

Returns zero or more ARSFi donation records.

The following routes are available for this service:
POST/arsfi/donation/search
ArsfiDonationSearch Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringNoCallsign of person making donation
NamebodystringNoName of person making donation
EmailAddressbodystringNoEmail address
TransactionTypebodystringNoType of transaction (Winmor, V4, Donation, etc.)
RegistrationKeybodystringNoRegistration key
VoidedbodyboolNoTrue to search for voided records (default: false)
RecordLimitbodyintNoLimit number of records returned (default: 100)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ArsfiDonationSearchResponse Parameters:
NameParameterData TypeRequiredDescription
DonationsformList<DonationRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DonationRecord Parameters:
NameParameterData TypeRequiredDescription
TransactionIdformstringNo
TimestampformDateTimeNo
CallsignformstringNo
NameformstringNo
EmailAddressformstringNo
AmountformdoubleNo
TransactionTypeformstringNo
RegistrationKeyformstringNo
VoidformboolNo
NotesformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /arsfi/donation/search HTTP/1.1 
Host: halifax.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Callsign":"String","Name":"String","EmailAddress":"String","TransactionType":"String","RegistrationKey":"String","Voided":false,"RecordLimit":0,"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Donations":[{"TransactionId":"String","Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","Name":"String","EmailAddress":"String","Amount":0,"TransactionType":"String","RegistrationKey":"String","Void":false,"Notes":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}