Inhoud

Acties voor een pashouder aan een balie uitvoeren

Method POST

URL {prefix}/uitpas/passholder/eventActions

Parameters:

Naam Type Omschrijving Verplicht
uitpasNumber String uitpas nummer 13 cijfers x
cdbid String id van een event waarvoor je een ticket wil kopen  
actionCheckin boolean zet op “true” wanneer de pashouder incheckt op het opgegeven event. checkin wordt enkel uitgevoerd wanneer ook cdbid wordt meegegeven en checkin momenteel toegelaten is. default waarde is “false”  
actionBuyTicket boolean zet op “true” wanneer de pashouder een ticket koopt voor het opgegeven event. een ticket wordt enkel gekocht wanneer ook cdbid wordt meegegeven. default waarde is “false”  
pointsPromotionIds String ids van de verzilveracties die de pashouder wil verzilveren. Gescheiden door een komma.  
welcomeAdvantageIds String ids van de welkomstvoordelen die de pashouder wil verzilveren. Gescheiden door een komma.  
balieConsumerKey String ConsumerKey van de balie waarop deze request gebeurt. Deze parameter is niet verplicht. Standaard wordt de consumer key uit de oauth request gebruikt. Zie gebruik van andere balies door Service Consumer in punt 2.4  
ticketSaleCouponId long Ticket sale coupon Id die gebruikt moet worden bij de ticketsale  

Authenticatie UserAccessToken van een balie medewerker

Response

Bij succes HTTP 200 OK met een response body in XML formaat

passholder pashouder object
actions Lijst van action objecten

Action:

actionType Type van de action:
CHECKIN,
BUYTICKET,
CASHIN_POINTSPROMOTION,
CASHIN_WELCOMEADVANTAGE
welcomeAdvantageResponse Response object in geval van CASHIN_WELCOMEADVANTAGE
pointsPromotionResponse Response object in geval van CASHIN_POINTSPROMOTION
buyTicketResponse Response object in geval van BUYTICKET
checkinResponse Response object in geval van CHECKIN

WelcomeAdvantageResponse

code code van response:
ACTION_SUCCEEDED
UNKNOWN_CARD
INVALID_CARD
UNKNOWN_WELCOME_ADVANTAGE_ID
WELCOMEADVANTAGE_ALREADY_CASHED_IN
promotion Promotion object van het opgenomen welkomstvoordeel

PointsPromotionResponse

code code van response:
ACTION_SUCCEEDED
UNKNOWN_CARD
UNKNOWN_POINTS_PROMOTION_ID
UNKNOWN_BALIE_ID
ACTION_NOT_ALLOWED
promotion Promotion object van het opgenomen verzilvervoordeel
cashInState Ingevuld indien ACTION_NOT_ALLOWED:
NOT_POSSIBLE_DISABLED_BY_CARD_SYSTEM
NOT_POSSIBLE_INVALID_CARD,
NOT_POSSIBLE_DATE_CONSTRAINT,
NOT_POSSIBLE_VOLUME_CONSTRAINT,
NOT_POSSIBLE_USER_VOLUME_CONSTRAINT,
NOT_POSSIBLE_POINTS_CONSTRAINT,
NOT_POSSIBLE_USER_CONSTRAINT,
NOT_APPLICABLE_TO_PASSHOLDER,
NOT_POSSIBLE_NO_ACTIVE_CARD_SYSTEM,
NOT_POSSIBLE_KANSENSTATUUT_EXPIRED;

BuyTicketResponse

code code van response:
ACTION_SUCCEEDED
TICKETSALE_NOT_ALLOWED_FREE_EVENT
INVALID_CARD_STATUS
INVALID_CARD
PASSHOLDER_NO_ACTIVE_CARDSYSTEMS
MAXIMUM_REACHED
INVALID_DATE_CONSTRAINTS
TICKET_SALE_COUPON_NOT_GRANTED
price prijs betaalde door de pashouder
id ID van de ticket sale

CheckinResponse

code code van response:
ACTION_SUCCEEDED
CHECKIN_CURRENTLY_NOT_ALLOWED
points nieuwe puntentotaal van de pashouder

Bij fouten HTTP 400 met een response body in XML formaat:

code ErrorCode van de fout:
UNKNOWN_BALIE_CONSUMERKEY
PARSE_INVALID_UITPASNUMBER
UNKNOWN_EVENT_CDBID
UNKNOWN_UITPASNUMBER
message Beschrijving van de fout

Voorbeeld request

POST {prefix}/uitpas/passholder/eventActions

uitpasNumber= 0930061965313 balieConsumerKey=31413BDF-DFC7-7A9F-10403618C2816E44 welcomeAdvantageIds=1,2 pointsPromotionIds=3,4,5

Voorbeeld response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
   <passHolder>
        <cardSystemSpecific>
            <cardSystem>
                <id>1</id>
                <name>HELA</name>
            </cardSystem>
            <currentCard>
                <kansenpas>true</kansenpas>
                <status>ACTIVE</status>
                <uitpasNumber>
                    <uitpasNumber>0930012345615</uitpasNumber>
                </uitpasNumber>
            </currentCard>
            <emailPreference>ALL_MAILS</emailPreference> <!-- DEPRECATED FIELD: Zie Opt-In voorkeuren aanpassen -->
            <kansenStatuut>true</kansenStatuut>
            <kansenStatuutEndDate>2013-12-31T23:59:59+01:00</kansenStatuutEndDate>
            <kansenStatuutExpired>false</kansenStatuutExpired>
            <kansenStatuutInGracePeriod>false</kansenStatuutInGracePeriod>
            <lastActivationMailNumber>0</lastActivationMailNumber>
            <smsPreference>NO_SMS</smsPreference> <!-- DEPRECATED FIELD: Zie Opt-In voorkeuren aanpassen -->
            <status>ACTIVE</status>
        </cardSystemSpecific>
        <city>AALST</city>
        <dateOfBirth>1980-12-15T00:00:00+01:00</dateOfBirth>
        <email>willy.wouters@mailinator.com</email>
        <firstName>Willy</firstName>
        <secondName>Willy</secondName>
        <gender>MALE</gender>
        <gsm>gsm-nr</gsm>
        <inszNumber>78021542697</inszNumber>
        <memberships/>
        <name>Wouters</name>
        <nationality>Belg</nationality>
        <number>1</number>
        <numberOfCheckins>5</numberOfCheckins>
        <placeOfBirth>Aalst</placeOfBirth>
        <points>9.000</points>
        <postalCode>9300</postalCode>
        <registrationBalieConsumerKey>cad22a20fa67b12ac1306b49755a2f7e</registrationBalieConsumerKey>
        <street>Wolvenveld</street>
        <telephone>0444/44.44.44</telephone>
        <uitIdUser>
            <ns2:id>031db251-9475-475e-bd0c-66dff0fa0577</ns2:id>
            <ns3:nick>willywouters</ns3:nick>
            <optInPreferences>
                <optInServiceMails>false</optInServiceMails>
                <optInMilestoneMails>true</optInMilestoneMails>
                <optInInfoMails>false</optInInfoMails>
                <optInSms>false</optInSms>
                <optInPost>true</optInPost>
            </optInPreferences>
        </uitIdUser>
        <verified>false</verified>
    </passHolder>

    <actions>
        <action>
            <actionType>CASHIN_POINTSPROMOTION</actionType>
            <pointsPromotionsResponse>
                <code>ACTION_NOT_ALLOWED</code>
                <cashInState>NOT_POSSIBLE_POINTS_CONSTRAINT</cashInState>
                <promotion>
                    <applicableCardSystems/>
                    <balies/>
                    <cashedIn>false</cashedIn>
                    <id>460</id>
                    <inSpotlight>false</inSpotlight>
                    <points>2</points>
                    <title>Test ups1384 beheer</title>
                </promotion>
            </pointsPromotionsResponse>
        </action>
        <action>
            <actionType>CASHIN_POINTSPROMOTION</actionType>
            <pointsPromotionsResponse>
                <code>UNKNOWN_POINTS_PROMOTION_ID</code>
               <message>PointsPromotion with id [5] not found.</message>
            </pointsPromotionsResponse>
        </action>
        <action>
            <actionType>BUYTICKET</actionType>
            <buyTicketResponse>
                <code>ACTION_SUCCEEDED</code>
 		    	<price>1.5</price>
            </buyTicketResponse>
        </action>
        <action>
            <actionType>CHECKIN</actionType>
            <checkingResponse>
                <code>CHECKIN_CURRENTLY_NOT_ALLOWED</code>
            </checkinResponse>
        </action>
    </actions>
</response>

Lees vorige:
Acties voor een pashouder aan een balie ophalen

 

Lees verder:
Bestaande pashouder registreren bij een nieuw kaartsysteem