Product 4.1

Owned by Former user (Deleted)
Last updated: Mar 25, 2024 by André Mussche
3 min read

Documentation

Endpoints

Zie Technical documentation | Technicaldocumentation Endpointoverzicht voor het actuele overzicht.

Authorization

The following roles have access to this web service:

Role

Role

ELO

Operation overview

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

Authentication

Name

Type

Cardinality

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

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

Name

Type

Cardinality

sessionID

string64

1...1

Error codes

Error code

Description

Error code

Description

2

Authentication error

 

 

getProduct

Description

The getProduct returns productInformation based on the search criteria.

Authentication

Name

Cardinality

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

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

productType

0...1

Source

 

Response

Name

Type

Cardinality

Name

Type

Cardinality

productInformation

productInformation

0...n

Error codes

Error code

Description

Error code

Description

-200

Bad Request

0

General error

Something went wrong during the operation.

 

 

Complex Types

loginHeader

Name

Type

Cardinality

Description

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

sessionIDHeader

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

sessionID

string64

1...1

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

Source

batchInformation

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

distributorBatchID

string50

0...1



batchDescription

string100

0...1



Source



productInformation

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

product

product

1...1

 

Source

product

Name

Type

Cardinality

Description

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

searchName

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

criterion

criterion

1...n



Source

searchEan

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

criterion

criterion

1...n



Source

criterion

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

comparator

comparator

1...1



value

string250

1...1



Source

study

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

studyID

string15

1...1



name

string50

1...1



Source

subject

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

subjectID

string15

1...1



name

string50

1...1



Source

 

 

Simple Types

Name

Type

Possible values / format

Description

Name

Type

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

Â