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

<back to all web services

ArsfiDonationList

Returns a list of ARSFi donation records (optionally, based on filter settings).

The following routes are available for this service:
POST,GET/arsfi/donation/list
ArsfiDonationList Parameters:
NameParameterData TypeRequiredDescription
CallsignFilterbodystringNoFull or partial callsign
NameFilterbodystringNoFull or partial name
AgeFilterbodystringNoNumber of days to look back
RecordLimitbodyintNoLimit number of records returned (default: 100)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ArsfiDonationListResponse 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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/ArsfiDonationList HTTP/1.1 
Host: cms.winlink.org 
Content-Type: text/jsv
Content-Length: length

{
	CallsignFilter: String,
	NameFilter: String,
	AgeFilter: String,
	RecordLimit: 0,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Donations: 
	[
		{
			TransactionId: String,
			Timestamp: 0001-01-01,
			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
		}
	}
}