Credit 4.0

Documentation

1 Documentation
- 1.1 Endpoints
2 Operation overview
3 Operations
- 3.1 getPersonCredit
  - 3.1.1 Description
  - 3.1.2 Authentication
  - 3.1.3 Request
  - 3.1.4 Response
  - 3.1.5 Error codes
- 3.2 getSchoolCredit
  - 3.2.1 Description
  - 3.2.2 Authentication
  - 3.2.3 Request
  - 3.2.4 Response
  - 3.2.5 Error codes
4 Complex types
- 4.1 AuthHeader
- 4.2 LoginHeader
- 4.3 Fault
- 4.4 SchoolCreditInformation
- 4.5 PersonCreditInformation
- 4.6 PersonCredit
- 4.7 SchoolCredit
- 4.8 Specification
- 4.9 License
5 Simple types
6 Appendix
- 6.1 Terms

Endpoints

Environment	URL	WSDL

Environment	URL	WSDL
Production	https://lika.edu-ix.nl/soap/4.0/credit	https://lika.edu-ix.nl/soap/4.0/credit/wsdl
Acceptance	https://ketentest-lika.edu-ixstaging.nl/soap/4.0/credit	https://ketentest-lika.edu-ixstaging.nl/soap/4.0/credit/wsdl

Operations

getPersonCredit

Description

The getPersonCredits operation can be used to retrieve EBF credits of a person, using one of the identifiers.
Note: eduUID is the “uid” value of the getEduprofile response.

Authentication

Name	Type	Cardinality

Name	Type	Cardinality
authHeader	authHeader	1...1
Source `<urn:authHeader> <urn:loginHeader> <urn:username>?</urn:username> <urn:password>?</urn:password> </urn:loginHeader> </urn:authHeader>`

Request

Name	Type	Cardinality

Name	Type	Cardinality
schoolYear	schoolYear	0...1
ean	string30	0...1
You have a CHOICE of the next 4 items at this level redirectSessionID string64 1...1 eckID eckID 1...1 userID string100 1...1 eduUID string256 1…1		1...1
Source <xs:complexType> <xs:sequence> <xs:choice minOccurs="1" maxOccurs="1"> <xs:element name="redirectSessionID" type="types:string64" minOccurs="1" maxOccurs="1"/> <xs:element name="eckID" type="types:eckID" minOccurs="1" maxOccurs="1"/> <xs:element name="userID" type="types:string100" minOccurs="1" maxOccurs="1"/> <xs:element name="eduUID" type="types:string256" minOccurs="1" maxOccurs="1"/> </xs:choice> <xs:element name="ean" type="types:string30" minOccurs="0" maxOccurs="1"/> <xs:element name="schoolYear" type="types:schoolYear" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType>

Response

The response contains 0 to all person credits for a specific person. In case of an error, a Fault object is returned.

Name	Type	Cardinality

Name	Type	Cardinality
personCreditInformation	personCreditInformation	0...n

Error codes

Error code	Description

Error code

Description

-200

Bad Request

0

General Error

for example: database errors or internal server errors.

1

Missing Fields
for example: missing one of UserID, EckID or RedirectSessionID

getSchoolCredit

Description

The getSchoolCredits operation can be used to retrieve IBF credits of a school.

Authentication

Name	Type	Cardinality

Name	Type	Cardinality
authHeader	authHeader	1...1
Source `<urn:authHeader> <urn:loginHeader> <urn:username>?</urn:username> <urn:password>?</urn:password> </urn:loginHeader> </urn:authHeader>`

Request

Name	Type	Cardinality

Name	Type	Cardinality
organisationID	organisationID	1...1
ean	string30	0...1
schoolYear	schoolYear	0...1
Source

Response

The response contains 0 to all school credits for a specific school. In case of an error, a Fault object is returned.

Name	Type	Cardinality

Name	Type	Cardinality
schoolCreditInformation	schoolCreditInformation	0...n

Error codes

Error code	Description

Error code

Description

-200

Bad Request

0

General Error

for example: database errors or internal server errors.

5

Missing Fields: OrganisationID

Complex types

AuthHeader

Name	Type	Cardinality	Description

Name	Type	Cardinality	Description
loginHeader	loginHeader	1...1	contains credentials.
Source

LoginHeader

Name	Type	Cardinality	Description

Name	Type	Cardinality	Description
username	string100	1...1	An identification used by a person to login.
password	string64	1...1	A secret word or phrase used for authentication.
Source

Fault

Name	Type	Cardinality	Description

Name	Type	Cardinality	Description
code	integer	1...1	Code to identify the fault type.
message	string	1...1	Specific message which describes the fault.
Source

SchoolCreditInformation

Name	Type	Cardinality	Description

Name	Type	Cardinality
schoolCredit	schoolCredit	1...1
specification	specification	0...1
license	license	0...n
Source

PersonCreditInformation

Name	Type	Cardinality	Description

Name	Type	Cardinality
schoolCredit	schoolCredit	1...1
specification	specification	0...1
license	license	0...1
Source

PersonCredit

Name	Type	Cardinality	Description

Name	Type	Cardinality	Description
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.
personProductState	personProductState	1...1	see simple types
schoolYear	schoolYear	1...1	School year during which the credit is started.
Source

SchoolCredit

Name	Type	Cardinality	Description

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

Specification

Name	Type	Cardinality	Description

Name	Type	Cardinality	Description
specificationState	specificationState	0...1	The current state of the license in the specification process.
specificationStateDate	date	1...1	The specification date. This is the creation date of the license.
Source

License

Name	Type	Cardinality	Description

Name	Type	Cardinality	Description
activationDate	date	0...1	The activation date. At this date the license is first used.
licenseStartDate	date	0...1	The start date. Until the start date the license cannot be used.
licenseEndDate	date	0...1	The end date. Until the end date the license can be used.
Source

Simple types

Name	Type	Possible values / format	Description

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

Appendix

Terms

Term	Description

Term	Description
EBF	External book fund
IBF	Internal book fund
ECK	Educatieve contentketen. More information on: https://www.eck-id.nl/
ECK ID	Unique identifier of a person according to the ECK standard
ELO	Elektronische leeromgeving (electronic learning environment)
Specification	Specification is the proces of sending credits from Edu-iX to the publisher. Each specification contains information about the end user and the credit itself. After the specification is completed the credit is available for user by the end user.
Prematch	Prematch is the process of connecting the unique identifier of the end user, available in the ELO, to order data (personal details and credit information) in Edu-iX.