YM REST Services

<back to all web services

DonationHistory

Requires Authentication
Requires any of the roles:admin, oauthadmin, member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/DonationHistoryReturn a list of all donation.
DonationHistory Parameters:
NameParameterData TypeRequiredDescription
PageSizequeryintNo
PageNumberqueryintNo
OrderByquerystringNo
OrderByDirectionquerystringNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
DonationHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
TotalCountformintNo
DonationsformList<DonationData>No
DonationData Parameters:
NameParameterData TypeRequiredDescription
intDonationIdformintNo
DatDonationformDateTimeNo
dblDonationformdoubleNo
intStatusformintNo
strStatusformstringNo
strInvoiceGUIDformstringNo
dblOutstandingBalanceformdoubleNo
strFundNameformstringNo
datTransactionformDateTimeNo
intMultiplePaymentsformintNo
intNumberOfPaymentsformintNo
datInvoiceDateformDateTimeNo
dblOutstandingDonationformdoubleNo
MultipleInvoiceDeleteButtonformboolNo
SingleInvoiceDeleteButtonformboolNo
IsAwaitingAutoBillformboolNo
IsInvoicePaymentOptionAvailableformboolNo
AbstractTimeformintNo

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.

GET /Ams/{ClientID}/Member/{MemberID}/DonationHistory HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DonationHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <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>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <OrderBy>String</OrderBy>
  <OrderByDirection>String</OrderByDirection>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <Donations>
    <DonationData>
      <AbstractTime>0</AbstractTime>
      <DatDonation>0001-01-01T00:00:00</DatDonation>
      <IsAwaitingAutoBill>false</IsAwaitingAutoBill>
      <IsInvoicePaymentOptionAvailable>false</IsInvoicePaymentOptionAvailable>
      <MultipleInvoiceDeleteButton>false</MultipleInvoiceDeleteButton>
      <SingleInvoiceDeleteButton>false</SingleInvoiceDeleteButton>
      <datInvoiceDate>0001-01-01T00:00:00</datInvoiceDate>
      <datTransaction>0001-01-01T00:00:00</datTransaction>
      <dblDonation>0</dblDonation>
      <dblOutstandingBalance>0</dblOutstandingBalance>
      <dblOutstandingDonation>0</dblOutstandingDonation>
      <intDonationId>0</intDonationId>
      <intMultiplePayments>0</intMultiplePayments>
      <intNumberOfPayments>0</intNumberOfPayments>
      <intStatus>0</intStatus>
      <strFundName>String</strFundName>
      <strInvoiceGUID>String</strInvoiceGUID>
      <strStatus>String</strStatus>
    </DonationData>
  </Donations>
  <TotalCount>0</TotalCount>
</DonationHistoryResponse>