Inhoud

Verzilveren welkomstvoordeel

Method POST

URL {prefix}/uitpas/passholder/{uitpasNumber}/cashInWelcomeAdvantage

waarbij {uitpasNumber} de uitpas nummer

Parameters:

Naam Type Omschrijving Verplicht
welcomeAdvantageId Long identificatie welkomstvoordeel x
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  

Authenticatie UserAccessToken van de Balie medewerker die de actie uitvoert

Response

Bij succes HTTP 200 OK met response body in xml formaat

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

code ErrorCode van de fout:
PARSE_INVALID_LONG
UNKNOWN_BALIE_CONSUMERKEY
UNKNOWN_WELCOME_ADVANTAGE_ID
INVALID_CARD_STATUS
WELCOMEADVANTAGE_ALREADY_CASHED_IN
ACTION_NOT_ALLOWED
BALIE_NOT_AUTHORIZED
message Beschrijving van de fout
requiredPermission Indien code = ACCESS_DENIED, dan bevat dit veld de vereiste permissie.

Voorbeeld request

POST {prefix}/uitpas/passholder/0987654321113/cashInWelcomeAdvantage

welcomeAdvantageId=5

Voorbeeld response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<promotionTO>
	<applicableCardSystems>
		<cardsystem>
			<id>1</id>
			<name>UiTPAS Regio Aalst</name>
		</cardsystem>
	</applicableCardSystems>
	<balies>
		<balie>
			<name>CC De Werf </name>
			<id>31413BDF-DFC7-7A9F-10403618C2816E44</id>
			<visible>false</visible>
		</balie>
	</balies>
	<cashedIn>true</cashedIn>
	<cashingDate>2015-06-26T14:45:08.554+02:00</cashingDate>
	<id>5</id>
	<inSpotlight>false</inSpotlight>
	<owningCardSystem>
		<id>1</id>
		<name>UiTPAS Regio Aalst</name>
	</owningCardSystem>
	<points>0</points>
	<title>Theatercheque € 2,5 in cc De Werf</title>
</promotionTO>

Lees vorige:
Inchecken pashouder

 

Lees verder:
Ophalen omruilvoordelen