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

<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 .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/search HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ArsfiDonationSearchResponse 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>
  <Donations>
    <DonationRecord>
      <Amount>0</Amount>
      <Callsign>String</Callsign>
      <EmailAddress>String</EmailAddress>
      <Name>String</Name>
      <Notes>String</Notes>
      <RegistrationKey>String</RegistrationKey>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <TransactionId>String</TransactionId>
      <TransactionType>String</TransactionType>
      <Void>false</Void>
    </DonationRecord>
  </Donations>
</ArsfiDonationSearchResponse>