Registreren van een pashouder
Method POST
URL {prefix}/uitpas/passholder/register
Parameters:
Naam | Type | Omschrijving | Verplicht |
---|---|---|---|
name | String | achternaam pashouder | x |
firstName | String | voornaam pashouder | x |
secondName | String | tweede naam pashouder | |
String | email adres pashouder | ||
inszNumber | String | nationaal nummer van pashouder. Dit moet een geldig Belgisch rijksregisternummer zijn. * Verplicht behalve indien: - de balie een geauthoriseerde MIA balie is - indien city=BUITENLAND en de balie rechten heeft om pashouders uit het buitenland te registreren - de balie rechten heeft om pashouders zonder INSZ te registreren |
* |
dateOfBirth | String | geboortedatum van pashouder (in w3c format, YYYY-MM-DD) | x |
gender | String | Toegelaten waarden: M, MALE: man V: vrouw F, FEMALE: vrouw |
|
street | String | straat pashouder | |
String | huisnummer pashouder | ||
String | postbus pashouder | ||
postalCode | String | postcode pashouder | x |
city | String | gemeente pashouder. indien geldige deelgemeente opgegeven wordt, wordt deze automatisch omgezet naar de hoofdgemeente. de postcode blijft behouden. | x |
telephone | String | telefoonnummer pashouder | |
gsm | String | GSM nummer pashouder | |
nationality | String | nationaliteit pashouder | |
placeOfBirth | String | geboorteplaats pashouder | |
uitpasNumber | String | nummer van de uitpas | x |
voucherNumber | String | nummer van een voucher | |
kansenStatuut | Boolean | true indien pashouder met kansenstatuut, false indien pashouder zonder kansenstatuut | |
kansenStatuutEndDate | W3CDate | einddatum kansenstatuut | x |
verified | boolean | true indien de gegevens van de pashouder werden ingelezen via belgium eid, false otherwise | |
moreInfo | String | een vrij tekstveld met informatie over deze pashouder | |
schoolConsumerKey | String | consumerKey van de school van deze pashouder | |
String | Dit veld mag niet meer gebruikt worden. Zie Opt-In Voorkeuren aanpassen | ||
String | Dit veld mag niet meer gebruikt worden. Zie Opt-In Voorkeuren aanpassen | ||
optInServiceMails | boolean | true indien de pashouder service mails wil ontvangen, anders false. Let op: deze parameter mag NIET true zijn indien pashouder jongen dan 16 | |
optInMilestoneMails | boolean | true indien de pashouder milestone mails wil ontvangen, anders false. Let op: deze parameter mag NIET true zijn indien pashouder jongen dan 16 | |
optInInfoMails | boolean | true indien de pashouder info mails wil ontvangen, anders false. Let op: deze parameter mag NIET true zijn indien pashouder jongen dan 16 | |
optInSms | boolean | true indien de pashouder sms wil ontvangen, anders false. Let op: deze parameter mag NIET true zijn indien pashouder jongen dan 16 | |
optInPost | boolean | true indien de pashouder post wil ontvangen, anders false. Let op: deze parameter mag NIET true zijn indien pashouder jongen dan 16 | |
legalTermsPaper | boolean | true indien de pashouder de gebruikersvoorwaarden op papier heeft ontvangen | |
legalTermsDigital | boolean | true indien de pashouder de gebruikersvoorwaarden via e-mail heeft ontvangen | |
parentalConsent | boolean | true indien de er toestemming is van een ouder of voogd bij registratie van een minderjarige pashouder | |
balieConsumerKey | String | ConsumerKey van de balie waarvoor deze request wordt uitgevoerd. | x |
Authenticatie User access token van de Balie medewerker die de actie uitvoert
Required permission
- Balie: PERMISSION_PASSHOLDER - ACTION_CREATE
- Kansenstatuut enkel toegelaten voor balies met: PERMISSION_KANSENSTATUUT - ACTION_CREATE
- Pashouders uit andere gemeenten enkel toegelaten voor balies met PERMISSION_PASSHOLDER_OTHER_CITY - ACTION_CREATE
Response
Bij succes HTTP 200 OK met pashouder uid in response body
Bij fouten
HTTP 400 Bad Request status code, aangevuld met een XML body met extra informatie.
code | ErrorCode van de fout: ACTION_FAILED MISSING_REQUIRED_FIELDS INSZ_ALREADY_USED EMAIL_ALREADY_USED UNKNOWN_VOUCHER (geen voucher gevonden met opgegeven nummer) UNKNOWN_CARD (geen kaart gevonden met opgegeven nummer) CARD_NOT_ASSIGNED_TO_BALIE (Uitpas is niet verdeeld aan balie) INVALID_CARD (Uitpasnummer van een kansenpas verplicht indien pashouder met kansenstatuut of Pashouder met kansenstatuut verplicht indien uitpasnummer van kansenpas) INVALID_CARD_STATUS (kaart was niet in LOCAL_STOCK) INVALID_VOUCHER_STATUS (voucher is reeds verzilverd) UNKNOWN_SCHOOL PARSE_INVALID_CITY_NAME PARSE_INVALID_POSTAL_CODE PARSE_INVALID_INSZ PARSE_INVALID_UITPASNUMBER PARSE_INVALID_VOUCHERNUMBER PARSE_INVALID_GENDER PARSE_INVALID_DATE PARSE_INVALID_DATE_OF_BIRTH BALIE_NOT_AUTHORIZED ACCESS_DENIED INVALID_EMAIL_ADDRESS (het email adres is niet geldig = bevat geen @ of ‘.’) |
message | Beschrijving van de fout |
requiredPermission | Indien code = ACCESS_DENIED, dan bevat dit veld de vereiste permissie. |
Voorbeeld request
POST {prefix}/uitpas/passholder/register
dateOfBirth=1993-05-18&placeOfBirth=&street=&city=Haaltert&uitpasNumber=0930056878802&nationality=&postalCode=9450&email=janssen.p%40telenet.be&name=Janssen&inszNumber=93051822361&gender=M&firstName=Pieter&telephone=
Voorbeeld response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<message>94305b2e-e7ff-4dfc-8d96-ef4d43de9038</message>
<resource>/uitpas/passholder/0930056878802</resource>
</response>
Lees vorige:
Ophalen prijzen uitpas
Lees verder: Registreren, vernieuwen en heractiveren van een lidmaatschap