Documentation
Endpoints
Environment | URL |
---|---|
Production | |
Acceptance |
Test
*Extend the URL with /wsdl to retrieve the WSDL
...
The redirectSessionID is valid for single use and will expire 15 minutes after it has been received through the Identity Callback.
Authentication
Name | Type | Cardinality | ||
---|---|---|---|---|
authHeader | authHeader | 1...1 | ||
Source
|
Request
Name | Type | Cardinality | ||
---|---|---|---|---|
redirectSessionID | string64 | 1...1 | ||
Source
|
Response
Name | Type | Cardinality | Description | ||
---|---|---|---|---|---|
uid | string256 | 1...1 | |||
personProfileID | string256 | 0...1 | Present in case of a 'MBO' student | ||
personRealID | string256 | 0...1 | Present in case of a 'VO' student | ||
givenName | string50 | 1...1 | |||
sn | string50 | 1...1 | |||
personTussenvoegsels | string15 | 0...1 | |||
affiliation | string50 | 1...1 | |||
digiDeliveryID | string256 | 0...1 | |||
homeOrganization | string50 | 1...1 | |||
homeOrganizationID | string4-6 | 1...1 | |||
eckID | eckID | 0...1 | |||
Source
|
...
Error codes
General errors
Error code | Description |
---|---|
-200 | Bad Request |
0 | General error Something went wrong during the operation. |
Specific errors
Error code | Description |
---|---|
-1 | Redirect session expired |
...
Complex types
authHeader
Name | Type | Cardinality | Description |
---|---|---|---|
loginHeader | loginHeader | 1...1 |
loginHeader
Name | Type | Cardinality | Description |
---|---|---|---|
username | string100 | 1...1 | |
password | string64 | 1...1 |
...
Simple types
Name | Type | Possible values / format | Description |
---|---|---|---|
string4-6 | String | Min length: 4 characters Max length: 6 characters | String limited by a number of minimum and maximum allowed characters. |
string15 | String | Max length: 15 characters | String limited by a number of maximum allowed characters. |
string50 | String | Max length: 50 characters | String limited by a number of maximum allowed characters. |
string64 | String | Max length: 64 characters | String limited by a number of maximum allowed characters. |
string100 | String | Max length: 100 characters | String limited by a number of maximum allowed characters. |
string256 | String | Max length: 256 characters | String limited by a number of maximum allowed characters. |
eckID | String | Min length: 128 characters Max length: 256 characters | eckID is in the form of a URL: https://id.school/2015-09/[128-char hex string]. Currently this url resolves to a static page containing general information about the ECK ID. |