YM REST Services

DonationFunds

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Requires the permission:	/admin/donations/

The following routes are available for this service:
GET	/Ams/{ClientID}/DonationFunds	Return 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:
Name	Parameter	Data Type	Required	Description
fundId	path	int	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**DonationFundsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
fundList	form	List<DonationFundDetailed>	No

**DonationFundDetailed** Parameters:
Name	Parameter	Data Type	Required	Description
fundDescription	form	string	No
fundOptions	form	List<DonationFundOptions>	No

**DonationFund** Parameters:
Name	Parameter	Data Type	Required
fundId	form	int	No
fundName	form	string	No
fundOptionsCount	form	int	No

**DonationFundOptions** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	No
Value	form	double	No

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

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	fundList: 
	[
		{
			fundDescription: String,
			fundOptions: 
			[
				{
					Description: String,
					Value: 0
				}
			],
			fundId: 0,
			fundName: String,
			fundOptionsCount: 0
		}
	],
	fundId: 0,
	UsingRedis: True,
	AppInitTime: 2024-05-02T23:24:29.3036719-04:00,
	ServerID: WS-4-69-031,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-02T23:55:44.9150287-04:00,
	Device: Desktop
}