Versions Compared

Old Version 11

changes.mady.by.user André Mussche

Saved on

compared with

New Version Current

changes.mady.by.user André Mussche

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Documentation

Endpoints

...

Environment

...

URL

...

Production

...

https://distributor.edu-ix.nl/soap/4.3/account

...

Acceptance

...

https://acc-distributor.edu-ix.nl/soap/4.3/account (school year 2021-2022)

https://acc-distributor.edu-ix.nl/2022-2023/soap/4.3/account (school year 2021-2022)

*Extend the URL with /wsdl to retrieve the WSDLZie Technical documentation voor het actuele overzicht.

Authorization

The following roles have access to this web service:

Role

Distributor

ELO

Operation overview

  • createKey

  • deleteKey

  • getKey

  • login

...

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

Authentication

Name

Type

Cardinality

loginHeader

loginHeader

1...1

Source

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

...

createKey

Description

With the createKey operation you add an userID key to a profileID, which is needed to specify credits of the specific person to publishers.
Successful createKey calls return an empty response.

Authentication

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

profileID

profileID

1...1

userID

string256

1...1

Source

Code Block
<urn:createKeyRequest>
   <urn:profileID>?</urn:profileID>
   <urn:userID>?</urn:userID>
</urn:createKeyRequest>

Response

Empty response

Error codes

Error code

Description

6

Missing required fields: userID or eckID

4426

ProfileID is already prematched

4428

Not authorized to prematch this profileID

7766

userID is already prematched

...

deleteKey

Description

With the deleteKey operation you delete a key linked to an userID. Successful deleteKey calls return an empty response.

Authentication

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

userID

string256

1...1

Source

Code Block
<urn:deleteKeyRequest>
   <urn:userID>?</urn:userID>
</urn:deleteKeyRequest>

Response

Empty response

Error codes

Error code

Description

6

Missing required fields: userID

7748

Not authorized to delete this prematch

...

getKey

Description

With the getKey operation you retrieve a key linked to a profileID, distributorPersonID or userID. Successful getKey calls return a key object in the response.

Authentication

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

Cardinality

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

Name Type Cardinality

profileID profileID 0...1

distributorPersonID string256 0...1

userID string256 0...1

1...1

Source

Code Block
<urn:getKeyRequest>
   <!--You have a CHOICE of the next 3 items at this level-->
   <!--Optional:-->
   <urn:profileID>?</urn:profileID>
   <!--Optional:-->
   <urn:distributorPersonID>?</urn:distributorPersonID>
   <!--Optional:-->
   <urn:userID>?</urn:userID>
</urn:getKeyRequest>

Response

Name

Type

Cardinality

key

key

0...n

Error codes

Error code

Description

6

Missing required fields: profileID, distributorPersonID or userID

...

Errors

General errors

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.

12

Session expired

The session has expired, a new session must be aquired by the login operation.

Specific errors

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

Error code

Description

0006

Missing required fields

4426

ProfileID is already prematched

4428

Not authorized to prematch this profileID

5287

Portal not found with realm from userID

7747

Prematch with this userID does not exist

7748

Not authorized to delete this prematch

7766

UserID is already prematched


...

Complex types

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>

sessionIDHeader

Name

Type

Cardinality

Description

sessionID

string64

1...1

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

Source

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

key

Name

Type

Cardinality

Description

profileID

profileID

1...1

Unique identifier generated by Edu-iX.

distributorPersonID

string256

0...1

Unique identifier of the person provided by the Distributor.

userID

string256

0...1

Unique identifier of the person provided by the ELO.

Source

Code Block
<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="userID" type="types:string256" minOccurs="0" maxOccurs="1"/>
 </xs:sequence>

...

Simple types

Name

Type

Possible values / format

Description

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.

profileID

Integer

Number 1 or higher

A profile ID is an positive integer number with maximum 10 characters.