Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user Former user

Saved on

Key

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

...

Endpoints

Environment

URL

Production

https://elo.edu-ix.nl/soap/4.1/product/wsdl

Acceptance

https://acc-elo.edu-ix.nl/soap/4.1/product/wsdl

Test

https://test-elo.edu-ix.nl/soap/4.1/product

*Extend the URL with /wsdl to retrieve the WSDL

Authorization

The following roles have access to this web service:

...

  • login

  • getProduct

Operations

login

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

...

...

ELO

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>

...

Error code

Description

2

Authentication error

...

getProduct

Description

Authorization

The following roles have access to this operation:

Role

ELO

...

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

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

NameTypeCardinalitysearchNamesearchName0Name Type Cardinality

searchName searchName 0...1searchEansearchEan01

searchEan searchEan 0...1

1...1

productType

productType

0...1

Source

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

...

Error codes

T.b.d.

...

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>

batchInformation

Name

Type

Cardinality

Description

distributorBatchID

string50

0...1


batchDescription

string100

0...1


Source

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

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

Description

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

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

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

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

comparator

1...1


value

string250

1...1


Source

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

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

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

...