Get raffle details on display page

This API is used to get the Raffle module display page setting by an event. This contains all basic details of raffle 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 raffle item categories, raffle items may or may not belong to a particular category.

categoriesEnabled

If this is true then users can browse items by category, otherwise not.

countDownTimeShow

If this is true then users can see remaining time of the raffle end.

endDate

This contains raffle end time. it will return in yyyy/MM/dd HH:mm:sss format.

instruction

Contains instructions on how to submit raffle tickets.

marketValueEnabled

Specify the market value of each item

moduleActivated

Whether the raffle is activated or not. Users can buy tickets only if this is true (activated)

moduleEnded

Returns true if the module already ended, then users can't buy tickets. The default value is false.

pledgeButtonName

Display button text for end-users

requireUserAddress

If this is true then users must provide address details while purchasing tickets.

socialSharingEnabled

Whether social share allowed or not for a raffle item

totalFundRaised

Amount of total funds collected by raffle.

txtMsgBidInstShown

If this is true then show text message bidding instructions

complimantaryCodeAvailable

If a Complimentary code is available, this returns true

autoSubmitOnPurchase

if this is true, then if the user purchases at that time tickets will be auto-submitted for raffle

availableTickets

This indicates available tickets for sale

ticketPackages

This contains a number of tickets price-wise, including:

  • numberOfTickets : Total number of tickets available
  • price : Describes price of an individual ticket.
  • id: Represents unique identifier of a ticket
  • complementary -: boolean type represents - if complementary is enabled then it returns true, otherwise false.

description

This contains a raffle description

raffleBuyButtonText

Contains properties of raffle button for display like color, label, font, hidden (true or false)

Error Code

Error Description

400

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

4040200

Event Not Found

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