Versions Compared

Version Old Version 9 New Version 10
Changes made by

André Mussche

André Mussche

Saved on

Key

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

...

  • getPersonCreditRaw operation added

  • Blocked state is added to licenseState enum (only for EBFused by getPersonCreditRaw operation)

  • responseReferenceId is added to getSchoolCredit response

...

The getPersonCredits can be used to retrieve information about earlier created EBF credits.
Note: only 1 credit per ean and only “NotActive” and “Active” states are returned: e.g. blocked and expired credits are omitted. Can be used to show the available credits to the user.

Authentication

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.

...

The getPersonCreditsRaw can be used to retrieve unfiltered EBF credits data. 
Note: because all data is returned, it cannot be used to show directly to the user: e.g. it can contain multiple credits with the same ean, expired or blocked credits, etc.

Authorization

The following roles have access to this operation:

...

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

organisationID

organisationID

1...1

Unique identifier of the organisation

startDate

date

0...1

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

organisationID

organisationID

1...1

Unique identifier of the organisation

startDate

date

0...1

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

...