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 `<xs:complexType> <xs:sequence> <xs:element name="organisationID" type="types:organisationID" minOccurs="1" maxOccurs="1"/> <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 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 `<xs:complexType name="authHeader"> <xs:sequence> <xs:element name="loginHeader" type="types:loginHeader" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType>`

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 `<xs:complexType name="loginHeader"> <xs:sequence> <xs:element name="username" type="types:string100" minOccurs="1" maxOccurs="1"/> <xs:element name="password" type="types:string64" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType>`

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 `<xs:element name="Fault"> <xs:complexType> <xs:sequence> <xs:element name="code" type="types:integer" minOccurs="1" maxOccurs="1"/> <xs:element name="message" type="types:string" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> </xs:element>`

SchoolCreditInformation

Name	Type	Cardinality	Description

Name	Type	Cardinality
schoolCredit	schoolCredit	1...1
specification	specification	0...1
license	license	0...n
Source `<xs:complexType name="schoolCreditInformation"> <xs:sequence> <xs:element name="schoolCredit" type="types:schoolCredit" minOccurs="1" maxOccurs="1"/> <xs:element name="specification" type="types:specification" minOccurs="0" maxOccurs="1"/> <xs:element name="license" type="types:license" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>`

PersonCreditInformation

Name	Type	Cardinality	Description

Name	Type	Cardinality
schoolCredit	schoolCredit	1...1
specification	specification	0...1
license	license	0...1
Source `<xs:complexType name="personCreditInformation"> <xs:sequence> <xs:element name="personCredit" type="types:personCredit" minOccurs="1" maxOccurs="1"/> <xs:element name="specification" type="types:specification" minOccurs="0" maxOccurs="1"/> <xs:element name="license" type="types:license" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType>`

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 <xs:complexType name="personCredit"> <xs:sequence> <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="personProductState" type="types:personProductState" minOccurs="1" maxOccurs="1"/> <xs:element name="schoolYear" type="types:schoolYear" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType>

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

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 `<xs:complexType name="specification"> <xs:sequence> <xs:element name="specificationState" type="types:specificationState" minOccurs="0" maxOccurs="1"/> <xs:element name="specificationStateDate" type="types:date" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType>`

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 `<xs:complexType name="license"> <xs:sequence> <xs:element name="activationDate" type="types:date" minOccurs="0" maxOccurs="1"/> <xs:element name="licenseStartDate" type="types:date" minOccurs="0" maxOccurs="1"/> <xs:element name="licenseEndDate" type="types:date" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType>`

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