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

<back to all web services

ArsfiDonationUpdate

Updates a ARSFi donation record. Omited parameters are left unchanged

The following routes are available for this service:
POST/arsfi/donation/update
ArsfiDonationUpdate Parameters:
NameParameterData TypeRequiredDescription
TransactionIdbodystringYesThe unique transaction ID
CallsignbodystringNoCallsign of person making donation
NamebodystringNoName of person making donation
EmailAddressbodystringNoEmail address
AmountbodydoubleNoDollar amount of donation
TransactionTypebodystringNoType of transaction (Winmor, V4, Donation, etc.)
RegistrationKeybodystringNoRegistration key
NotesbodystringNoNotes
VoidbodyboolNoTrue to void the registration record
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

HTTP + CSV

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

POST /arsfi/donation/update HTTP/1.1 
Host: halifax.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TransactionId":"String","Callsign":"String","Name":"String","EmailAddress":"String","Amount":0,"TransactionType":"String","RegistrationKey":"String","Notes":"String","Void":false,"Key":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}