Endpoints

Environment	URL
Production	T.b.d.https://distributor.edu-ix.nl/soap/5.1/profile
Acceptance	https://acc-distributor.edu-ix.nl/soap/5.1/profile
Test	https://test-distributor.edu-ix.nl/soap/5.1/profile

...

login
getPersons
getSchools
deletePersons
uploadPersons

Operations

Description

The login function provides you with a sessionID after execution. This sessionID can be used to execute consecutive operations with the sessionIDHeader.

...

Error code	Description
2	Authentication error

...

getPersons

Description

The getPerson operation can be used to retreive information about persons. This operation can be used either as and distributor or ELO.

...

Name

Cardinality

You have a CHOICE of the next 2 items at this level

NameTypeCardinalityloginheaderloginHeader1Name Type Cardinality

loginheader loginHeader 1...1sessionIDHeadersessionIDHeader11

sessionIDHeader sessionIDHeader 1...1

1...1

Source

Code Block

 <urn:authHeader>
    <!--You have a CHOICE of the next 2 items at this level-->
    <urn:loginHeader>
       <!--Optional:-->
       <urn:username>?</urn:username>
       <!--Optional:-->
       <urn:password>?</urn:password>
    </urn:loginHeader>
    <urn:sessionIDHeader>
       <urn:sessionID>?</urn:sessionID>
    </urn:sessionIDHeader>
 </urn:authHeader>

...

Name

Cardinality

You have a CHOICE of the next 4 items at this levelNameTypeCardinalityportalIDstring641..1profileIDprofileID1

Name Type Cardinality

portalID string64 1..1

profileID profileID 1...100distributorPersonIDstring2561100

distributorPersonID string256 1...100userIDstring2561100

userID string256 1...100

1..1

Source

Code Block

<urn:getPersonsRequest>
    <!--You have a CHOICE of the next 4 items at this level-->
    <urn:portalID>?</urn:portalID>
    <!--1 to 100 repetitions:-->
    <urn:profileID>?</urn:profileID>
    <!--1 to 100 repetitions:-->
    <urn:distributorPersonID>?</urn:distributorPersonID>
    <!--1 to 100 repetitions:-->
    <urn:userID>?</urn:userID>
 </urn:getPersonsRequest>

...

Error code	Description
4	Authorization error
6	Missing required field(s)

...

getSchools

Description

The getSchools operations outputs a list of available schools.

...

Name

Cardinality

You have a CHOICE of the next 2 items at this level

NameTypeCardinalityloginheaderloginHeader1Name Type Cardinality

loginheader loginHeader 1...1sessionIDHeadersessionIDHeader11

sessionIDHeader sessionIDHeader 1...1

1...1

Source

Code Block

 <urn:authHeader>
    <!--You have a CHOICE of the next 2 items at this level-->
    <urn:loginHeader>
       <!--Optional:-->
       <urn:username>?</urn:username>
       <!--Optional:-->
       <urn:password>?</urn:password>
    </urn:loginHeader>
    <urn:sessionIDHeader>
       <urn:sessionID>?</urn:sessionID>
    </urn:sessionIDHeader>
 </urn:authHeader>

...

Error code	Description
4	Authorization error
6	Missing required field(s)

...

deletePersons

Description

This operations allows for deletion of a person.

...

Name

Cardinality

You have a CHOICE of the next 2 items at this level

NameTypeCardinalityloginheaderloginHeader1Name Type Cardinality

loginheader loginHeader 1...1sessionIDHeadersessionIDHeader11

sessionIDHeader sessionIDHeader 1...1

1...1

Source

Code Block

 <urn:authHeader>
    <!--You have a CHOICE of the next 2 items at this level-->
    <urn:loginHeader>
       <!--Optional:-->
       <urn:username>?</urn:username>
       <!--Optional:-->
       <urn:password>?</urn:password>
    </urn:loginHeader>
    <urn:sessionIDHeader>
       <urn:sessionID>?</urn:sessionID>
    </urn:sessionIDHeader>
 </urn:authHeader>

...

Error code	Description
4	Authorization error
6	Missing required field(s)
7	Record not found

...

uploadPersons

Description

With the uploadPersons operation you have the ability to upload persons. Either a single or multiple persons can be uploaded in a single call.

...

Name

Cardinality

You have a CHOICE of the next 2 items at this level

NameTypeCardinalityloginheaderloginHeader1Name Type Cardinality

loginheader loginHeader 1...1sessionIDHeadersessionIDHeader11

sessionIDHeader sessionIDHeader 1...1

1...1

Source

Code Block

 <urn:authHeader>
    <!--You have a CHOICE of the next 2 items at this level-->
    <urn:loginHeader>
       <!--Optional:-->
       <urn:username>?</urn:username>
       <!--Optional:-->
       <urn:password>?</urn:password>
    </urn:loginHeader>
    <urn:sessionIDHeader>
       <urn:sessionID>?</urn:sessionID>
    </urn:sessionIDHeader>
 </urn:authHeader>

...

Error code	Description
4	Authorization error
6	Missing required field(s)

...

Errors

General errors

General errors may occur within every operation.

Error code	Description
0	Unkown error
1	General error This occurs in for example: database errors or internal server errors.
2	Authentication error For instance when invalid credentials are provided.
3	Login sessionID is expired The given sessionID is no longer active and has expired. Acquire a new sessionID to proceed.
4	Authorization error You do not have permission to use this operation.
5	Bad request Parsing error, for instance when invalid xml has been provided.

Specific errors

Specific errors are bound to the given input or request and depend on the operation you execute.

Error code	Description
6	Missing required field(s) One or more fields are missing within the request. In case of a choice-element at least one value must be given.
7	Record not found A given value was not found.
8	Record cannot be changed Some functions are idempotent and therefor values cannot be altered within a second request.
9	Process validation error The given request does not meet the process constraints

...

Complex types

person

Name

Type

Cardinality

Description

profileID

1...1

Unique identifier generated by Edu-iX.

distributorPersonID

string256

0...1

Unique identifier of the person to which this credit is connected.

firstName

string50

1...1

First name of the person

preposition

string15

0...1

Preposition of the person

surname

string50

1...1

Surname of the person

postalCode

1...1

In case of a dutch postal code a regex check is applied.

houseNumber

0...1

Housenumber

gender

0...1

The person his gender

dateOfBirth

0...1

Date of birt of the person

countryCode

1...1

Country code in which the person lives

userID

string256

0...1

Unique identification of the end user. This value is also known as the prematch value.

Source

Code Block

<xs:complexType name="person">
 <xs:sequence>
    <xs:element name="profileID" type="types:profileID" minOccurs="1" maxOccurs="1"/>
    <xs:element name="distributorPersonID" type="types:string256" minOccurs="0" maxOccurs="1"/>
    <xs:element name="firstName" type="types:string50" minOccurs="1" maxOccurs="1"/>
    <xs:element name="preposition" type="types:string15" minOccurs="0" maxOccurs="1"/>
    <xs:element name="surname" type="types:string50" minOccurs="1" maxOccurs="1"/>
    <xs:element name="postalCode" type="types:postalCode" minOccurs="1" maxOccurs="1"/>
    <xs:element name="houseNumber" type="types:houseNumber" minOccurs="0" maxOccurs="1"/>
    <xs:element name="gender" type="types:gender" minOccurs="0" maxOccurs="1"/>
    <xs:element name="dateOfBirth" type="types:dateOfBirth" minOccurs="0" maxOccurs="1"/>
    <xs:element name="countryCode" type="types:countryCode" minOccurs="1" maxOccurs="1"/>
    <xs:element name="userID" type="types:string256" minOccurs="0" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

uploadPerson

Name

Type

Cardinality

Description

distributorPersonID

string256

1...1

Unique identifier of the person to which this credit is connected.

firstName

string50

1...1

First name of the person

prepostion

string15

0...1

Preposition of the person

surname

string50

1...1

Surname of the person

postalCode

1...1

In case of a dutch postal code a regex check is applied.

houseNumber

0...1

Housenumber

gender

0...1

The person his gender

dateOfBirth

0...1

Date of birt of the person

countryCode

1...1

Country code in which the person lives

Source

Code Block

<xs:complexType name="uploadPerson">
 <xs:sequence>
    <xs:element name="distributorPersonID" type="types:string256" minOccurs="1" maxOccurs="1"/>
    <xs:element name="firstName" type="types:string50" minOccurs="1" maxOccurs="1"/>
    <xs:element name="preposition" type="types:string15" minOccurs="0" maxOccurs="1"/>
    <xs:element name="surname" type="types:string50" minOccurs="1" maxOccurs="1"/>
    <xs:element name="postalCode" type="types:postalCode" minOccurs="1" maxOccurs="1"/>
    <xs:element name="houseNumber" type="types:houseNumber" minOccurs="0" maxOccurs="1"/>
    <xs:element name="gender" type="types:gender" minOccurs="0" maxOccurs="1"/>
    <xs:element name="dateOfBirth" type="types:dateOfBirth" minOccurs="0" maxOccurs="1"/>
    <xs:element name="countryCode" type="types:countryCode" minOccurs="1" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

loginHeader

Name

Type

Cardinality

Description

username

string100

0...1

An identification used by a person to login.

password

string64

0...1

A secret word or phrase used for authentication.

Source

Code Block

<xs:complexType name="loginHeader">
 <xs:sequence>
    <xs:element name="username" type="types:string100" minOccurs="0" maxOccurs="1"/>
    <xs:element name="password" type="types:string64" minOccurs="0" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

school

Source

code

Name

Type

Cardinality

Description

organisationID

1...1

Unique identifier of the school to which this credit is connected.

name

string100

1...1

Name of the school.

street

string50

0...1

Street address of the school.

houseNumber

0...1

Street number of the school.

houseNumberAddition

string10

0...1

Street number addition of the school.

postalCode

0...1

Postal code of the school.

city

string50

0...1

City in which the school is located.

countryCode

1...1

Country in which the school is located.

brin

string10

0...1

countryCode

1...1

brin

string10

0...1

...1

The BRIN(Basisregistratie instellingen) is an identifier. The first four characters are alphanumerical and represent an educational institution. The last characters are numerical and represent an identifier for the location of a educational institution.

Source

Code Block

<xs:complexType name="school">
      <xs:sequence>
         <xs:element name="organisationID" type="types:organisationID" minOccurs="1" maxOccurs="1" />
         <xs:element name="name" type="types:string100" minOccurs="1" maxOccurs="1" />
         <xs:element name="street" type="types:string50" minOccurs="0" maxOccurs="1" />
         <xs:element name="houseNumber" type="types:houseNumber" minOccurs="0" maxOccurs="1" />
         <xs:element name="houseNumberAddition" type="types:string10" minOccurs="0" maxOccurs="1" />
         <xs:element name="postalCode" type="types:postalCode" minOccurs="0" maxOccurs="1" />
         <xs:element name="city" type="types:string50" minOccurs="0" maxOccurs="1" />
         <xs:element name="countryCode" type="types:countryCode" minOccurs="1" maxOccurs="1" />
         <xs:element name="brin" type="types:string10" minOccurs="0" maxOccurs="1" />
      </xs:sequence>
</xs:complexType>

Fault

Name

Type

Cardinality

Description

code

integer

1...1

Code to identify the fault type.

message

string

1...1

Specific message which describes the fault.

Source

Code Block

<xs:element name="Fault">
      <xs:complexType>
         <xs:sequence>
            <xs:element name="code" type="types:integer" minOccurs="1" maxOccurs="1" />
            <xs:element name="message" type="types:string" minOccurs="1" maxOccurs="1" />
         </xs:sequence>
      </xs:complexType>
</xs:element>

FaultPerPerson

Name

Type

Cardinality

Description

personFault

0...n

A collection of personFault distinguished per person.

Source

Code Block

<xs:element name="FaultPerPerson">
      <xs:complexType>
         <xs:sequence>
            <xs:element name="personFault" type="types:personFault" minOccurs="0" maxOccurs="unbounded" />
         </xs:sequence>
      </xs:complexType>
</xs:element>

personFault

Name

Type

Cardinality

Description

distributorPersonID

string256

1...1

Unique identifier of the person for whom the fault occured.

code

integer

1...1

Code to identify the fault type.

message

string

1...1

Specific message which describes the fault.

Source

Code Block

<xs:complexType name="personFault">
      <xs:sequence>
         <xs:element name="distributorPersonID" type="types:string256" minOccurs="1" maxOccurs="1" />
         <xs:element name="code" type="types:integer" minOccurs="1" maxOccurs="1" />
         <xs:element name="message" type="types:string" minOccurs="1" maxOccurs="1" />
      </xs:sequence>
</xs:complexType>

sessionIDHeader

Name

Type

Cardinality

Description

sessionID

string64

1...1

Unique token which can be acquired by executing the login operation.

Source

Code Block
<xs:complexType name="sessionIDHeader"> <xs:sequence> <xs:element name="sessionID" type="types:string64" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType>

...

Simple types

Name	Type	Possible values / format	Description
string10	String	Max length: 10 characters	String limited by a number of 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.
postalCode	String	Max length: 10 characters	In case of a dutch postal code the following regex should be applied: [0-9]{4} [A-Z]{2}
houseNumber	Integer	Minimal value must be atleast 1
countryCode	Enum	Official ISO 3166-1 alpha-2 notation of a country code
gender	Enum	Possible values: M F U	M = male, F = female & U = unspecified
dateOfBirth	Date
profileID	Integer	Minimal value must be at least 1	A profile ID is an positive integer number with maximum 10 characters.
organisationID	String	Min length: 1 character Max length: 160 characters	Unique identifier of a school

...

Versions Compared

Old Version 4

New Version 5

Key

Endpoints

Operations

Description

getPersons

Description

getSchools

Description

deletePersons

Description

uploadPersons

Description

Errors

General errors

Specific errors

Complex types

person

uploadPerson

loginHeader

school

sessionIDHeader

Simple types

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

Endpoints

Operations

login

Description

getPersons

Description

getSchools

Description

deletePersons

Description

uploadPersons

Description

Errors

General errors

Specific errors

Complex types

person

uploadPerson

loginHeader

school

sessionIDHeader

Simple types