API Reference

Get Host Auction Details

This API is used to get host auction details like collected amount, a number of bidders, items with bids, paid bid items, total bids, etc. The event admin, super admin, and organizer admin can access this API. We need to pass an authorization token here which is generated after successful login into the account.

  • Here is the description of response attributes, which returns in the form of JSON.

Attribute

Description

endDate

End date of the auction.

collectedAmount

Collected amount from this auction.

numberOfBidder

Number of bidders in the auction.

active

Is the module active or not?

status

Module status, the possible value will be EVENT_HAPPENING, PROCESSING_WINNER, WINNER_ANNOUNED, ERROR, EXTENDED_BIDDING, EVENT_MODULE_DELETED.

itemsWithBids

Total number of items that have been bid on.

paidBidItems

Total number of items which have paid bids.

totalItems

Total number of items in the auction.

totalBids

Total number of bids in the auction.

days

Total number of event days.

  • Here are the possible error messages that return if any condition fails or required data is missing for processing.

Error Code

Description

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource.

500

Interna server error.

4030201

Not event host.

Language
Credentials
Header
Click Try It! to start a request and see the response here!