Page Comparison

...

getPersonCreditRaw operation added
Blocked state is added to state enum (only used by getPersonCreditRaw operation)
responseReferenceId is added to getSchoolCredit response

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.

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

Description

loginHeader

loginHeader

1...1

Source

Code Block
<urn:loginHeader> <!--Optional:--> <urn:username>?</urn:username> <!--Optional:--> <urn:password>?</urn:password> </urn:loginHeader>

...

Name	Type	Cardinality	Description
sessionID	string64	1...1	Unique identifier of the session

Error codes

Error code	Description
2	Authentication error

...

getPersonCredit

Description

...

Name

Type

Cardinality

Description

userID

eckID

string256

eckID

1...1

You must use either one or both of these variables.

startDate

date

0...1

The start date. Licenses which are active on this date are returned: e.g. licenses expired before this date are not returned.

Default value is “today” when omitted.

endDate

date

0...1

The end date. Licenses should start before this date.

Normally only startDate (today) is used.

ean

string160

0...1

Unique identifier of the product. Only credits with this ean are returned.

Source

Code Block

   <urn:getPersonCreditRequest>
         <!--You have a CHOICE of the next 2 items at this level-->
         <!--Optional:-->
         <urn:userID>?</urn:userID>
         <!--Optional:-->
         <urn:eckID>?</urn:eckID>
         <!--Optional:-->
         <urn:startDate>?</urn:startDate>
           <!--Optional:-->
         <urn:endDate>?</urn:endDate>
         <!--Optional:-->
         <urn:ean>?</urn:ean>
   </urn:getPersonCreditRequest>

...

Name

Type

Cardinality

Description

personCreditInformation

0...n

Source

Code Block

<urn:getPersonCreditResponse>
         <!--Zero or more repetitions:-->
         <urn:personCreditInformation>
            <urn:personCredit>
               <urn:ean>?</urn:ean>
               <urn:startDate>?</urn:startDate>
               <!--Optional:-->
               <urn:endDate>?</urn:endDate>
               <urn:state>?</urn:state>
            </urn:personCredit>
         </urn:personCreditInformation>
</urn:getPersonCreditResponse>

Error codes

Error code	Description
6	Missing required field(s)

...

getPersonCreditRaw

Description

...

Name

Type

Cardinality

Description

userID

eckID

string256

eckID

1...1

You can use either one of these variables

startDate

date

0...1

The start date. Licenses which are active on this date are returned: e.g. licenses expired before this date are not returned.

Default value is “today” when omitted.

endDate

date

0...1

The end date. Licenses should start before this date.

Normally only startDate (today) is used.

ean

string160

0...1

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

Source

Code Block

<urn:getPersonCreditRawRequest>
      <!--You have a CHOICE of the next 2 items at this level-->
      <!--Optional:-->
      <urn:userID>?</urn:userID>
      <!--Optional:-->
      <urn:eckID>?</urn:eckID>
      <!--Optional:-->
      <urn:startDate>?</urn:startDate>
      <!--Optional:-->
      <urn:endDate>?</urn:endDate>
      <!--Optional:-->
      <urn:ean>?</urn:ean>
</urn:getPersonCreditRawRequest>

...

Name

Type

Cardinality

Description

personCreditInformation

0...n

Source

Code Block

<urn:getPersonCreditRawResponse>
     <!--Zero or more repetitions:-->
     <urn:personCreditInformation>
             <urn:personCredit>
             <urn:ean>?</urn:ean>
             <urn:startDate>?</urn:startDate>
             <!--Optional:-->
             <urn:endDate>?</urn:endDate>
             <urn:state>?</urn:state>
         </urn:personCredit>
     </urn:personCreditInformation>
</urn:getPersonCreditRawResponse>

Error codes

Error code	Description
6	Missing required field(s)

...

getSchoolCredit

Description

...

Name

Type

Cardinality

Description

organisationID

organisationID

1...1

Unique identifier of the organisation

startDate

date

0...1

The start date. Licenses which are active on this date are returned: e.g. licenses expired before this date are not returned.

Default value is “today” when omitted.

endDate

date

0...1

The end date. Licenses should start before this date.

Normally only startDate (today) is used.

ean

string160

0...1

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

Source

Code Block

   <urn:getSchoolCreditRequest>
         <urn:organisationID>?</urn:organisationID>
         <!--Optional:-->
         <urn:ean>?</urn:ean>
         <!--Optional:-->
         <urn:startDate>?</urn:startDate>
         <!--Optional:-->
         <urn:endDate>?</urn:endDate>
   </urn:getSchoolCreditRequest>

...

Name

Type

Cardinality

Description

schoolCreditInformation

0...n

Source

Code Block

  <urn:getSchoolCreditResponse>
         <!--Zero or more repetitions:-->
         <urn:schoolCreditInformation>
            <urn:schoolCredit>
               <urn:organisationID>?</urn:organisationID>
               <urn:ean>?</urn:ean>
               <urn:startDate>?</urn:startDate>
               <!--Optional:-->
               <urn:endDate>?</urn:endDate>
            </urn:schoolCredit>
            <!--Optional:-->
            <urn:amountActive>?</urn:amountActive>
            <!--Optional:-->
            <urn:amountNotActive>?</urn:amountNotActive>
         </urn:schoolCreditInformation>
  </urn:getSchoolCreditResponse>

Error codes

Error code	Description
6	Missing required field(s)

...

getSummedSchoolCredit

Description

...

Name

Type

Cardinality

Description

organisationID

organisationID

1...1

Unique identifier of the organisation

startDate

date

0...1

The start date. Licenses which are active on this date are returned: e.g. licenses expired before this date are not returned.

Default value is “today” when omitted.

endDate

date

0...1

The end date. Licenses should start before this date.

Normally only startDate (today) is used.

ean

string160

0...1

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

Source

Code Block

   <urn:getSummedSchoolCreditRequest>
         <urn:organisationID>?</urn:organisationID>
         <!--Optional:-->
         <urn:ean>?</urn:ean>
         <!--Optional:-->
         <urn:startDate>?</urn:startDate>
         <!--Optional:-->
         <urn:endDate>?</urn:endDate>
   </urn:getSummedSchoolCreditRequest>

...

Name

Type

Cardinality

Description

summedSchoolCredit

0...n

Source

Code Block

   <urn:getSummedSchoolCreditResponse>
         <!--Zero or more repetitions:-->
         <urn:summedSchoolCredit>
            <urn:ean>?</urn:ean>
            <urn:amount>?</urn:amount>
            <!--Optional:-->
            <urn:used>?</urn:used>
         </urn:summedSchoolCredit>
   </urn:getSummedSchoolCreditResponse>

Error codes

Error code	Description
6	Missing required field(s)

...

Errors

General errors

Error code	Description
0	Unkown error
1	General error This occurs in for example: database errors or internal server errors.
2	Authentication error For instance when invalid credentials are provided.
3	Session expired The given sessionID is no longer active and has expired. Acquire a new sessionID to proceed.
4	Authorization error You do not have permission to use this operation.
5	Bad request Parsing error, for instance when invalid xml has been provided.

...

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>

...

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>

...

Name

Type

Cardinality

Description

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.

endDate

date

0...1

The end date. Until the end date the credit can be used.

state

1...1

The current state of the credit.

Source

Code Block

<xs:complexType name="personCredit">
    <xs:sequence>
			<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="endDate" type="types:date" minOccurs="0" maxOccurs="1"/>
			<xs:element name="state" type="types:state" minOccurs="1" maxOccurs="1"/>
    </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

personCredit

1...1

Specific person credit details.

Source

Code Block
<xs:complexType name="personCreditInformation"> <xs:sequence> <xs:element name="personCredit" type="types:personCredit" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType>

...

Name

Type

Cardinality

Description

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.

endDate

date

0...1

The end date. Until the end date the credit can be used.

Source

Code Block

<xs:complexType name="schoolCredit">
    <xs:sequence>
  		<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="endDate" type="types:date" minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

schoolCredit

1...1

Specific school credit details.

amountActive

integer

0...1

Amount of credits that have been activated by the end-user.

amountNotActive

integer

0...1

Amount of credits that have not been activated by the end-user.

responseReferenceId

string160

0...1

The identifier returned when specified (so specification and license can be mapped).

Source

Code Block

<xs:complexType name="schoolCreditInformation">
    <xs:sequence>
			<xs:element name="schoolCredit" type="types:schoolCredit" minOccurs="1" maxOccurs="1"/>
			<xs:element name="amountActive" type="types:integer" minOccurs="0" maxOccurs="1"/>
			<xs:element name="amountNotActive" type="types:integer" minOccurs="0" maxOccurs="1"/>
			<xs:element name="responseReferenceId" type="types:string160" minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
</xs:complexType>

...

Name

Type

Cardinality

Description

ean

string160

1...1

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

amount

1...1

Total of credits.

used

amount

0...1

Total of credits used.

Source

Code Block

<xs:complexType name="summedSchoolCredit">
    <xs:sequence>
			<xs:element name="ean" type="types:string160" minOccurs="1" maxOccurs="1"/>
			<xs:element name="amount" type="types:amount" minOccurs="1" maxOccurs="1"/>
			<xs:element name="used" type="types:amount" minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
</xs:complexType>

...

Version	Old Version 15	New Version 16
Changes made by	André Mussche	Eelke Lok
Saved on	Mar 30, 2020	Mar 30, 2020

Versions Compared

Key

Operation overview

Operation authentication

Error codes

getPersonCredit

Description

Error codes

getPersonCreditRaw

Description

Error codes

getSchoolCredit

Description

Error codes

getSummedSchoolCredit

Description

Error codes

Errors

General errors