Page Comparison

...

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>
    <urn:sessionIDHeader>
       <urn:sessionID>?</urn:sessionID>
    </urn:sessionIDHeader>
 </urn:authHeader>

...

Name	Type	Cardinality
loginHeader	loginHeader	0...n

Request

Empty request

...

Name	Type	Cardinality
sessionID	string64	1...1

Error codes

Error code	Description
2	Authentication error
4	Authorization error

...

getPersonCredits

Description

...

Name

Type

Cardinality

Description

distributorCreditID

string160

1...100

At least one of these fields must be filled.

distributorPersonID

string256

1…1

eckID

eckID

1…1

userID

string256

1…1

ean

string160

0…1

Source

Code Block

<urn:getPersonCreditsRequest>
    <!--You have a CHOICE of the next 4 items at this level-->
    <!--1 to 100 repetitions:-->
    <urn:distributorCreditID>?</urn:distributorCreditID>   
    <urn:distributorPersonID>?</urn:distributorPersonID>
    <urn:eckID>?</urn:eckID>
    <urn:userID>?</urn:userID>
    <!--Optional:-->
    <urn:ean>?</urn:ean>
 </urn:getPersonCreditsRequest>

...

Error codes

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

...

getSchoolCredits

Description

...

Name

Type

Cardinality

Description

distributorCreditID

string160

1...100

At least one of these fields must be filled.

organisationID

organisationID

1…1

ean

string160

0…1

Source

Code Block

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

...

Name	Type	Cardinality
schoolCredit	schoolCredit	0...n

Error codes

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

...

uploadPersonCredits

Description

...

Name

Type

Cardinality

personCredit

uploadPersonCredit

1...100

Source

Code Block

<urn:uploadPersonCreditsRequest>
    <!--1 to 100 repetitions:-->
    <urn:personCredit>
       <urn:distributorCreditID>?</urn:distributorCreditID>
       <urn:distributorPersonID>?</urn:distributorPersonID>
       <urn:organisationID>?</urn:organisationID>
       <urn:ean>?</urn:ean>
       <urn:startDate>?</urn:startDate>
       <!--Optional:-->
       <urn:block>?</urn:block>
       <!--Optional:-->
       <urn:eckID>?</urn:eckID>
       <!--Optional:-->
       <urn:userID>?</urn:userID>
    </urn:personCredit>
 </urn:uploadPersonCreditsRequest>

...

In case of errors on a single credit or on multiple credits, the response contains a FaultPerCredit complex-type for each occurred error. Credits without error are processed and stored in Edu-iX.

Error code	Description
4	Authorization error
6	Missing required field(s)
8	Record cannot be changed
9	Process validation error

...

uploadSchoolCredits

Description

...

Name

Type

Cardinality

schoolCredit

uploadSchoolCredit

1...100

Source

Code Block

<urn:uploadSchoolCreditsRequest>
    <!--1 to 100 repetitions:-->
    <urn:schoolCredit>
       <urn:distributorCreditID>?</urn:distributorCreditID>
       <urn:organisationID>?</urn:organisationID>
       <urn:ean>?</urn:ean>
       <urn:startDate>?</urn:startDate>
       <urn:amount>?</urn:amount>
    </urn:schoolCredit>
 </urn:uploadSchoolCreditsRequest>

...

In case of errors on a single credit or on multiple credits, the response contains a FaultPerCredit complex-type for each occurred error. Credits without error are processed and stored in Edu-iX.

Error code	Description
4	Authorization error
6	Missing required field(s)
8	Record cannot be changed
9	Process validation error

...

returnCredits

Description

A returnCredit cancels the indicated credit for further use by the end user.

...

Name

Type

Cardinality

returnCredit

1...100

Source

Code Block

<urn:returnCreditsRequest>
    <!--1 to 100 repetitions:-->
    <urn:returnCredit>
       <urn:distributorCreditID>?</urn:distributorCreditID>
       <urn:amount>?</urn:amount>
       <urn:distributorReturnCreditID>?</urn:distributorReturnCreditID>
    </urn:returnCredit>
 </urn:returnCreditsRequest>

...

In case of errors on a single credit or on multiple credits, the response contains a FaultPerCredit complex-type for each occurred error. Credits without error are processed and stored in Edu-iX.

Error code	Description
4	Authorization error
6	Missing required field(s)
8	Record cannot be changed
9	Process validation error

...

blockCredits

Description

A blockCredit blocks the indicated credit (which must have been specified) for further use by the end user.

...

Name

Type

Cardinality

blockCredit

1...100

Source

Code Block

<urn:blockCreditsRequest>
    <!--1 to 100 repetitions:-->
    <urn:blockCredit>
       <urn:distributorCreditID>?</urn:distributorCreditID>
       <urn:specificationRequestID>?</urn:specificationRequestID>
    </urn:blockCredit>
 </urn:blockCreditsRequest>

...

In case of errors on a single credit or on multiple credits, the response contains a FaultPerCredit complex-type for each occurred error. Credits without error are processed and stored in Edu-iX.

Error code	Description
4	Authorization error
6	Missing required field(s)
9	Process validation error
9	Credit not specified yet

...

unblockCredits

Description

...

Name

Type

Cardinality

unblockCredit

blockCredit

1...100

Source

Code Block

 <urn:blockCreditsRequest>
    <!--1 to 100 repetitions:-->
    <urn:unblockCredit>
       <urn:distributorCreditID>?</urn:distributorCreditID>
       <urn:specificationRequestID>?</urn:specificationRequestID>
    </urn:unblockCredit>
 </urn:blockCreditsRequest>

...

In case of errors on a single credit or on multiple credits, the response contains a FaultPerCredit complex-type for each occurred error. Credits without error are processed and stored in Edu-iX.

Error code	Description
4	Authorization error
6	Missing required field(s)
8	Record cannot be unblocked because it is not blocked
9	Process validation error

...

Errors

General errors

General errors may occur within every operation.

...

Name

Type

Cardinality

Description

distributorCreditID

string160

1...1

Unique identifier of the credit indicated by the distributor.

parentDistributorCreditID

string160

0...1

In case of a returnCredit this identifies the parent credit.

distributorPersonID

string256

1...1

Unique identifier of the person to which this credit is connected.

organisationID

1...1

Unique identifier of the school to which this credit is connected.

ean

string160

1...1

Unique identifier of the product. The credit gives right of use for the indicated ean.

startDate

date

1...1

The start date. Until the start date the credit cannot be used.

personProductState

1...1

The state in which the product is active.

eckID

0...1

Unique identification of the end user by the ECK standard.

userID

string256

0...1

Unique identification of the end user. This value is also known as the prematch value.

specification

0...1

In case the credit is specified detailed information about the specification can be found here.

error

0...1

Detailed information about occurred errors while specifying credits can be found within the error object.

Source

Code Block

<xs:complexType name="personCredit">
 <xs:sequence>
    <xs:element name="distributorCreditID" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="parentDistributorCreditID" type="types:string160" minOccurs="0" maxOccurs="1"/>
    <xs:element name="distributorPersonID" type="types:string256" minOccurs="1" maxOccurs="1"/>
    <xs:element name="organisationID" type="types:organisationID" minOccurs="1" maxOccurs="1"/>
    <xs:element name="ean" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="startDate" type="types:date" minOccurs="1" maxOccurs="1"/>
    <xs:element name="personProductState" type="types:personProductState" minOccurs="1" maxOccurs="1"/>
    <xs:element name="eckID" type="types:eckID" minOccurs="0" maxOccurs="1"/>
    <xs:element name="userID" type="types:string256" minOccurs="0" maxOccurs="1"/>
    <xs:element name="specification" type="types:specification" minOccurs="0" maxOccurs="1"/>
    <xs:element name="error" type="types:error" minOccurs="0" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

distributorCreditID

string160

1...1

Unique identifier of the credit indicated by the distributor.

parentDistributorCreditID

string160

0...1

In case of a returnCredit this identifies the parent credit.

organisationID

1...1

Unique identifier of the school to which this credit will be connected.

ean

string160

1...1

Unique identifier of the product. The credit gives right of use for the indicated ean.

startDate

date

1...1

The start date. Until the start date the credit cannot be used.

amount

1...1

The amount of credits.

returnedAmount

amount

0...1

The amount of credits canceled. In case of multiple returnCredits on the same distributorCreditID a sum of the total return amount is shown.

specification

0...1

In case the credit is specified detailed information about the specification can be found here.

error

0...1

Detailed information about occurred errors while inserting or updating credits can be found within the error object.

Source

Code Block

<xs:complexType name="schoolCredit">
 <xs:sequence>
    <xs:element name="distributorCreditID" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="parentDistributorCreditID" type="types:string160" minOccurs="0" maxOccurs="1"/>
    <xs:element name="organisationID" type="types:organisationID" minOccurs="1" maxOccurs="1"/>
    <xs:element name="ean" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="startDate" type="types:date" minOccurs="1" maxOccurs="1"/>
    <xs:element name="amount" type="types:amount" minOccurs="1" maxOccurs="1"/>
    <xs:element name="returnedAmount" type="types:amount" minOccurs="0" maxOccurs="1"/>
    <xs:element name="specification" type="types:specification" minOccurs="0" maxOccurs="1"/>
    <xs:element name="error" type="types:error" minOccurs="0" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

distributorCreditID

string160

1...1

Unique identifier of the credit indicated by the distributor.

distributorPersonID

string256

1...1

Unique identifier of the person to which this credit is connected.

organisationID

1...1

Unique identifier of the school to which this credit is connected.

ean

string160

1...1

Unique identifier of the product. The credit gives right of use for the indicated ean.

startDate

date

1...1

The start date. Until the start date the credit cannot be used.

block

boolean

0...1

Indicating if the credit should be blocked for specification.

eckID

0...1

Unique identification of the end user by the ECK standard.

userID

string256

0...1

Unique identification of the end user. This value is also known as the prematch value. The given value must be according the syntax: ID@REALM

Source

Code Block

<xs:complexType name="uploadPersonCredit">
 <xs:sequence>
    <xs:element name="distributorCreditID" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="distributorPersonID" type="types:string256" minOccurs="1" maxOccurs="1"/>
    <xs:element name="organisationID" type="types:organisationID" minOccurs="1" maxOccurs="1"/>
    <xs:element name="ean" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="startDate" type="types:date" minOccurs="1" maxOccurs="1"/>
    <xs:element name="block" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
    <xs:element name="eckID" type="types:eckID" minOccurs="0" maxOccurs="1"/>
    <xs:element name="userID" type="types:string256" minOccurs="0" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

distributorCreditID

string160

1...1

Unique identifier of the credit indicated by the distributor.

organisationID

1...1

Unique identifier of the school to which this credit is connected.

ean

string160

1...1

Unique identifier of the product. The credit gives right of use for the indicated ean.

startDate

date

1...1

The start date. Until the start date the credit cannot be used.

amount

1...1

The amount of credits.

Source

Code Block

<xs:complexType name="uploadSchoolCredit">
 <xs:sequence>
    <xs:element name="distributorCreditID" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="organisationID" type="types:organisationID" minOccurs="1" maxOccurs="1"/>
    <xs:element name="ean" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="startDate" type="types:date" minOccurs="1" maxOccurs="1"/>
    <xs:element name="amount" type="types:amount" minOccurs="1" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

distributorCreditID

string160

1...1

Unique identifier of the credit you want to return.

amount

1...1

The amount of credits which should be returned.

distributorReturnCreditID

string160

1...1

Unique identifier of the returnCredit.

Source

Code Block

<xs:complexType name="returnCredit">
 <xs:sequence>
    <xs:element name="distributorCreditID" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="amount" type="types:amount" minOccurs="1" maxOccurs="1"/>
    <xs:element name="distributorReturnCreditID" type="types:string160" minOccurs="1" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

distributorCreditID

string160

1...1

Unique identifier of the credit you want to block.

specificationRequestID

string160

0...1

Identifier used by the specify engine. Default the same value as distributorCreditID (so leave empty) but can be different in case of prematch changes after specification, which results in a double specification. The specific specification requestID from the notification service must be supplied then.

Source

Code Block

<xs:complexType name="blockCredit">
 <xs:sequence>
    <xs:element name="distributorCreditID" type="types:string160" minOccurs="1" maxOccurs="1"/>
    <xs:element name="specificationRequestID" type="types:string160" minOccurs="0" maxOccurs="1"/>
 </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

username

string100

0...1

The username.

password

string64

0...1

The password.

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>

...

Name

Type

Cardinality

Description

sessionID

string64

1...1

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

Source

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

...

Name	Type	Cardinality	Description
specificationResponseID	string256	1...1	Unique identifier of the specification provided by the publisher. The given value is according the ECK standard.
timeStamp	date	1...1	The date and time of the specification.

...

Version	Old Version 9	New Version 10
Changes made by	Eelke Lok	Eelke Lok
Saved on	Mar 30, 2020	Mar 30, 2020

Versions Compared

Key

Request

Error codes

getPersonCredits

Description

Error codes

getSchoolCredits

Description

Error codes

uploadPersonCredits

Description

uploadSchoolCredits

Description

returnCredits

Description

blockCredits

Description

unblockCredits

Description

Errors

General errors