Product 4.1

Documentation

Endpoints

Environment	URL
Production	https://elo.edu-ix.nl/soap/4.1/product
Acceptance (school year 2021-2022)	https://acc-elo.edu-ix.nl/soap/4.1/product
Acceptance (school year 2022-2023)	https://acc-elo.edu-ix.nl/2022-2023/soap/4.1/product

*Extend the URL with /wsdl to retrieve the WSDL

Authorization

The following roles have access to this web service:

Role
ELO

Operation overview

login
getProduct

Operations

Description

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 <urn:loginHeader> <!--Optional:--> <urn:username>?</urn:username> <!--Optional:--> <urn:password>?</urn:password> </urn:loginHeader>

Request

Name

Type

Cardinality

bachtInformation

batchInformation

0...1

Source

<urn:loginRequest>
    <!--Optional:-->
    <urn:batchInformation>
       <!--Optional:-->
       <urn:distributorBatchID>?</urn:distributorBatchID>
       <!--Optional:-->
       <urn:batchDescription>?</urn:batchDescription>
    </urn:batchInformation>
 </urn:loginRequest>

Response

Name	Type	Cardinality
sessionID	string64	1...1

Error codes

Error code	Description
2	Authentication error

getProduct

Description

The getProduct returns productInformation based on the search criteria.

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

<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

searchName searchName 0...1

searchEan searchEan 0...1

1...1

productType

0...1

Source

<urn:getProductRequest>
    <!--You have a CHOICE of the next 2 items at this level-->
    <!--Optional:-->
    <urn:searchName>
       <!--1 or more repetitions:-->
       <urn:criterion>
          <urn:comparator>?</urn:comparator>
          <urn:value>?</urn:value>
       </urn:criterion>
    </urn:searchName>
    <!--Optional:-->
    <urn:searchEan>
       <!--1 or more repetitions:-->
       <urn:criterion>
          <urn:comparator>?</urn:comparator>
          <urn:value>?</urn:value>
       </urn:criterion>
    </urn:searchEan>
    <!--Optional:-->
    <urn:productType>?</urn:productType>
 </urn:getProductRequest>

Response

Name	Type	Cardinality
productInformation	productInformation	0...n

Error codes

Error code

Description

-200

Bad Request

0

General error

Something went wrong during the operation.

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

 <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 <xs:sequence> <xs:element name="sessionID" type="types:string64" minOccurs="1" maxOccurs="1"/> </xs:sequence>

batchInformation

Name

Type

Cardinality

Description

distributorBatchID

string50

0...1

batchDescription

string100

0...1

Source

<xs:complexType name="batchInformation">
 <xs:sequence>
    <xs:element name="distributorBatchID" type="types:string50" minOccurs="0" maxOccurs="1"/>
    <xs:element name="batchDescription" type="types:string100" minOccurs="0" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

productInformation

Name	Type	Cardinality	Description
product	product	1...1
Source <xs:complexType name="productInformation"> <xs:sequence> <xs:element name="product" type="types:product" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType>

product

Name	Type	Cardinality
ean	string30	1...1
title	string	1...1
ssoUrl	string250	1...1
url	string250	0...1
productType	productType	1...1
availableFrom	date	0...1
study	study	0...n
subject	subject	0...n
Source <xs:complexType name="product"> <xs:sequence> <xs:element name="ean" type="types:string30" minOccurs="1" maxOccurs="1"/> <xs:element name="title" type="types:string" minOccurs="1" maxOccurs="1"/> <xs:element name="ssoUrl" type="types:string250" minOccurs="1" maxOccurs="1"/> <xs:element name="url" type="types:string250" minOccurs="0" maxOccurs="1"/> <xs:element name="productType" type="types:productType" minOccurs="1" maxOccurs="1"/> <xs:element name="availableFrom" type="types:date" minOccurs="0" maxOccurs="1"/> <xs:element name="study" type="types:study" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="subject" type="types:subject" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>

searchName

Name	Type	Cardinality	Description
criterion	criterion	1...n
Source <xs:complexType name="searchName"> <xs:sequence> <xs:element name="criterion" type="types:criterion" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>

searchEan

Name	Type	Cardinality	Description
criterion	criterion	1...n
Source <xs:complexType name="searchEan"> <xs:sequence> <xs:element name="criterion" type="types:criterion" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>

criterion

Name

Type

Cardinality

Description

comparator

1...1

value

string250

1...1

Source

<xs:complexType name="criterion">
 <xs:sequence>
    <xs:element name="comparator" type="types:comparator" minOccurs="1" maxOccurs="1"/>
    <xs:element name="value" type="types:string250" minOccurs="1" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

study

Name

Type

Cardinality

Description

studyID

string15

1...1

name

string50

1...1

Source

<xs:complexType name="study">
 <xs:sequence>
    <xs:element name="studyID" type="types:string15" minOccurs="1" maxOccurs="1"/>
    <xs:element name="name" type="types:string50" minOccurs="1" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

subject

Name

Type

Cardinality

Description

subjectID

string15

1...1

name

string50

1...1

Source

<xs:complexType name="subject">
 <xs:sequence>
    <xs:element name="subjectID" type="types:string100" minOccurs="1" maxOccurs="1"/>
    <xs:element name="name" type="types:string50" minOccurs="1" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

Simple Types

Name	Possible values / format	Description
string15	Max length: 15 characters	String limited by a number of maximum allowed characters.
string30	Max length: 30 characters	String limited by a number of maximum allowed characters.
string50	Max length: 50 characters	String limited by a number of maximum allowed characters.
string64	Max length: 64 characters	String limited by a number of maximum allowed characters.
string100	Max length: 100 characters	String limited by a number of maximum allowed characters.
string250	Max length: 250 characters	String limited by a number of maximum allowed characters.
comparator	The following values are allowed: exact beginsWith endsWith contains	Value indicating the type of comparison.
productType	The following values are allowed: Student Teacher Administrator	Value indicating the productType of a product-entity