The profile service contains functions needed to manage the person and school entities in Edu-iX. Furthermore you can manage the relations between persons and schools with this service. The account and license entities depend on these schoolperson records and are therefore needed before you can create an account of license for a person.
WSDL | Endpoint | |
---|---|---|
Production | https://distributor.edu-ix.nl/soap/4.1/profile/wsdl | https://distributor.edu-ix.nl/soap/4.1/profile |
Sandbox | https://acc-distributor.edu-ix.nl/soap/4.1/profile/wsdl | https://acc-distributor.edu-ix.nl/soap/4.1/profile |
This function returns a session ID that can be used as authentication value in other function-calls of the 3.0 service which use a sessionIDHeader.
Header | [loginHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
loginRequest
|
||||||||
Response |
loginResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Create | ||||||||
Role(s) | This function is not limited to specific roles. | ||||||||
Errors |
Get zero or more schools
Header | [authHeader Object] | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
getSchoolRequest
|
||||||||||||||||||||||||
Response |
getSchoolResponse
|
||||||||||||||||||||||||
Fault | [Fault Object] | ||||||||||||||||||||||||
CRUD | Read | ||||||||||||||||||||||||
Role(s) |
|
||||||||||||||||||||||||
Errors |
Create a new person. The given DistributorPersonID is used to determine if the person already exists. In case the person is nonexistent, it will be added.
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
createPersonRequest
|
||||||||
Response |
createPersonResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Create | ||||||||
Role(s) |
|
||||||||
Errors |
Returns a person.
Header | [authHeader Object] | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
getPersonRequest
|
||||||||||||||||||||||||||||||||||||||||||||||||
Response |
getPersonResponse
|
||||||||||||||||||||||||||||||||||||||||||||||||
Fault | [Fault Object] | ||||||||||||||||||||||||||||||||||||||||||||||||
CRUD | Read | ||||||||||||||||||||||||||||||||||||||||||||||||
Role(s) |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Errors |
Update a person
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
updatePersonRequest
|
||||||||
Response |
updatePersonResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Update | ||||||||
Role(s) |
|
||||||||
Errors |
Delete a person
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
deletePersonRequest
|
||||||||
Response |
deletePersonResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Delete | ||||||||
Role(s) |
|
||||||||
Errors |
Update the DistributorPersonID for a given person-entity
Header | [sessionIDHeader Object] | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
updatePersonIDRequest
|
||||||||||||
Response |
updatePersonIDResponse
|
||||||||||||
Fault | [Fault Object] | ||||||||||||
CRUD | Update | ||||||||||||
Role(s) |
|
||||||||||||
Errors |
Merge two person-entities.
Header | [sessionIDHeader Object] | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
mergePersonRequest
|
||||||||||||
Response |
mergePersonResponse
|
||||||||||||
Fault | [Fault Object] | ||||||||||||
CRUD | Update | ||||||||||||
Role(s) |
|
||||||||||||
Errors |
Create a schoolperson entity
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
createSchoolpersonRequest
|
||||||||
Response |
createSchoolpersonResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Create | ||||||||
Role(s) |
|
||||||||
Errors |
Retrieve one or more schoolperson entities
Header | [authHeader Object] | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
getSchoolpersonRequest
|
||||||||||||||||||||||||
Response |
getSchoolpersonResponse
|
||||||||||||||||||||||||
Fault | [Fault Object] | ||||||||||||||||||||||||
CRUD | Read | ||||||||||||||||||||||||
Role(s) |
|
||||||||||||||||||||||||
Errors |
Update a given schoolperson entity
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
updateSchoolpersonRequest
|
||||||||
Response |
updateSchoolpersonResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Update | ||||||||
Role(s) |
|
||||||||
Errors |
Delete a schoolperson-entity
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
deleteSchoolpersonRequest
|
||||||||
Response |
deleteSchoolpersonResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Delete | ||||||||
Role(s) |
|
||||||||
Errors |
In case of an error in the server or application, a Fault-element will be returned, containing more detailed information.
Element | Description | Type | Card. |
---|---|---|---|
code | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. | Attr | [1..1] |
message | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. | Attr | [1..1] |
Header for authentication. It can contain either a loginHeader-element or a sessionIDHeader-element
Element | Description | Type | Card. |
---|---|---|---|
Choose from the following elements: | [1..1] | ||
loginHeader | Header object for authentication with username and password | Obj | [1..1] |
or | |||
sessionIDHeader | Header object for authentication with a session ID. | Obj | [1..1] |
Unique identifier of a person at a distributor.
Element | Description | Type | Card. |
---|---|---|---|
distributorID | Unique identifier for a distributor | Attr | [1..1] |
distributorPersonID | Unique person identifier from the administration of the distributor | Attr | [1..1] |
distributorSchoolPerson
Element | Description | Type | Card. |
---|---|---|---|
distributorID | Unique identifier for a distributor | Attr | [1..1] |
distributorSchoolPersonID | Unique schoolperson identifier of distributor | Attr | [1..1] |
Header object for authentication with username and password
Element | Description | Type | Card. |
---|---|---|---|
username | Username for authentication on a service | Attr | [0..1] |
password | Password for authentication access to service | Attr | [0..1] |
Person information
Element | Description | Type | Card. |
---|---|---|---|
profileID | Unique ID of an Edu-iX profile. | Attr | [0..1] |
distributorPerson | Unique identifier of a person at a distributor. | Obj | [0..1] |
firstName | First name of the person | Attr | [1..1] |
preposition | String with maximum allowed length 15 | Attr | [0..1] |
dateOfBirth | The date of birth of a person | Attr | [0..1] |
personState | State of a person, i.e. "A" for active | Attr | [1..1] |
E-mail address | Attr | [0..1] | |
postalCode | Postal code | Attr | [1..1] |
surname | Surname of the person | Attr | [1..1] |
houseNumber | House number, number only | Attr | [0..1] |
gender | Gender of a person | Attr | [0..1] |
countryCode | Official ISO 3166-1 alpha-2 notation of a country code | Attr | [1..1] |
userID | Unique identifier for a portal user | Attr | [0..1] |
eckID | EckId, The derived ECK ID. | Attr | [0..1] |
Person information
Element | Description | Type | Card. |
---|---|---|---|
person | Person information | Obj | [1..1] |
schoolperson | Schoolperson information | Obj | [0..n] |
Unique identifier of a portal
Element | Description | Type | Card. |
---|---|---|---|
hubID | Unique identifier for a portal hub | Attr | [1..1] |
portalID | Unique identifier for a school portal | Attr | [1..1] |
School information
Element | Description | Type | Card. |
---|---|---|---|
organisationID | Org id | Attr | [1..1] |
name | Name of the current entity | Attr | [1..1] |
address | Street name | Attr | [0..1] |
houseNumber | House number, number only | Attr | [0..1] |
houseNumberSuffix | string part of the house number. | Attr | [0..1] |
postalCode | Postal code | Attr | [0..1] |
city | City name | Attr | [0..1] |
countryCode | Official ISO 3166-1 alpha-2 notation of a country code | Attr | [1..1] |
brin | Dutch school identification | Attr | [0..1] |
schoolInformation
Element | Description | Type | Card. |
---|---|---|---|
school | School information | Obj | [1..1] |
schoolPersonInformation
Element | Description | Type | Card. |
---|---|---|---|
schoolperson | Schoolperson information | Obj | [1..1] |
Schoolperson information
Element | Description | Type | Card. |
---|---|---|---|
distributorSchoolPersonID | Unique schoolperson identifier of distributor | Attr | [1..1] |
organisationID | Org id | Attr | [1..1] |
distributorPersonID | Unique person identifier from the administration of the distributor | Attr | [1..1] |
schoolStudentNumber | Unique number of a student from the administration of the school | Attr | [0..1] |
role | The role of the person | Attr | [1..1] |
Header object for authentication with a session ID.
Element | Description | Type | Card. |
---|---|---|---|
sessionID | Unique batch session identifier | Attr | [1..1] |
Attribute | Length | Type | Description |
---|---|---|---|
address | 50 | string | Street name |
brin | 6 | string |
Dutch school identification pattern: [0-9a-zA-Z]{4}([0-9]{2})? rules: A BRIN consists of four (4) alphanumerical characters followed by two (2) numbers. |
city | 50 | string | City name |
code | 10 | integer | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. |
countryCode | 2 | enum |
Official ISO 3166-1 alpha-2 notation of a country code possible values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW rules: A country code has to be a valid ISO 3166-1 alpha-2, two letter string |
dateOfBirth | date |
The date of birth of a person format: [YYYY]-[MM]-[DD] rules: The date of birth of a person cannot be a date in the future. |
|
distributorID | 10 | integer | Unique identifier for a distributor |
distributorPersonID | 256 | string | Unique person identifier from the administration of the distributor |
distributorSchoolPersonID | 256 | string | Unique schoolperson identifier of distributor |
eckID | 128 | string | EckId, The derived ECK ID. |
254 | string | E-mail address | |
firstName | 50 | string | First name of the person |
fromDistributorPersonID | 20 | string | Source unique person identifier from the administration of the distributor |
gender | 1 | enum |
Gender of a person possible values: M, F, U |
houseNumber | 11 | integer |
House number, number only rules: Only numbers are allowed. |
houseNumberSuffix | 10 | string | string part of the house number. |
hubID | 10 | enum |
Unique identifier for a portal hub possible values: Eduroute, Kennisnet, DAF |
message | 4096 | string | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. |
name | 50 | string | Name of the current entity |
organisationID | 40 | string | Org id |
password | 64 | string | Password for authentication access to service |
personState | 1 | enum |
State of a person, i.e. "A" for active possible values: A, B |
portalID | 64 | string | Unique identifier for a school portal |
postalCode | 10 | string |
Postal code rules: The format depends on the country code. The "NL" format consists of four (4) numbers followed by a spacing and two (2) alphabetic characters. For other country codes are no specific formats defined. |
preposition | 15 | string | String with maximum allowed length 15 |
profileID | 10 | integer |
Unique ID of an Edu-iX profile. rules: Maximum length 10 characters. Positive integer. |
role | 10 | enum |
The role of the person possible values: Student, Teacher |
schoolStudentNumber | 64 | string | Unique number of a student from the administration of the school |
sessionID | 64 | string | Unique batch session identifier |
surname | 50 | string | Surname of the person |
toDistributorPersonID | 20 | string | Destination unique person identifier from the administration of distributor |
userID | 100 | string | Unique identifier for a portal user |
username | 100 | string | Username for authentication on a service |
Code | Field | Description | Type |
---|---|---|---|
1 | (all) | General error | Service |
2 | (all) | Authentication error | Service |
3 | (all) | Database error | Service |
4 | (all) | Record already exists | Service |
5 | (all) | Record not found | Service |
6 | (all) | Incorrect request | Service |
7 | (all) | Search error | Service |
8 | (all) | Too many results | Service |
9 | (all) | You are not authorized to edit this record | Service |
10 | (all) | Not implemented | Service |
11 | (all) | Record locked | Service |
12 | (all) | Session expired | Service |
2200 | authHeader -> (choice element) | Missing | Object |
2208 | authHeader -> (choice element) | Not Authorized | Object |
2220 | authHeaderChoice -> loginHeader | Missing | Object |
2228 | authHeaderChoice -> loginHeader | Not Authorized | Object |
2240 | authHeaderChoice -> sessionIDHeader | Missing | Object |
2248 | authHeaderChoice -> sessionIDHeader | Not Authorized | Object |
2620 | createPersonRequest -> person | Missing | Object |
2626 | createPersonRequest -> person | Already exists | Object |
2628 | createPersonRequest -> person | Not Authorized | Object |
2800 | createSchoolpersonRequest -> schoolperson | Missing | Object |
2806 | createSchoolpersonRequest -> schoolperson | Already exists | Object |
2808 | createSchoolpersonRequest -> schoolperson | Not Authorized | Object |
2900 | deletePersonRequest -> distributorPerson | Missing | Object |
2907 | deletePersonRequest -> distributorPerson | Not found | Object |
2908 | deletePersonRequest -> distributorPerson | Not Authorized | Object |
3000 | deleteSchoolpersonRequest -> distributorSchoolPerson | Missing | Object |
3007 | deleteSchoolpersonRequest -> distributorSchoolPerson | Not found | Object |
3008 | deleteSchoolpersonRequest -> distributorSchoolPerson | Not Authorized | Object |
3020 | distributorPerson -> distributorID | Missing | Attribute |
3025 | distributorPerson -> distributorID | Incorrect type. Must be integer. | Attribute |
3026 | distributorPerson -> distributorID | Already exists | Attribute |
3027 | distributorPerson -> distributorID | Not found | Attribute |
3028 | distributorPerson -> distributorID | Not Authorized | Attribute |
3040 | distributorPerson -> distributorPersonID | Missing | Attribute |
3042 | distributorPerson -> distributorPersonID | Value is too long. (Max 256) | Attribute |
3045 | distributorPerson -> distributorPersonID | Incorrect type. Must be string. | Attribute |
3046 | distributorPerson -> distributorPersonID | Already exists | Attribute |
3047 | distributorPerson -> distributorPersonID | Not found | Attribute |
3048 | distributorPerson -> distributorPersonID | Not Authorized | Attribute |
3180 | distributorSchoolPerson -> distributorID | Missing | Attribute |
3185 | distributorSchoolPerson -> distributorID | Incorrect type. Must be integer. | Attribute |
3187 | distributorSchoolPerson -> distributorID | Not found | Attribute |
3188 | distributorSchoolPerson -> distributorID | Not Authorized | Attribute |
3200 | distributorSchoolPerson -> distributorSchoolPersonID | Missing | Attribute |
3202 | distributorSchoolPerson -> distributorSchoolPersonID | Value is too long. (Max 256) | Attribute |
3205 | distributorSchoolPerson -> distributorSchoolPersonID | Incorrect type. Must be string. | Attribute |
3207 | distributorSchoolPerson -> distributorSchoolPersonID | Not found | Attribute |
3208 | distributorSchoolPerson -> distributorSchoolPersonID | Not Authorized | Attribute |
3340 | Fault -> code | Missing | Attribute |
3345 | Fault -> code | Incorrect type. Must be integer. | Attribute |
3346 | Fault -> code | Already exists | Attribute |
3347 | Fault -> code | Not found | Attribute |
3348 | Fault -> code | Not Authorized | Attribute |
3360 | Fault -> message | Missing | Attribute |
3362 | Fault -> message | Value is too long. (Max 4096) | Attribute |
3365 | Fault -> message | Incorrect type. Must be string. | Attribute |
3366 | Fault -> message | Already exists | Attribute |
3367 | Fault -> message | Not found | Attribute |
3368 | Fault -> message | Not Authorized | Attribute |
3760 | getPersonRequest -> (choice element) | Missing | Object |
3767 | getPersonRequest -> (choice element) | Not found | Object |
3768 | getPersonRequest -> (choice element) | Not Authorized | Object |
3780 | getPersonRequestChoice -> distributorPerson | Missing | Object |
3788 | getPersonRequestChoice -> distributorPerson | Not Authorized | Object |
3820 | getPersonRequestChoice -> portal | Missing | Object |
3828 | getPersonRequestChoice -> portal | Not Authorized | Object |
3860 | getPersonRequestChoice -> profileID | Missing | Attribute |
3861 | getPersonRequestChoice -> profileID | Value is too small. (Min 1) | Attribute |
3865 | getPersonRequestChoice -> profileID | Incorrect type. Must be integer. | Attribute |
3868 | getPersonRequestChoice -> profileID | Not Authorized | Attribute |
4240 | getSchoolpersonRequest -> (choice element) | Missing | Object |
4247 | getSchoolpersonRequest -> (choice element) | Not found | Object |
4248 | getSchoolpersonRequest -> (choice element) | Not Authorized | Object |
4260 | getSchoolpersonRequestChoice -> distributorPerson | Missing | Object |
4268 | getSchoolpersonRequestChoice -> distributorPerson | Not Authorized | Object |
4280 | getSchoolpersonRequestChoice -> distributorSchoolPerson | Missing | Object |
4288 | getSchoolpersonRequestChoice -> distributorSchoolPerson | Not Authorized | Object |
4307 | getSchoolRequest -> (choice element) | Not found | Object |
4308 | getSchoolRequest -> (choice element) | Not Authorized | Object |
4320 | getSchoolRequestChoice -> organisationID | Missing | Attribute |
4321 | getSchoolRequestChoice -> organisationID | Value is too small. (Min 1) | Attribute |
4322 | getSchoolRequestChoice -> organisationID | Value is too long. (Max 40) | Attribute |
4325 | getSchoolRequestChoice -> organisationID | Incorrect type. Must be string. | Attribute |
4328 | getSchoolRequestChoice -> organisationID | Not Authorized | Attribute |
4340 | getSchoolRequestChoice -> portal | Missing | Object |
4348 | getSchoolRequestChoice -> portal | Not Authorized | Object |
4682 | loginHeader -> password | Value is too long. (Max 64) | Attribute |
4685 | loginHeader -> password | Incorrect type. Must be string. | Attribute |
4688 | loginHeader -> password | Not Authorized | Attribute |
4702 | loginHeader -> username | Value is too long. (Max 100) | Attribute |
4705 | loginHeader -> username | Incorrect type. Must be string. | Attribute |
4708 | loginHeader -> username | Not Authorized | Attribute |
4740 | mergePersonRequest -> fromDistributorPersonID | Missing | Attribute |
4742 | mergePersonRequest -> fromDistributorPersonID | Value is too long. (Max 20) | Attribute |
4745 | mergePersonRequest -> fromDistributorPersonID | Incorrect type. Must be string. | Attribute |
4747 | mergePersonRequest -> fromDistributorPersonID | Not found | Attribute |
4748 | mergePersonRequest -> fromDistributorPersonID | Not Authorized | Attribute |
4760 | mergePersonRequest -> toDistributorPersonID | Missing | Attribute |
4762 | mergePersonRequest -> toDistributorPersonID | Value is too long. (Max 20) | Attribute |
4765 | mergePersonRequest -> toDistributorPersonID | Incorrect type. Must be string. | Attribute |
4767 | mergePersonRequest -> toDistributorPersonID | Not found | Attribute |
4768 | mergePersonRequest -> toDistributorPersonID | Not Authorized | Attribute |
4780 | person -> countryCode | Missing | Attribute |
4784 | person -> countryCode | Value is not allowed | Attribute |
4786 | person -> countryCode | Already exists | Attribute |
4787 | person -> countryCode | Not found | Attribute |
4788 | person -> countryCode | Not Authorized | Attribute |
4803 | person -> dateOfBirth | Incorrect format. (yyyy-mm-dd) | Attribute |
4806 | person -> dateOfBirth | Already exists | Attribute |
4807 | person -> dateOfBirth | Not found | Attribute |
4808 | person -> dateOfBirth | Not Authorized | Attribute |
4826 | person -> distributorPerson | Already exists | Object |
4827 | person -> distributorPerson | Not found | Object |
4828 | person -> distributorPerson | Not Authorized | Object |
4842 | person -> email | Value is too long. (Max 254) | Attribute |
4845 | person -> email | Incorrect type. Must be string. | Attribute |
4846 | person -> email | Already exists | Attribute |
4847 | person -> email | Not found | Attribute |
4848 | person -> email | Not Authorized | Attribute |
4860 | person -> firstName | Missing | Attribute |
4862 | person -> firstName | Value is too long. (Max 50) | Attribute |
4865 | person -> firstName | Incorrect type. Must be string. | Attribute |
4866 | person -> firstName | Already exists | Attribute |
4867 | person -> firstName | Not found | Attribute |
4868 | person -> firstName | Not Authorized | Attribute |
4884 | person -> gender | Value is not allowed | Attribute |
4886 | person -> gender | Already exists | Attribute |
4887 | person -> gender | Not found | Attribute |
4888 | person -> gender | Not Authorized | Attribute |
4901 | person -> houseNumber | Value is too small. (Min 1) | Attribute |
4905 | person -> houseNumber | Incorrect type. Must be integer. | Attribute |
4906 | person -> houseNumber | Already exists | Attribute |
4907 | person -> houseNumber | Not found | Attribute |
4908 | person -> houseNumber | Not Authorized | Attribute |
4920 | person -> personState | Missing | Attribute |
4924 | person -> personState | Value is not allowed | Attribute |
4926 | person -> personState | Already exists | Attribute |
4927 | person -> personState | Not found | Attribute |
4928 | person -> personState | Not Authorized | Attribute |
4960 | person -> postalCode | Missing | Attribute |
4962 | person -> postalCode | Value is too long. (Max 10) | Attribute |
4965 | person -> postalCode | Incorrect type. Must be string. | Attribute |
4966 | person -> postalCode | Already exists | Attribute |
4967 | person -> postalCode | Not found | Attribute |
4968 | person -> postalCode | Not Authorized | Attribute |
4982 | person -> preposition | Value is too long. (Max 15) | Attribute |
4985 | person -> preposition | Incorrect type. Must be string. | Attribute |
4986 | person -> preposition | Already exists | Attribute |
4987 | person -> preposition | Not found | Attribute |
4988 | person -> preposition | Not Authorized | Attribute |
5001 | person -> profileID | Value is too small. (Min 1) | Attribute |
5005 | person -> profileID | Incorrect type. Must be integer. | Attribute |
5006 | person -> profileID | Already exists | Attribute |
5007 | person -> profileID | Not found | Attribute |
5008 | person -> profileID | Not Authorized | Attribute |
5020 | person -> surname | Missing | Attribute |
5022 | person -> surname | Value is too long. (Max 50) | Attribute |
5025 | person -> surname | Incorrect type. Must be string. | Attribute |
5026 | person -> surname | Already exists | Attribute |
5027 | person -> surname | Not found | Attribute |
5028 | person -> surname | Not Authorized | Attribute |
5240 | personInformation -> person | Missing | Object |
5247 | personInformation -> person | Not found | Object |
5248 | personInformation -> person | Not Authorized | Object |
5260 | portal -> hubID | Missing | Attribute |
5264 | portal -> hubID | Value is not allowed | Attribute |
5267 | portal -> hubID | Not found | Attribute |
5268 | portal -> hubID | Not Authorized | Attribute |
5280 | portal -> portalID | Missing | Attribute |
5282 | portal -> portalID | Value is too long. (Max 64) | Attribute |
5285 | portal -> portalID | Incorrect type. Must be string. | Attribute |
5287 | portal -> portalID | Not found | Attribute |
5288 | portal -> portalID | Not Authorized | Attribute |
6162 | school -> address | Value is too long. (Max 50) | Attribute |
6165 | school -> address | Incorrect type. Must be string. | Attribute |
6167 | school -> address | Not found | Attribute |
6168 | school -> address | Not Authorized | Attribute |
6182 | school -> brin | Value is too long. (Max 6) | Attribute |
6183 | school -> brin | Wrong Format: [0-9a-zA-Z]{4}([0-9]{2})? | Attribute |
6185 | school -> brin | Incorrect type. Must be string. | Attribute |
6187 | school -> brin | Not found | Attribute |
6188 | school -> brin | Not Authorized | Attribute |
6202 | school -> city | Value is too long. (Max 50) | Attribute |
6205 | school -> city | Incorrect type. Must be string. | Attribute |
6207 | school -> city | Not found | Attribute |
6208 | school -> city | Not Authorized | Attribute |
6220 | school -> countryCode | Missing | Attribute |
6224 | school -> countryCode | Value is not allowed | Attribute |
6227 | school -> countryCode | Not found | Attribute |
6228 | school -> countryCode | Not Authorized | Attribute |
6260 | school -> organisationID | Missing | Attribute |
6261 | school -> organisationID | Value is too small. (Min 1) | Attribute |
6262 | school -> organisationID | Value is too long. (Max 40) | Attribute |
6265 | school -> organisationID | Incorrect type. Must be string. | Attribute |
6267 | school -> organisationID | Not found | Attribute |
6268 | school -> organisationID | Not Authorized | Attribute |
6281 | school -> houseNumber | Value is too small. (Min 1) | Attribute |
6285 | school -> houseNumber | Incorrect type. Must be integer. | Attribute |
6287 | school -> houseNumber | Not found | Attribute |
6288 | school -> houseNumber | Not Authorized | Attribute |
6302 | school -> houseNumberSuffix | Value is too long. (Max 10) | Attribute |
6305 | school -> houseNumberSuffix | Incorrect type. Must be string. | Attribute |
6307 | school -> houseNumberSuffix | Not found | Attribute |
6308 | school -> houseNumberSuffix | Not Authorized | Attribute |
6320 | school -> name | Missing | Attribute |
6322 | school -> name | Value is too long. (Max 50) | Attribute |
6325 | school -> name | Incorrect type. Must be string. | Attribute |
6327 | school -> name | Not found | Attribute |
6328 | school -> name | Not Authorized | Attribute |
6342 | school -> postalCode | Value is too long. (Max 10) | Attribute |
6345 | school -> postalCode | Incorrect type. Must be string. | Attribute |
6347 | school -> postalCode | Not found | Attribute |
6348 | school -> postalCode | Not Authorized | Attribute |
6660 | schoolInformation -> school | Missing | Object |
6667 | schoolInformation -> school | Not found | Object |
6668 | schoolInformation -> school | Not Authorized | Object |
6700 | schoolperson -> distributorPersonID | Missing | Attribute |
6702 | schoolperson -> distributorPersonID | Value is too long. (Max 256) | Attribute |
6705 | schoolperson -> distributorPersonID | Incorrect type. Must be string. | Attribute |
6706 | schoolperson -> distributorPersonID | Already exists | Attribute |
6707 | schoolperson -> distributorPersonID | Not found | Attribute |
6708 | schoolperson -> distributorPersonID | Not Authorized | Attribute |
6720 | schoolperson -> organisationID | Missing | Attribute |
6721 | schoolperson -> organisationID | Value is too small. (Min 1) | Attribute |
6722 | schoolperson -> organisationID | Value is too long. (Max 40) | Attribute |
6725 | schoolperson -> organisationID | Incorrect type. Must be string. | Attribute |
6726 | schoolperson -> organisationID | Already exists | Attribute |
6727 | schoolperson -> organisationID | Not found | Attribute |
6728 | schoolperson -> organisationID | Not Authorized | Attribute |
6740 | schoolperson -> distributorSchoolPersonID | Missing | Attribute |
6742 | schoolperson -> distributorSchoolPersonID | Value is too long. (Max 256) | Attribute |
6745 | schoolperson -> distributorSchoolPersonID | Incorrect type. Must be string. | Attribute |
6746 | schoolperson -> distributorSchoolPersonID | Already exists | Attribute |
6747 | schoolperson -> distributorSchoolPersonID | Not found | Attribute |
6748 | schoolperson -> distributorSchoolPersonID | Not Authorized | Attribute |
6760 | schoolperson -> role | Missing | Attribute |
6764 | schoolperson -> role | Value is not allowed | Attribute |
6766 | schoolperson -> role | Already exists | Attribute |
6767 | schoolperson -> role | Not found | Attribute |
6768 | schoolperson -> role | Not Authorized | Attribute |
6782 | schoolperson -> schoolStudentNumber | Value is too long. (Max 64) | Attribute |
6785 | schoolperson -> schoolStudentNumber | Incorrect type. Must be string. | Attribute |
6786 | schoolperson -> schoolStudentNumber | Already exists | Attribute |
6787 | schoolperson -> schoolStudentNumber | Not found | Attribute |
6788 | schoolperson -> schoolStudentNumber | Not Authorized | Attribute |
6800 | schoolPersonInformation -> schoolperson | Missing | Object |
6807 | schoolPersonInformation -> schoolperson | Not found | Object |
6808 | schoolPersonInformation -> schoolperson | Not Authorized | Object |
6860 | sessionIDHeader -> sessionID | Missing | Attribute |
6862 | sessionIDHeader -> sessionID | Value is too long. (Max 64) | Attribute |
6865 | sessionIDHeader -> sessionID | Incorrect type. Must be string. | Attribute |
6868 | sessionIDHeader -> sessionID | Not Authorized | Attribute |
7320 | updatePersonIDRequest -> fromDistributorPersonID | Missing | Attribute |
7322 | updatePersonIDRequest -> fromDistributorPersonID | Value is too long. (Max 20) | Attribute |
7325 | updatePersonIDRequest -> fromDistributorPersonID | Incorrect type. Must be string. | Attribute |
7327 | updatePersonIDRequest -> fromDistributorPersonID | Not found | Attribute |
7328 | updatePersonIDRequest -> fromDistributorPersonID | Not Authorized | Attribute |
7340 | updatePersonIDRequest -> toDistributorPersonID | Missing | Attribute |
7342 | updatePersonIDRequest -> toDistributorPersonID | Value is too long. (Max 20) | Attribute |
7345 | updatePersonIDRequest -> toDistributorPersonID | Incorrect type. Must be string. | Attribute |
7347 | updatePersonIDRequest -> toDistributorPersonID | Not found | Attribute |
7348 | updatePersonIDRequest -> toDistributorPersonID | Not Authorized | Attribute |
7360 | updatePersonRequest -> person | Missing | Object |
7367 | updatePersonRequest -> person | Not found | Object |
7368 | updatePersonRequest -> person | Not Authorized | Object |
7440 | updateSchoolpersonRequest -> schoolperson | Missing | Object |
7447 | updateSchoolpersonRequest -> schoolperson | Not found | Object |
7448 | updateSchoolpersonRequest -> schoolperson | Not Authorized | Object |
7607 | personInformation -> schoolperson | Not found | Object |
7608 | personInformation -> schoolperson | Not Authorized | Object |
7701 | person -> eckID | Value is too small. (Min 128) | Attribute |
7702 | person -> eckID | Value is too long. (Max 128) | Attribute |
7705 | person -> eckID | Incorrect type. Must be string. | Attribute |
7706 | person -> eckID | Already exists | Attribute |
7707 | person -> eckID | Not found | Attribute |
7708 | person -> eckID | Not Authorized | Attribute |
7720 | getPersonRequestChoice -> eckID | Missing | Attribute |
7721 | getPersonRequestChoice -> eckID | Value is too small. (Min 128) | Attribute |
7722 | getPersonRequestChoice -> eckID | Value is too long. (Max 128) | Attribute |
7725 | getPersonRequestChoice -> eckID | Incorrect type. Must be string. | Attribute |
7728 | getPersonRequestChoice -> eckID | Not Authorized | Attribute |
7820 | getPersonRequestChoice -> userID | Missing | Attribute |
7822 | getPersonRequestChoice -> userID | Value is too long. (Max 100) | Attribute |
7825 | getPersonRequestChoice -> userID | Incorrect type. Must be string. | Attribute |
7828 | getPersonRequestChoice -> userID | Not Authorized | Attribute |
7842 | person -> userID | Value is too long. (Max 100) | Attribute |
7845 | person -> userID | Incorrect type. Must be string. | Attribute |
7846 | person -> userID | Already exists | Attribute |
7847 | person -> userID | Not found | Attribute |
7848 | person -> userID | Not Authorized | Attribute |
Credit service
WSDL | Endpoint | |
---|---|---|
Production | https://distributor.edu-ix.nl/soap/4.1/credit/wsdl | https://distributor.edu-ix.nl/soap/4.1/credit |
Sandbox | https://acc-distributor.edu-ix.nl/soap/4.1/credit/wsdl | https://acc-distributor.edu-ix.nl/soap/4.1/credit |
Login on the credit-service to retrieve a session ID for further use.
Header | [loginHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
loginRequest
|
||||||||
Response |
loginResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Create | ||||||||
Role(s) | This function is not limited to specific roles. | ||||||||
Errors |
Create a personcredit
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
createPersonCreditRequest
|
||||||||
Response |
createPersonCreditResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Create | ||||||||
Role(s) |
|
||||||||
Errors |
Retrieve zero or more personcredit.
Header | [authHeader Object] | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
getPersonCreditRequest
|
||||||||||||||||||||||||||||||||||||||||
Response |
getPersonCreditResponse
|
||||||||||||||||||||||||||||||||||||||||
Fault | [Fault Object] | ||||||||||||||||||||||||||||||||||||||||
CRUD | Read | ||||||||||||||||||||||||||||||||||||||||
Role(s) |
|
||||||||||||||||||||||||||||||||||||||||
Errors |
Update a personcredit.
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
updatePersonCreditRequest
|
||||||||
Response |
updatePersonCreditResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Update | ||||||||
Role(s) |
|
||||||||
Errors |
Create a schoolcredit.
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
createSchoolCreditRequest
|
||||||||
Response |
createSchoolCreditResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Create | ||||||||
Role(s) |
|
||||||||
Errors |
Retrieve zero or more schoolcredits.
Header | [authHeader Object] | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
getSchoolCreditRequest
|
||||||||||||||||||||||||||||||||||||||||
Response |
getSchoolCreditResponse
|
||||||||||||||||||||||||||||||||||||||||
Fault | [Fault Object] | ||||||||||||||||||||||||||||||||||||||||
CRUD | Read | ||||||||||||||||||||||||||||||||||||||||
Role(s) |
|
||||||||||||||||||||||||||||||||||||||||
Errors |
Update an existing schoolcredit.
Header | [sessionIDHeader Object] | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request |
updateSchoolCreditRequest
|
||||||||
Response |
updateSchoolCreditResponse
|
||||||||
Fault | [Fault Object] | ||||||||
CRUD | Update | ||||||||
Role(s) |
|
||||||||
Errors |
Return a credit
Header | [sessionIDHeader Object] | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
returnCreditRequest
|
||||||||||||||||||||||||||||||||
Response |
returnCreditResponse
|
||||||||||||||||||||||||||||||||
Fault | [Fault Object] | ||||||||||||||||||||||||||||||||
CRUD | Update | ||||||||||||||||||||||||||||||||
Role(s) |
|
||||||||||||||||||||||||||||||||
Errors |
In case of an error in the server or application, a Fault-element will be returned, containing more detailed information.
Element | Description | Type | Card. |
---|---|---|---|
code | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. | Attr | [1..1] |
message | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. | Attr | [1..1] |
Header for authentication. It can contain either a loginHeader-element or a sessionIDHeader-element
Element | Description | Type | Card. |
---|---|---|---|
Choose from the following elements: | [1..1] | ||
loginHeader | Header object for authentication with username and password | Obj | [1..1] |
or | |||
sessionIDHeader | Header object for authentication with a session ID. | Obj | [1..1] |
Unique identifier of a person at a distributor.
Element | Description | Type | Card. |
---|---|---|---|
distributorID | Unique identifier for a distributor | Attr | [1..1] |
distributorPersonID | Unique person identifier from the administration of the distributor | Attr | [1..1] |
Unique identifier of a personCredit
Element | Description | Type | Card. |
---|---|---|---|
distributorID | Unique identifier for a distributor | Attr | [1..1] |
distributorPersonCreditID | The unique identifier from a distributor for a personcredit | Attr | [1..1] |
Unique identifier object o a schoolCredit
Element | Description | Type | Card. |
---|---|---|---|
distributorID | Unique identifier for a distributor | Attr | [1..1] |
distributorSchoolCreditID | Unique identifier from a distributor for a schoolcredit | Attr | [1..1] |
Header object for authentication with username and password
Element | Description | Type | Card. |
---|---|---|---|
username | Username for authentication on a service | Attr | [0..1] |
password | Password for authentication access to service | Attr | [0..1] |
A personcredit is an entity that contains credit information on a product for a individual person.
Element | Description | Type | Card. |
---|---|---|---|
distributorPersonCreditID | The unique identifier from a distributor for a personcredit | Attr | [1..1] |
distributorSchoolPersonID | Unique schoolperson identifier of distributor | Attr | [1..1] |
ean | EAN, following the EAN-13 standard | Attr | [1..1] |
creditStartDate | The date from which the credit will be available. | Attr | [1..1] |
creditEndDate | The date until which the personcredit will be available. | Attr | [0..1] |
personProductState | State of a personcredit entity. The state Returned can never be changed by the create or update functions. This state wil be set by the returnCredit-function. | Attr | [1..1] |
schoolYear | A representation of a school year | Attr | [1..1] |
A object containing all information about a personCredit.
Element | Description | Type | Card. |
---|---|---|---|
personCredit | A personcredit is an entity that contains credit information on a product for a individual person. | Obj | [1..1] |
specification | Information about the specification of a credit. | Obj | [0..1] |
Unique identifier of a portal
Element | Description | Type | Card. |
---|---|---|---|
hubID | Unique identifier for a portal hub | Attr | [1..1] |
portalID | Unique identifier for a school portal | Attr | [1..1] |
A schoolCredit is an entity that contains credit information on a product available to all users of a school.
Element | Description | Type | Card. |
---|---|---|---|
distributorSchoolCreditID | Unique identifier from a distributor for a schoolcredit | Attr | [1..1] |
organisationID | Org id | Attr | [1..1] |
ean | EAN, following the EAN-13 standard | Attr | [1..1] |
creditStartDate | The date from which the credit will be available. | Attr | [1..1] |
creditEndDate | The date until which the personcredit will be available. | Attr | [0..1] |
contactName | Name of a contactperson | Attr | [1..1] |
contactEmail | Emailaddress of a contact | Attr | [1..1] |
schoolYear | A representation of a school year | Attr | [1..1] |
amount | Amount of the entity | Attr | [1..1] |
Information about a schoolCredit.
Element | Description | Type | Card. |
---|---|---|---|
schoolCredit | A schoolCredit is an entity that contains credit information on a product available to all users of a school. | Obj | [1..1] |
returned | The returned amount | Attr | [0..1] |
specification | Information about the specification of a credit. | Obj | [0..1] |
Header object for authentication with a session ID.
Element | Description | Type | Card. |
---|---|---|---|
sessionID | Unique batch session identifier | Attr | [1..1] |
Information about the specification of a credit.
Element | Description | Type | Card. |
---|---|---|---|
specificationState | The state of the specification of a credit. | Attr | [1..1] |
specificationStateDate | The date on which the specificationState was set. | Attr | [1..1] |
Attribute | Length | Type | Description |
---|---|---|---|
amount | 10 | integer | Amount of the entity |
code | 10 | integer | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. |
contactEmail | 254 | string | Emailaddress of a contact |
contactName | 50 | string | Name of a contactperson |
creditEndDate | date |
The date until which the personcredit will be available. format: [YYYY]-[MM]-[DD] |
|
creditStartDate | date |
The date from which the credit will be available. format: [YYYY]-[MM]-[DD] |
|
distributorID | 10 | integer | Unique identifier for a distributor |
distributorPersonCreditID | 160 | string | The unique identifier from a distributor for a personcredit |
distributorPersonID | 256 | string | Unique person identifier from the administration of the distributor |
distributorSchoolCreditID | 160 | string | Unique identifier from a distributor for a schoolcredit |
distributorSchoolPersonID | 256 | string | Unique schoolperson identifier of distributor |
ean | 30 | string | EAN, following the EAN-13 standard |
eckID | 128 | string | EckId, The derived ECK ID. |
hubID | 10 | enum |
Unique identifier for a portal hub possible values: Eduroute, Kennisnet, DAF |
message | 4096 | string | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. |
organisationID | 40 | string | Org id |
password | 64 | string | Password for authentication access to service |
personProductState | enum |
State of a personcredit entity. The state Returned can never be changed by the create or update functions. This state wil be set by the returnCredit-function. possible values: Active, Returned |
|
portalID | 64 | string | Unique identifier for a school portal |
returnCreditReferenceId | 64 | string | Unique ID to identify a returnCredit action |
returned | 10 | integer | The returned amount |
schoolYear | 4 | integer |
A representation of a school year rules: When substracting the first group of two numbers from the second group of two numbers, the result should be "1". |
sessionID | 64 | string | Unique batch session identifier |
specificationState | 1 | enum |
The state of the specification of a credit. possible values: Fault, Specified |
specificationStateDate | date |
The date on which the specificationState was set. format: [YYYY]-[MM]-[DD] |
|
username | 100 | string | Username for authentication on a service |
Code | Field | Description | Type |
---|---|---|---|
1 | (all) | General error | Service |
2 | (all) | Authentication error | Service |
3 | (all) | Database error | Service |
4 | (all) | Record already exists | Service |
5 | (all) | Record not found | Service |
6 | (all) | Incorrect request | Service |
7 | (all) | Search error | Service |
8 | (all) | Too many results | Service |
9 | (all) | You are not authorized to edit this record | Service |
10 | (all) | Not implemented | Service |
11 | (all) | Record locked | Service |
12 | (all) | Session expired | Service |
2200 | authHeader -> (choice element) | Missing | Object |
2208 | authHeader -> (choice element) | Not Authorized | Object |
2220 | authHeaderChoice -> loginHeader | Missing | Object |
2228 | authHeaderChoice -> loginHeader | Not Authorized | Object |
2240 | authHeaderChoice -> sessionIDHeader | Missing | Object |
2248 | authHeaderChoice -> sessionIDHeader | Not Authorized | Object |
2600 | createPersonCreditRequest -> personCredit | Missing | Object |
2606 | createPersonCreditRequest -> personCredit | Already exists | Object |
2608 | createPersonCreditRequest -> personCredit | Not Authorized | Object |
2780 | createSchoolCreditRequest -> schoolCredit | Missing | Object |
2786 | createSchoolCreditRequest -> schoolCredit | Already exists | Object |
2788 | createSchoolCreditRequest -> schoolCredit | Not Authorized | Object |
3020 | distributorPerson -> distributorID | Missing | Attribute |
3025 | distributorPerson -> distributorID | Incorrect type. Must be integer. | Attribute |
3027 | distributorPerson -> distributorID | Not found | Attribute |
3028 | distributorPerson -> distributorID | Not Authorized | Attribute |
3040 | distributorPerson -> distributorPersonID | Missing | Attribute |
3042 | distributorPerson -> distributorPersonID | Value is too long. (Max 256) | Attribute |
3045 | distributorPerson -> distributorPersonID | Incorrect type. Must be string. | Attribute |
3047 | distributorPerson -> distributorPersonID | Not found | Attribute |
3048 | distributorPerson -> distributorPersonID | Not Authorized | Attribute |
3060 | distributorPersonCredit -> distributorID | Missing | Attribute |
3065 | distributorPersonCredit -> distributorID | Incorrect type. Must be integer. | Attribute |
3067 | distributorPersonCredit -> distributorID | Not found | Attribute |
3068 | distributorPersonCredit -> distributorID | Not Authorized | Attribute |
3080 | distributorPersonCredit -> distributorPersonCreditID | Missing | Attribute |
3082 | distributorPersonCredit -> distributorPersonCreditID | Value is too long. (Max 160) | Attribute |
3085 | distributorPersonCredit -> distributorPersonCreditID | Incorrect type. Must be string. | Attribute |
3087 | distributorPersonCredit -> distributorPersonCreditID | Not found | Attribute |
3088 | distributorPersonCredit -> distributorPersonCreditID | Not Authorized | Attribute |
3140 | distributorSchoolCredit -> distributorID | Missing | Attribute |
3145 | distributorSchoolCredit -> distributorID | Incorrect type. Must be integer. | Attribute |
3147 | distributorSchoolCredit -> distributorID | Not found | Attribute |
3148 | distributorSchoolCredit -> distributorID | Not Authorized | Attribute |
3160 | distributorSchoolCredit -> distributorSchoolCreditID | Missing | Attribute |
3162 | distributorSchoolCredit -> distributorSchoolCreditID | Value is too long. (Max 160) | Attribute |
3165 | distributorSchoolCredit -> distributorSchoolCreditID | Incorrect type. Must be string. | Attribute |
3167 | distributorSchoolCredit -> distributorSchoolCreditID | Not found | Attribute |
3168 | distributorSchoolCredit -> distributorSchoolCreditID | Not Authorized | Attribute |
3340 | Fault -> code | Missing | Attribute |
3345 | Fault -> code | Incorrect type. Must be integer. | Attribute |
3346 | Fault -> code | Already exists | Attribute |
3347 | Fault -> code | Not found | Attribute |
3348 | Fault -> code | Not Authorized | Attribute |
3360 | Fault -> message | Missing | Attribute |
3362 | Fault -> message | Value is too long. (Max 4096) | Attribute |
3365 | Fault -> message | Incorrect type. Must be string. | Attribute |
3366 | Fault -> message | Already exists | Attribute |
3367 | Fault -> message | Not found | Attribute |
3368 | Fault -> message | Not Authorized | Attribute |
3642 | getPersonCreditRequest -> ean | Value is too long. (Max 30) | Attribute |
3645 | getPersonCreditRequest -> ean | Incorrect type. Must be string. | Attribute |
3647 | getPersonCreditRequest -> ean | Not found | Attribute |
3648 | getPersonCreditRequest -> ean | Not Authorized | Attribute |
3660 | getPersonCreditRequest -> (choice element) | Missing | Object |
3667 | getPersonCreditRequest -> (choice element) | Not found | Object |
3668 | getPersonCreditRequest -> (choice element) | Not Authorized | Object |
3685 | getPersonCreditRequest -> schoolYear | Incorrect type. Must be integer. | Attribute |
3687 | getPersonCreditRequest -> schoolYear | Not found | Attribute |
3688 | getPersonCreditRequest -> schoolYear | Not Authorized | Attribute |
3700 | getPersonCreditRequestChoice -> distributorPerson | Missing | Object |
3708 | getPersonCreditRequestChoice -> distributorPerson | Not Authorized | Object |
3720 | getPersonCreditRequestChoice -> distributorPersonCredit | Missing | Object |
3728 | getPersonCreditRequestChoice -> distributorPersonCredit | Not Authorized | Object |
4122 | getSchoolCreditRequest -> ean | Value is too long. (Max 30) | Attribute |
4125 | getSchoolCreditRequest -> ean | Incorrect type. Must be string. | Attribute |
4127 | getSchoolCreditRequest -> ean | Not found | Attribute |
4128 | getSchoolCreditRequest -> ean | Not Authorized | Attribute |
4140 | getSchoolCreditRequest -> (choice element) | Missing | Object |
4147 | getSchoolCreditRequest -> (choice element) | Not found | Object |
4148 | getSchoolCreditRequest -> (choice element) | Not Authorized | Object |
4165 | getSchoolCreditRequest -> schoolYear | Incorrect type. Must be integer. | Attribute |
4167 | getSchoolCreditRequest -> schoolYear | Not found | Attribute |
4168 | getSchoolCreditRequest -> schoolYear | Not Authorized | Attribute |
4180 | getSchoolCreditRequestChoice -> organisationID | Missing | Attribute |
4181 | getSchoolCreditRequestChoice -> organisationID | Value is too small. (Min 1) | Attribute |
4182 | getSchoolCreditRequestChoice -> organisationID | Value is too long. (Max 40) | Attribute |
4185 | getSchoolCreditRequestChoice -> organisationID | Incorrect type. Must be string. | Attribute |
4188 | getSchoolCreditRequestChoice -> organisationID | Not Authorized | Attribute |
4200 | getSchoolCreditRequestChoice -> distributorSchoolCredit | Missing | Object |
4208 | getSchoolCreditRequestChoice -> distributorSchoolCredit | Not Authorized | Object |
4220 | getSchoolCreditRequestChoice -> portal | Missing | Object |
4228 | getSchoolCreditRequestChoice -> portal | Not Authorized | Object |
4682 | loginHeader -> password | Value is too long. (Max 64) | Attribute |
4685 | loginHeader -> password | Incorrect type. Must be string. | Attribute |
4688 | loginHeader -> password | Not Authorized | Attribute |
4702 | loginHeader -> username | Value is too long. (Max 100) | Attribute |
4705 | loginHeader -> username | Incorrect type. Must be string. | Attribute |
4708 | loginHeader -> username | Not Authorized | Attribute |
5043 | personCredit -> creditEndDate | Incorrect format. (yyyy-mm-dd) | Attribute |
5046 | personCredit -> creditEndDate | Already exists | Attribute |
5047 | personCredit -> creditEndDate | Not found | Attribute |
5048 | personCredit -> creditEndDate | Not Authorized | Attribute |
5060 | personCredit -> distributorPersonCreditID | Missing | Attribute |
5062 | personCredit -> distributorPersonCreditID | Value is too long. (Max 160) | Attribute |
5065 | personCredit -> distributorPersonCreditID | Incorrect type. Must be string. | Attribute |
5066 | personCredit -> distributorPersonCreditID | Already exists | Attribute |
5067 | personCredit -> distributorPersonCreditID | Not found | Attribute |
5068 | personCredit -> distributorPersonCreditID | Not Authorized | Attribute |
5080 | personCredit -> distributorSchoolPersonID | Missing | Attribute |
5082 | personCredit -> distributorSchoolPersonID | Value is too long. (Max 256) | Attribute |
5085 | personCredit -> distributorSchoolPersonID | Incorrect type. Must be string. | Attribute |
5086 | personCredit -> distributorSchoolPersonID | Already exists | Attribute |
5087 | personCredit -> distributorSchoolPersonID | Not found | Attribute |
5088 | personCredit -> distributorSchoolPersonID | Not Authorized | Attribute |
5100 | personCredit -> ean | Missing | Attribute |
5102 | personCredit -> ean | Value is too long. (Max 30) | Attribute |
5105 | personCredit -> ean | Incorrect type. Must be string. | Attribute |
5106 | personCredit -> ean | Already exists | Attribute |
5107 | personCredit -> ean | Not found | Attribute |
5108 | personCredit -> ean | Not Authorized | Attribute |
5120 | personCredit -> personProductState | Missing | Attribute |
5124 | personCredit -> personProductState | Value is not allowed | Attribute |
5126 | personCredit -> personProductState | Already exists | Attribute |
5127 | personCredit -> personProductState | Not found | Attribute |
5128 | personCredit -> personProductState | Not Authorized | Attribute |
5140 | personCredit -> schoolYear | Missing | Attribute |
5145 | personCredit -> schoolYear | Incorrect type. Must be integer. | Attribute |
5146 | personCredit -> schoolYear | Already exists | Attribute |
5147 | personCredit -> schoolYear | Not found | Attribute |
5148 | personCredit -> schoolYear | Not Authorized | Attribute |
5160 | personCredit -> creditStartDate | Missing | Attribute |
5163 | personCredit -> creditStartDate | Incorrect format. (yyyy-mm-dd) | Attribute |
5166 | personCredit -> creditStartDate | Already exists | Attribute |
5167 | personCredit -> creditStartDate | Not found | Attribute |
5168 | personCredit -> creditStartDate | Not Authorized | Attribute |
5200 | personCreditInformation -> personCredit | Missing | Object |
5207 | personCreditInformation -> personCredit | Not found | Object |
5208 | personCreditInformation -> personCredit | Not Authorized | Object |
5227 | personCreditInformation -> specification | Not found | Object |
5228 | personCreditInformation -> specification | Not Authorized | Object |
5260 | portal -> hubID | Missing | Attribute |
5264 | portal -> hubID | Value is not allowed | Attribute |
5267 | portal -> hubID | Not found | Attribute |
5268 | portal -> hubID | Not Authorized | Attribute |
5280 | portal -> portalID | Missing | Attribute |
5282 | portal -> portalID | Value is too long. (Max 64) | Attribute |
5285 | portal -> portalID | Incorrect type. Must be string. | Attribute |
5287 | portal -> portalID | Not found | Attribute |
5288 | portal -> portalID | Not Authorized | Attribute |
5940 | returnCreditRequest -> amount | Missing | Attribute |
5941 | returnCreditRequest -> amount | Value is too small. (Min 1) | Attribute |
5945 | returnCreditRequest -> amount | Incorrect type. Must be integer. | Attribute |
5947 | returnCreditRequest -> amount | Not found | Attribute |
5948 | returnCreditRequest -> amount | Not Authorized | Attribute |
5960 | returnCreditRequest -> (choice element) | Missing | Object |
5967 | returnCreditRequest -> (choice element) | Not found | Object |
5968 | returnCreditRequest -> (choice element) | Not Authorized | Object |
6380 | schoolCredit -> amount | Missing | Attribute |
6381 | schoolCredit -> amount | Value is too small. (Min 1) | Attribute |
6385 | schoolCredit -> amount | Incorrect type. Must be integer. | Attribute |
6386 | schoolCredit -> amount | Already exists | Attribute |
6387 | schoolCredit -> amount | Not found | Attribute |
6388 | schoolCredit -> amount | Not Authorized | Attribute |
6400 | schoolCredit -> contactEmail | Missing | Attribute |
6402 | schoolCredit -> contactEmail | Value is too long. (Max 254) | Attribute |
6405 | schoolCredit -> contactEmail | Incorrect type. Must be string. | Attribute |
6406 | schoolCredit -> contactEmail | Already exists | Attribute |
6407 | schoolCredit -> contactEmail | Not found | Attribute |
6408 | schoolCredit -> contactEmail | Not Authorized | Attribute |
6420 | schoolCredit -> contactName | Missing | Attribute |
6422 | schoolCredit -> contactName | Value is too long. (Max 50) | Attribute |
6425 | schoolCredit -> contactName | Incorrect type. Must be string. | Attribute |
6426 | schoolCredit -> contactName | Already exists | Attribute |
6427 | schoolCredit -> contactName | Not found | Attribute |
6428 | schoolCredit -> contactName | Not Authorized | Attribute |
6443 | schoolCredit -> creditEndDate | Incorrect format. (yyyy-mm-dd) | Attribute |
6446 | schoolCredit -> creditEndDate | Already exists | Attribute |
6447 | schoolCredit -> creditEndDate | Not found | Attribute |
6448 | schoolCredit -> creditEndDate | Not Authorized | Attribute |
6460 | schoolCredit -> distributorSchoolCreditID | Missing | Attribute |
6462 | schoolCredit -> distributorSchoolCreditID | Value is too long. (Max 160) | Attribute |
6465 | schoolCredit -> distributorSchoolCreditID | Incorrect type. Must be string. | Attribute |
6466 | schoolCredit -> distributorSchoolCreditID | Already exists | Attribute |
6467 | schoolCredit -> distributorSchoolCreditID | Not found | Attribute |
6468 | schoolCredit -> distributorSchoolCreditID | Not Authorized | Attribute |
6480 | schoolCredit -> organisationID | Missing | Attribute |
6481 | schoolCredit -> organisationID | Value is too small. (Min 1) | Attribute |
6482 | schoolCredit -> organisationID | Value is too long. (Max 40) | Attribute |
6485 | schoolCredit -> organisationID | Incorrect type. Must be string. | Attribute |
6486 | schoolCredit -> organisationID | Already exists | Attribute |
6487 | schoolCredit -> organisationID | Not found | Attribute |
6488 | schoolCredit -> organisationID | Not Authorized | Attribute |
6500 | schoolCredit -> ean | Missing | Attribute |
6502 | schoolCredit -> ean | Value is too long. (Max 30) | Attribute |
6505 | schoolCredit -> ean | Incorrect type. Must be string. | Attribute |
6506 | schoolCredit -> ean | Already exists | Attribute |
6507 | schoolCredit -> ean | Not found | Attribute |
6508 | schoolCredit -> ean | Not Authorized | Attribute |
6520 | schoolCredit -> schoolYear | Missing | Attribute |
6525 | schoolCredit -> schoolYear | Incorrect type. Must be integer. | Attribute |
6526 | schoolCredit -> schoolYear | Already exists | Attribute |
6527 | schoolCredit -> schoolYear | Not found | Attribute |
6528 | schoolCredit -> schoolYear | Not Authorized | Attribute |
6540 | schoolCredit -> creditStartDate | Missing | Attribute |
6543 | schoolCredit -> creditStartDate | Incorrect format. (yyyy-mm-dd) | Attribute |
6546 | schoolCredit -> creditStartDate | Already exists | Attribute |
6547 | schoolCredit -> creditStartDate | Not found | Attribute |
6548 | schoolCredit -> creditStartDate | Not Authorized | Attribute |
6581 | schoolCreditInformation -> returned | Value is too small. (Min 1) | Attribute |
6585 | schoolCreditInformation -> returned | Incorrect type. Must be integer. | Attribute |
6587 | schoolCreditInformation -> returned | Not found | Attribute |
6588 | schoolCreditInformation -> returned | Not Authorized | Attribute |
6600 | schoolCreditInformation -> schoolCredit | Missing | Object |
6607 | schoolCreditInformation -> schoolCredit | Not found | Object |
6608 | schoolCreditInformation -> schoolCredit | Not Authorized | Object |
6627 | schoolCreditInformation -> specification | Not found | Object |
6628 | schoolCreditInformation -> specification | Not Authorized | Object |
6860 | sessionIDHeader -> sessionID | Missing | Attribute |
6862 | sessionIDHeader -> sessionID | Value is too long. (Max 64) | Attribute |
6865 | sessionIDHeader -> sessionID | Incorrect type. Must be string. | Attribute |
6868 | sessionIDHeader -> sessionID | Not Authorized | Attribute |
6960 | specification -> specificationState | Missing | Attribute |
6964 | specification -> specificationState | Value is not allowed | Attribute |
6967 | specification -> specificationState | Not found | Attribute |
6968 | specification -> specificationState | Not Authorized | Attribute |
6980 | specification -> specificationStateDate | Missing | Attribute |
6983 | specification -> specificationStateDate | Incorrect format. (yyyy-mm-dd) | Attribute |
6987 | specification -> specificationStateDate | Not found | Attribute |
6988 | specification -> specificationStateDate | Not Authorized | Attribute |
7020 | specifyCreditRequestChoice -> distributorPersonCredit | Missing | Object |
7028 | specifyCreditRequestChoice -> distributorPersonCredit | Not Authorized | Object |
7040 | specifyCreditRequestChoice -> distributorSchoolCredit | Missing | Object |
7048 | specifyCreditRequestChoice -> distributorSchoolCredit | Not Authorized | Object |
7300 | updatePersonCreditRequest -> personCredit | Missing | Object |
7307 | updatePersonCreditRequest -> personCredit | Not found | Object |
7308 | updatePersonCreditRequest -> personCredit | Not Authorized | Object |
7420 | updateSchoolCreditRequest -> schoolCredit | Missing | Object |
7427 | updateSchoolCreditRequest -> schoolCredit | Not found | Object |
7428 | updateSchoolCreditRequest -> schoolCredit | Not Authorized | Object |
7520 | returnCreditRequest -> returnCreditReferenceId | Missing | Attribute |
7522 | returnCreditRequest -> returnCreditReferenceId | Value is too long. (Max 64) | Attribute |
7525 | returnCreditRequest -> returnCreditReferenceId | Incorrect type. Must be string. | Attribute |
7527 | returnCreditRequest -> returnCreditReferenceId | Not found | Attribute |
7528 | returnCreditRequest -> returnCreditReferenceId | Not Authorized | Attribute |
7620 | getPersonCreditRequestChoice -> eckID | Missing | Attribute |
7621 | getPersonCreditRequestChoice -> eckID | Value is too small. (Min 128) | Attribute |
7622 | getPersonCreditRequestChoice -> eckID | Value is too long. (Max 128) | Attribute |
7625 | getPersonCreditRequestChoice -> eckID | Incorrect type. Must be string. | Attribute |
7628 | getPersonCreditRequestChoice -> eckID | Not Authorized | Attribute |
This gives dispatches notifications on changes of credits.
WSDL | Endpoint | |
---|---|---|
Production | https://distributor.edu-ix.nl/soap/4.0/notification/wsdl | https://distributor.edu-ix.nl/soap/4.0/notification |
Sandbox | https://acc-distributor.edu-ix.nl/soap/4.0/notification/wsdl | https://acc-distributor.edu-ix.nl/soap/4.0/notification |
A notification is send when a prematch has been changed. The data represents the full state of the moment of sending.
Header | [loginHeader Object] | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
prematchChangedRequest
|
||||||||||||||||
Response |
prematchChangedResponse
|
||||||||||||||||
Fault | [Fault Object] | ||||||||||||||||
CRUD | |||||||||||||||||
Role(s) |
|
||||||||||||||||
Errors |
A notification is send when a credit has been changed. The data represents the full state of the moment of sending.
Header | [loginHeader Object] | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request |
specificationChangedRequest
|
||||||||||||||||||||
Response |
specificationChangedResponse
|
||||||||||||||||||||
Fault | [Fault Object] | ||||||||||||||||||||
CRUD | |||||||||||||||||||||
Role(s) |
|
||||||||||||||||||||
Errors |
In case of an error in the server or application, a Fault-element will be returned, containing more detailed information.
Element | Description | Type | Card. |
---|---|---|---|
code | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. | Attr | [1..1] |
message | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. | Attr | [1..1] |
An array of each correction
Element | Description | Type | Card. |
---|---|---|---|
amount | Amount of the entity | Attr | [1..1] |
responseID | The ECK response ID from the publisher of the specification | Attr | [0..1] |
errorCode | The ECK error code from the publisher when the specification could not be processed | Attr | [0..1] |
specification
Element | Description | Type | Card. |
---|---|---|---|
amount | Amount of the entity | Attr | [1..1] |
responseID | The ECK response ID from the publisher of the specification | Attr | [0..1] |
errorCode | The ECK error code from the publisher when the specification could not be processed | Attr | [0..1] |
Attribute | Length | Type | Description |
---|---|---|---|
amount | 10 | integer | Amount of the entity |
code | 10 | integer | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. |
distributorCreditID | 30 | string | distributorCreditID |
distributorPersonID | 256 | string | Unique person identifier from the administration of the distributor |
eckID | 128 | string | EckId, The derived ECK ID. |
errorCode | 10 | integer | The ECK error code from the publisher when the specification could not be processed |
message | 4096 | string | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. |
password | 64 | string | Password for authentication access to service |
responseID | 30 | string | The ECK response ID from the publisher of the specification |
state | enum |
State of the specification. Possible values: Active, Returned possible values: Active, Returned |
|
userID | 100 | string | Unique identifier for a portal user |
username | 100 | string | Username for authentication on a service |
Code | Field | Description | Type |
---|---|---|---|
1 | (all) | General error | Service |
2 | (all) | Authentication error | Service |
3 | (all) | Database error | Service |
4 | (all) | Record already exists | Service |
5 | (all) | Record not found | Service |
6 | (all) | Incorrect request | Service |
7 | (all) | Search error | Service |
8 | (all) | Too many results | Service |
9 | (all) | You are not authorized to edit this record | Service |
10 | (all) | Not implemented | Service |
11 | (all) | Record locked | Service |
12 | (all) | Session expired | Service |
3340 | Fault -> code | Missing | Attribute |
3345 | Fault -> code | Incorrect type. Must be integer. | Attribute |
3348 | Fault -> code | Not Authorized | Attribute |
3360 | Fault -> message | Missing | Attribute |
3362 | Fault -> message | Value is too long. (Max 4096) | Attribute |
3365 | Fault -> message | Incorrect type. Must be string. | Attribute |
3368 | Fault -> message | Not Authorized | Attribute |
4682 | loginHeader -> password | Value is too long. (Max 64) | Attribute |
4685 | loginHeader -> password | Incorrect type. Must be string. | Attribute |
4688 | loginHeader -> password | Not Authorized | Attribute |
4702 | loginHeader -> username | Value is too long. (Max 100) | Attribute |
4705 | loginHeader -> username | Incorrect type. Must be string. | Attribute |
4708 | loginHeader -> username | Not Authorized | Attribute |