Page Comparison

...

Because the endpoints are not active yet, the WSDL and corresponding XSD are available as direct downloadable files.

View file

name	credit_5_1.xsdwsdl

View file

name	credit_5_1.wsdlxsd

Authorization

The following roles have access to this web service:

...

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	0...n

...

Empty request

Response

Name	Type	Cardinality
sessionID	string64	1...1

Error codes

...

You have a choice to use either the loginHeader or the sessionIDHeader to authenticate. A sessionID can be obtained by performing the login operation beforehand. See operation authentication.

Request

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>

...

Complex Types

personCredit

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>

schoolCredit

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>

uploadPersonCredit

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>

returnCredit

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>

loginHeader

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>

sessionIDHeader

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>

specification

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.

error

Name	Type	Cardinality	Description
errorKind	errorKind	1...1
errorCode	integer	1...1	In case of external errors the given value will be an ECK standard error.

...

Version	Old Version 19	New Version 20
Changes made by	André Mussche	André Mussche
Saved on	Apr 08, 2020	Apr 29, 2020

Versions Compared

Key

Authorization

Authentication

Response

Error codes

Request

Complex Types

personCredit

schoolCredit

uploadPersonCredit

returnCredit

loginHeader

sessionIDHeader

specification

error