Page Comparison

...

The following roles have access to this web service:

Role
Distributor
ELO

Operation

...

Operations

Description

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

Authorization

The following roles have access to this operation:

Role
Distributor
ELO

Authentication

...

Name

...

Type

...

Cardinality

...

loginHeader

...

loginHeader

...

authentication

All operations, except login, need either the loginHeader or the sessionIDHeader to authenticate. A sessionID can be obtained by performing the login operation beforehand.

loginHeader>Optional:--> <urn:username>?</urn:username> <!--Optional

Name

Type

Cardinality

Description

loginHeader

sessionIDHeader

loginHeader

sessionIDHeader

1...1

You can use either one of the variables

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>

Request

Empty request

Response

Name	Type	Cardinality
sessionID	string64	1...1

Error codes

...

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.

ELO

As an ELO this operation can be used to retrieve personal details for the prematch process. The element profileID, userID of portalID can be used to indicate which persons to filter.

In some occasions the school makes use of an ECK ID. The prematch process isn't required in case of an ECK ID and therefore the person objects within the response do not contain any personal details.

Authorization

The following roles have access to this operation:

Role
Distributor
ELO

Authentication

You have a choice to use either the loginHeader or the sessionIDHeader to authenticate. A sessionID can be obtained by performing the login operation on beforehand.

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

Name Type Cardinality

loginheader loginHeader 1...1

sessionIDHeader sessionIDHeader 1...1

Name

Cardinality


    <urn:sessionIDHeader>
       <urn:sessionID>?</urn:sessionID>
    </urn:sessionIDHeader>
 </urn:authHeader>

Operation overview

Operations

Description

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

Authorization

The following roles have access to this operation:

Role
Distributor
ELO

Authentication

Name

Type

Cardinality

loginHeader

1...1

Source

Code Block
<urn:loginHeader> <!--Optional:--> <urn:username>?</urn:username> <!--Optional:--> <urn:password>?</urn:password> </urn:loginHeader>

Request

Empty request

Response

Source

Name	Type	Cardinality
sessionID	string64	1...1

Error codes

Error code

 <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>

Request

Name

Cardinality

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

Name Type Cardinality

portalID string64 1..1

profileID profileID 1...100

distributorPersonID string256 1...100

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>

Response

In case of a request by multiple profileID's, distributorPersonID's or userID's the response can be partially built up when records are not found or available.

Name	Type	Cardinality
person	person	0...n

Error codes

...

Error code

...

Description

...

4

...

Authorization error

...

6

...

Missing required field(s)

getSchools

Description

The getSchools operations outputs a list of available schools.

Authorization

The following roles have access to this operation:

Role
Distributor
ELO

Authentication

You have a choice to use either the loginHeader or the sessionIDHeader to authenticate. A sessionID can be obtained by performing the login operation on beforehand.

Name

Cardinality

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

Name Type Cardinality

loginheader loginHeader 1...1

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>

Request

Name

Type

Cardinality

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

Name Type Cardinality

organisationID organisationID 1...100

portalID string64 1...1

1...1

Source

Code Block

<urn:getSchoolsRequest>
    <!--You have a CHOICE of the next 2 items at this level-->
    <!--1 to 100 repetitions:-->
    <urn:organisationID>?</urn:organisationID>
    <urn:portalID>?</urn:portalID>
 </urn:getSchoolsRequest>

Response

Name	Type	Cardinality
school	school	0...n

Error codes

...

Error code

...

Description

...

4

...

Authorization error

...

6

...

Missing required field(s)

deletePersons

Description

...

	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.

ELO

As an ELO this operation can be used to retrieve personal details for the prematch process. The element profileID, userID of portalID can be used to indicate which persons to filter.

In some occasions the school makes use of an ECK ID. The prematch process isn't required in case of an ECK ID and therefore the person objects within the response do not contain any personal details.

Authorization

The following roles have access to this operation:

Role
Distributor

Authentication

...

ELO

Request

Name

Cardinality

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

Name Type Cardinality

loginheader loginHeader portalID string64 1...1sessionIDHeader sessionIDHeader

profileID profileID 1...100

distributorPersonID string256 1...100

userID string256 1...100

1..1

Source

Code Block

 <urn:authHeader>getPersonsRequest>
    <!--You have a CHOICE of the next 24 items at this level-->
    <urn:loginHeader>
portalID>?</urn:portalID>
      <!--Optional1 to 100 repetitions:-->
       <urn:username>profileID>?</urn:username>profileID>
       <!--Optional1 to 100 repetitions:-->
       <urn:password>distributorPersonID>?</urn:password>distributorPersonID>
    </urn:loginHeader>
    <urn:sessionIDHeader>!--1 to 100 repetitions:-->
       <urn:sessionID>userID>?</urn:sessionID>
    </urn:sessionIDHeader>userID>
 </urn:authHeader>getPersonsRequest>

Request

...

Response

In case of a request by multiple profileID's, distributorPersonID's or userID's the response can be partially built up when records are not found or available.

Name

Type

Cardinality

distributorPersonID

string256

1...100

Source

Code Block
<urn:deletePersonsRequest> <!--1 to 100 repetitions:--> <urn:distributorPersonID>?</urn:distributorPersonID> </urn:deletePersonsRequest>

Response

Empty response

Error codes

...

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.

Authorization

The following roles have access to this operation:

Role
Distributor

Authentication

You have a choice to use either the loginHeader or the sessionIDHeader to authenticate. A sessionID can be obtained by performing the login operation on beforehand.

Source

<urn:authHeader>  <urn:loginHeader>  <urn:username>?</urn:username>  <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 2 items at this level Name Type Cardinality loginheader loginHeader 1...1 sessionIDHeader sessionIDHeader 1...1		1...1
Code Block
	Cardinality
person	person	0...n

Error codes

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

...

getSchools

Description

The getSchools operations outputs a list of available schools.

Authorization

The following roles have access to this operation:

Role
Distributor
ELO

Request

Name

Type

Cardinality

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

Name Type Cardinality

organisationID organisationID 1...100

portalID string64 1...1

1...1

Source

Code Block

<urn:getSchoolsRequest>
    <!--You have a CHOICE of the next 2 items at this level-->
    <!--1 to 100 repetitions:-->
    <urn:organisationID>?</urn:organisationID>
    <urn:portalID>?</urn:portalID>
 </urn:getSchoolsRequest>

Response

Name	Type	Cardinality
school	school	0...n

Error codes

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

...

deletePersons

Description

This operations allows for deletion of a person.

Authorization

The following roles have access to this operation:

Role
Distributor

Request

The request can obtain an maximum of 100 unique distributorPersonID's.

Name

Type

Cardinality

distributorPersonID

string256

1...100

Source

Code Block
<urn:deletePersonsRequest> <!--1 to 100 repetitions:--> <urn:distributorPersonID>?</urn:distributorPersonID> </urn:deletePersonsRequest>

Response

Empty response

Error codes

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.

Authorization

The following roles have access to this operation:

Role
Distributor

Request

Name

Type

Cardinality

person

uploadPerson

1...100

Source

Code Block

<urn:uploadPersonsRequest>
    <!--1 to 100 repetitions:-->
    <urn:person>
       <urn:distributorPersonID>?</urn:distributorPersonID>
       <urn:firstName>?</urn:firstName>
       <!--Optional:-->
       <urn:preposition>?</urn:preposition>
       <urn:surname>?</urn:surname>
       <urn:postalCode>?</urn:postalCode>
       <!--Optional:-->
       <urn:houseNumber>?</urn:houseNumber>
       <!--Optional:-->
       <urn:gender>?</urn:gender>
       <!--Optional:-->
       <urn:dateOfBirth>?</urn:dateOfBirth>
       <urn:countryCode>?</urn:countryCode>
    </urn:person>
 </urn:uploadPersonsRequest>

...

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

Operation

Operations

login

Description

Authorization

Authentication

authentication

Request

Response

Error codes

getPersons

Description

ELO

Authorization

Authentication

Operation overview

Operations

login

Description

Authorization

Authentication

Request

Response

Error codes

Request

Response

Error codes

getSchools

Description

Authorization

Authentication

Request

Response

Error codes

deletePersons

Description

getPersons

Description

ELO

Authorization

Authentication

Request

Request

Response

Response

Error codes

uploadPersons

Description

Authorization

Authentication

Error codes

getSchools

Description

Authorization

Request

Response

Error codes

deletePersons

Description

Authorization

Request

Response

Error codes

uploadPersons

Description

Authorization

Request