Get an event
GET
https://api-v2.test.eldowallet.fr/events/:id
Returns the details of an event in your wallet from its ID.
Good to know
PKTextAlignmentLeft,PKTextAlignmentCenterandPKTextAlignmentRightdefine which rows each ticket must provide (leftRow,centerRow,rightRow). A row is required on every pass unless its alignment is set toINACTIVE.
Request
path parameters
idstring requiredEvent ID (24-character hexadecimal MongoDB ID).
header parameters
x-langstringLanguage for responsesenum:en,frdefault:"en"
Responses
- 200
- 401
- 403
- 404
- 500
Schema
application/jsonstatusstring requiredenum:PENDING,ACTIF,ENDEDdefault:"PENDING"walletoneOf required- Wallet
namestring requiredlogostring requirediconstring requiredandroidLogostringdisplayIdentifiantboolean requiredpassBuilderPassTemplateIdstringpassBuilderBusinessIdstringpassBuilderTokenstringidentifierstring requiredidentifierQrstring requiredaddressstringwebsitestring requiredservicePhonestring requiredbusinessPhonestring requiredsocialMediaobject requiredlinkedinstringfacebookstringinstagramstringtiktokstringtwitterstringyoutubestringsnapchatstringpintereststringredditstringwhatsappstringtelegramstring
additionalContactsobject[] requiredtitlestring requiredvaluestring requiredkindstring requiredenum:URL,PHONE,EMAIL
termsAndConditionsobject requiredtypestring requiredenum:PDF,URL,NONEcustomUrlstringpdfUrlstring
webHookUrlstring requiredrootDomainstring requiredtimezonestringallowedPassesstring[] requiredenum:ALL,EVENT_TICKET,TRANSIT,CINEMA,BOARDING_PASS,COUPON,GENERIC,STORE_CARD,OFFER,HOTELexpiredCleanupEnabledboolean required_idstring requiredcreatedAtstring <date-time> requiredupdatedAtstring <date-time> required
- option 2
- Wallet
barcodeTypestring requiredenum:AZTEC,CODE_128,PDF_417,QR_CODE,NONEnamestring requiredlocationsobject[] requiredlongitudenumberlatitudenumberaddressstringlocationNamestring
dateobjectstartDatestring <date-time>endDatestring <date-time>doorOpeningHourstring <date-time>
pricenumbergainUnitstringenum:NONE,EURO,USD,MAD,POINTSdescriptionstringtermsstringsubscriptionMessagestring requiredemailSubscriptionMessagestring requiredcontactPhonestringemailstringwebsitestringcolorsobject requiredlabelColorstring requiredbackgroundColorstring requiredforegroundColorstring required
securityobjectenableOneTimeUsebooleandisableIOSPassSharingbooleandisablePassLinkSharingbooleandisableMultipleHoldersbooleanenableSecurityAnimationbooleanenableRotatingBarcodeboolean
passBuilderPassTemplateIdstringstripstringPKTextAlignmentLeftstringenum:CHAIR,ACCESS,PRICE,ZONE,INACTIVEPKTextAlignmentCenterstringenum:ROW,INACTIVEPKTextAlignmentRightstringenum:INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT_idstring requiredcreatedAtstring <date-time> requiredupdatedAtstring <date-time> required
UNAUTHORIZED
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
FORBIDDEN
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
MODEL_NOT_FOUND
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNKNOWN_ERROR
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email