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

<back to all web services

ArsfiDonationAdd

Adds an ARSFi donation record.

The following routes are available for this service:
POST/arsfi/donation/add
ArsfiDonationAdd Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringNoCallsign of person making donation
NamebodystringYesName of person making donation
EmailAddressbodystringYesEmail address
AmountbodydoubleYesDollar amount of donation
TransactionTypebodystringYesType of transaction (Winmor, V4, Donation, etc.)
RegistrationKeybodystringNoRegistration key
VoidedbodyboolNoTrue if donation has been voided
NotesbodystringNoNotes
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 .xml suffix or ?format=xml

HTTP + XML

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

POST /arsfi/donation/add HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ArsfiDonationAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <Amount>0</Amount>
  <Callsign>String</Callsign>
  <EmailAddress>String</EmailAddress>
  <Name>String</Name>
  <Notes>String</Notes>
  <RegistrationKey>String</RegistrationKey>
  <TransactionType>String</TransactionType>
  <Voided>false</Voided>
</ArsfiDonationAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArsfiDonationAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ArsfiDonationAddResponse>