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

<back to all web services

ArsfiDonationGet

Returns a specific ARSFi donation record.

The following routes are available for this service:
POST/arsfi/donation/get
ArsfiDonationGet Parameters:
NameParameterData TypeRequiredDescription
TransactionIdbodystringYesThe unique transaction ID
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ArsfiDonationGetResponse Parameters:
NameParameterData TypeRequiredDescription
DonationformDonationRecordNo
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 /arsfi/donation/get HTTP/1.1 
Host: wien.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TransactionId: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Donation: 
	{
		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
		}
	}
}