Versions Compared

Key

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

...

Name

Type

Cardinality

Description

sessionID

string64

1...1

Unique identifier of the session

Error codes

Error code

Description

2

Authentication error

...

Name

Type

Cardinality

Description

userID

eckID

string256

eckID

1...1

1...1

You can use either one of these variables

startDate

date

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

ean

string160

0...1

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

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

userID

eckID

string256

eckID

1...1

1...1

You can use either one of these variables

startDate

date

0...1

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

endDate

date

0...1ean

The end date. Until the end date the credit can be 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

organisationID

organisationID

1...1

Unique identifier of the organisation

startDate

date

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

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

organisationID

organisationID

1...1

startDate1...1

Unique identifier of the organisation

startDate

date

0...1

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

endDate

date

0...1

endDate

The end date0...1. Until the end date the credit can be 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

schoolCredit

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

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>

...