Inhoud

Inchecken op basis van checkin code

Method POST

URL {prefix}/uitpas/enduser/checkin

Parameters: (application/x-www-form-urlencoded)

uitpasNumber uitpas nummer van de pashouder die een punt wil sparen
checkinCode de QR code string

Authenticatie Consumer request

Required permission De consumer die de actie uitvoert moet “punt sparen met QR code” rechten hebben.

Response

code Statuscode van de request:
Mogelijke codes:
ACTION_SUCCEEDED
CHECKIN_CODE_EXPIRED
CHECKIN_CODE_INVALID
GROUPPAS_NOT_ALLOWED
PARSE_INVALID_UITPASNUMBER
UNKNOWN_UITPASNUMBER
INVALID_CARD_STATUS_BLOCKED
INVALID_CARD_STATUS_DELETED
INVALID_CARD_STATUS
points Totaal aantal punten van de pashouder inclusief eventueel gespaarde punten (savedPoints)
savedPoints Met deze request gespaarde punten (enkel in geval ACTION_SUCCEEDED)
event event object dat gekoppeld is aan de checkinCode (niet beschikbaar in geval CHECKIN_CODE_INVALID)
pointsPromotions JSON array van Points promotions (zie hieronder)

Points promotion JSON object:

id id van het omruilvoordeel
title titel van het omruilvoordeel
points aantal benodigde punten
description1  
description2  
pictures JSON Array van string met daarin de URL naar de afbeeldingen van het omruilvoordeel
maxAvailableUnits  
inSpotlight boolean

Event JSON object:

id id van het event
title titel van het event
organiser organiser object

Organiser JSON object:

id id van de organiser
name naam van de organiser

Voorbeeld request

POST {prefix}/uitpas/enduser/checkin checkinCode=12345678&uitpasNumber=0930056878802

Voorbeeld response

{
  "code": "ACTION_SUCCEEDED"
  "points": 5,
  "event": {
    "id": "fd1f4d98-8ee3-44f6-ae61-8d64e3b5e40c",
    "title": "Cultuurnet Vlaanderen",
    "organiser": {
      "id": "47B6FA21-ACB1-EA8F-2C231182C7DD0A19",
      "name": "CultuurNet Vlaanderen"
    }
  },
  "pointsPromotions": [
   {
      "id": 1,
      "title": "Voordeel1",
      "points": 10,
      "description1": "description 1",
      "description2": "description 2",
      "pictures": "[]",
      "maxAvailableUnits": 10,
      "inSpotlight": false
    },
   {
      "id": 1,
      "title": "Voordeel2",
      "points": 10,
      "description1": "description 1",
      "description2": "description 2",
      "pictures": "[]",
      "maxAvailableUnits": 10,
      "inSpotlight": true
    }]
}

Lees vorige:
Ophalen van pashouder punten

 

Lees verder:
Entiteiten