Versions Compared

Version Old Version 5 New Version 6
Changes made by

André Mussche

André Mussche

Saved on

Key

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

...

  • blockCredits operation added

  • unblockCredits operation added

Operation overview

Operation authentication

All operations, except login, need either the loginHeader or the sessionIDHeader to authenticate. A sessionID can be obtained by performing the login operation beforehand.

...

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

The distributorCreditID element provides the ability to request up to a maximum of 100 different credits at once.

...

Name

Type

Cardinality

personCredit

personCredit

0...n

Error codes

Error code

Description

4

Authorization error

6

Missing required field(s)

...

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

The distributorCreditID element provides the ability to request up to a maximum of 100 different credits at once.

...

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

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>

...

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

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>

...

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

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>

...

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

blockCredit

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>

...

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

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>

...

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.

...