YM REST Services

<back to all web services

DonationFunds

Requires Authentication
Requires any of the roles:admin, oauthadminRequires the permission:/admin/donations/
The following routes are available for this service:
GET/Ams/{ClientID}/DonationFundsReturn a list of Donation Funds currently setup for this client.
GET/Ams/{ClientID}/DonationFunds/{fundId}Return the details of a specific Donation Fund.
DonationFunds Parameters:
NameParameterData TypeRequiredDescription
fundIdpathintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
DonationFundsResponse Parameters:
NameParameterData TypeRequiredDescription
fundListformList<DonationFundDetailed>No
DonationFundDetailed Parameters:
NameParameterData TypeRequiredDescription
fundDescriptionformstringNo
fundOptionsformList<DonationFundOptions>No
DonationFund Parameters:
NameParameterData TypeRequiredDescription
fundIdformintNo
fundNameformstringNo
fundOptionsCountformintNo
DonationFundOptions Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
ValueformdoubleNo

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}/DonationFunds HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DonationFundsResponse 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>
  <fundId>0</fundId>
  <fundList>
    <DonationFundDetailed>
      <fundId>0</fundId>
      <fundName>String</fundName>
      <fundOptionsCount>0</fundOptionsCount>
      <fundDescription>String</fundDescription>
      <fundOptions>
        <DonationFundOptions>
          <Description>String</Description>
          <Value>0</Value>
        </DonationFundOptions>
      </fundOptions>
    </DonationFundDetailed>
  </fundList>
</DonationFundsResponse>