Versions Compared

Key

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

...

Name

Type

Cardinality

Description

organisationID

organisationID

1...1

Unique identifier of the school to which this credit is connected, e.g. “digiDeliveryId”.

ean

string30

1...1

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

creditStartDate

date

1...1

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

creditEndDate

date

0...1

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

schoolYear

schoolYear

1...1

School year during which the credit is started.

amountNotActive

positiveInteger

1...1


amountActive

positiveInteger

1...1


amountInProcess

positiveInteger

1...1


amountExpired

positiveInteger

1...1


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:string30" minOccurs="1" maxOccurs="1"/>
			<xs:element name="creditStartDate" type="types:date" minOccurs="1" maxOccurs="1"/>
			<xs:element name="creditEndDate" type="types:date" minOccurs="0" maxOccurs="1"/>
			<xs:element name="schoolYear" type="types:schoolYear" minOccurs="1" maxOccurs="1"/>
			<xs:element name="amountNotActive" type="types:positiveInteger" minOccurs="1" maxOccurs="1"/>
			<xs:element name="amountActive" type="types:positiveInteger" minOccurs="1" maxOccurs="1"/>
			<xs:element name="amountInProcess" type="types:positiveInteger" minOccurs="1" maxOccurs="1"/>
			<xs:element name="amountExpired" type="types:positiveInteger" minOccurs="1" maxOccurs="1"/>
    </xs:sequence>
</xs:complexType>

...

Name

Type

Possible values / format

Description

string4-6

String

Min length: 4 characters

Max length: 6 characters

String limited by a number of minimum and maximum allowed characters.

string15

String

Max length: 15 characters

String limited by a number of maximum allowed characters.

string50

String

Max length: 50 characters

String limited by a number of maximum allowed characters.

string64

String

Max length: 64 characters

String limited by a number of maximum allowed characters.

string100

String

Max length: 100 characters

String limited by a number of maximum allowed characters.

string256

String

Max length: 256 characters

String limited by a number of maximum allowed characters.

eckID

String

Exact length: 128 characters

eckID is in the form of a URL: https://id.school/2015-09/[128-char hex string]. Currently this url resolves to a static page containing general information about the ECK ID.

organisationID

String

Min length: 1 characters

Max length: 40 characters

Unique identifier of a school, e.g. “digiDeliveryId”

specificationState

Enum

Possible values:

  • Fault

  • Specified

The specification state of a credit

personProductState

Enum

Possible values:

  • Active

  • Returned

State of a person product, i.e. Active or Returned

schoolYear

Integer

e.g. 1920

A representation of a school year by concatenating the last two numbers of both years, i.e. the school year 2019 - 2020 would be noted as 1920.

possitiveInteger

Integer

Greater then 0

Integer value, can only be positive

...