| Requires any of the roles: | admin, oauthadmin | Requires the permission: | /admin/donations/ |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| fundId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| fundList | form | List<DonationFundDetailed> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| fundDescription | form | string | No | |
| fundOptions | form | List<DonationFundOptions> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| fundId | form | int | No | |
| fundName | form | string | No | |
| fundOptionsCount | form | int | No |
| 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 .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"fundList":[{"fundDescription":"String","fundOptions":[{"Description":"String","Value":0}],"fundId":0,"fundName":"String","fundOptionsCount":0}],"fundId":0,"UsingRedis":true,"AppInitTime":"2024-05-03T00:24:41.1317790-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-03T02:59:11.3844403-04:00","Device":"Desktop"}