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 .jsv suffix or ?format=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: 2025-01-15T08:15:38.3987731-05:00, ServerID: WS-4-190-907, 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: 2025-01-15T09:09:28.7247767-05:00, Device: Desktop }