get https://api.accelevents.com/rest/events//auction/settings
This API is used to get the Auction module display page setting by an event. This contains all basic details of the auction which will be displayed to end users.
Path Parameters
- Event URL
Body Parameters - Not Required
Response
Details / Check response object
Authentication required - ❌
Modules
Display - ✅
Portal - ❌
Host - ❌
Here is the description of response attributes, which returns to the form of JSON.
Attributes | Description |
---|---|
categories | This represents auction item categories, auction item may or may not belong to a particular category. |
categoriesEnabled | If this is true then bidders can browse items by category, otherwise not. |
countDownTimeShow | If this is true then bidders can see remaining time of auction end, otherwise not. |
endDate | This contains auction end time. When the auction ends, and it will return in yyyy/MM/dd HH:mm:sss format. |
instruction | Contains instructions on how to make a bid. |
marketValueEnabled | Specify the market value of each item |
moduleActivated | Whether the auction is activated or not. Bidders can only make bids if this is activated (true) |
moduleEnded | Returns true if the module already ended, then bidders can no longer make bids. The default value is false. |
pledgeButtonName | Display button text for end-users |
requireUserAddress | If this is true then bidders must provide address details while making a bid. |
socialSharingEnabled | Whether social share allowed or not for an auction item |
totalFundRaised | Amount of total funds collected. |
txtMsgBidInstShown | If this is true, it shows text message bidding instructions |
Error Code | Error Description |
---|---|
400 | The request could not be understood by the server due to malformed syntax. |
404 | The resource you were trying to reach is not found. |
4040200 | Event Not Found |