This API is used to get Fund A Need setting information. This API can be accessed by event admin and super admin. It will return Fund A Need data like accessToken, Fund A Need status, event timezone, and many more. We need to pass an authentication token to authorize the user, event URL in path param, and get all the settings of Fund A Need.
Here is the description of response attributes, which returns to the form of JSON.
Attribute | Description |
|---|---|
activated | If the module is activated, this will be set to True. |
categoryEnabled | If the category is enabled, this will be set to True. |
causeAuctionStatus | This contains Fund A Need Status such as Event Happening, Processing Winner, Winner Announced, Bidding Extended, and Event Module Deleted. |
countDownTimeShow | If the Countdown is being displayed, this will be set to True. |
equivalentTimeZone | This is the time zone equivalent to custom time zone. |
eventTimeZone | This is the selected Time Zone for the event. |
includeUnpaidPledgesInTotal | All pledges included those unpaid will be included and this will be set to True. |
moduleShow | The Fund A Need will be displayed if this is set to True. |
pledgeButtonName | This is used to set the custom name of the pledge button. |
requireUserAddress | This requires the participants mailing address to be collected. |
showItemTotals | This will allow Item totals to be shown on the bidding page. |
timeZones | This returns a list of available time zones. |
txtMsgBidInstShown | Show Text Message Bidding Instructions. |
userTime | This is the end time of the Fund A Need to submit a pledge. |