Ophalen uitpas prijs
Method GET
URL {prefix}/uitpas/price
Parameters:
Naam | Type | Omschrijving | Verplicht |
balieConsumerKey | String | ConsumerKey van de balie waarvoor deze request wordt uitgevoerd. | x |
uitpasNumber | String | identificatie van een kaart | x |
dateOfBirth | W3CDate | Geboortedatum van de pashouder | |
postalCode | String | postcode van de pashouder | |
voucherNumber | String | identificatie van een voucher | |
reason | String | Reden van kaartverkoop. De mogelijke waarden zijn: FIRST_CARD CARD_UPGRADE EXTRA_CARD LOSS_THEFT DEFECT LOSS_KANSENSTATUUT OBTAIN_KANSENSTATUUT |
x |
Authenticatie User access token van de balie medewerker die de actie uitvoert
Required permission De gebruiker die de actie uitvoert moet medewerkter zijn van de opgegeven balie. De opgegeven balie moet pashouders kunnen registereren.
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: UNKNOWN_CARD PARSE_INVALID_UITPASNUMBER UNKNOWN_VOUCHER PARSE_INVALID_VOUCHERNUMBER PARSE_INVALID_UITPAS_STATUS_CHANGE_REASON (ongekende waarde voor parameter reason) BALIE_NOT_AUTHORIZED (kaart is niet toegekend aan de balie) MISSING_REQUIRED_FIELDS INVALID_VOUCHER_STATUS |
message | Beschrijving van de fout |
requiredPermission | Indien code = ACCESS_DENIED, dan bevat dit veld de vereiste permissie. |
Voorbeeld request
GET {prefix}/uitpas/price
balieConsumerKey=8bd020fb-a55a-4d15-b71c-1a1632cb7f00 uitpasNumber=0934000185108 dateOfBirth=2010-01-01 reason=FIRST_CARD
Voorbeeld response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<uitpasPrice>
<id>148</id>
<reason>FIRST_CARD</reason>
<cardType>CARD</cardType>
<ageRange>
<ageTo>17</ageTo>
</ageRange>
<kansenstatuut>false</kansenstatuut>
<price>2.00</price>
<cardSystem>
<id>1</id>
<name>UiTPAS Regio Aalst</name>
</cardSystem>
</uitpasPrice>
</response>
Lees vorige:
Endpoints
Lees verder: Checkin devices