Inhoud

Block uitpas

Method POST

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

Parameters:

Naam Type Omschrijving
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 of van de eigenaar van de uitpas zelf

Required permission In geval van balie medewerker: PERMISSION_PASSHOLDER - ACTION_BLOCK in een kaartsysteem waarvan de pashouder lid is. In geval van uitpas eigenaar: Enkel data van de UiTid user die ingelogd is, kan gewijzigd worden.

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_UITPASNUMBER
PARSE_INVALID_UITPASNUMBER
INVALID_CARD_STATUS (bijv. de kaart was reeds geblokkeerd)
message Beschrijving van de fout

Voorbeeld request

POST {prefix}/uitpas/passholder/block/1234567890116

Voorbeeld response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
	<code>ACTION_SUCCEEDED</code>
	<message>The uitpas has been blocked.</message>
</response>

Lees vorige:
Update pashouder

 

Lees verder:
Zoeken van welkomstvoordelen