View Source

Endpoints

This service is intended to be implemented by distributors. For this reason no endpoint is available within the Edu-iX environment. This document is for reference purposes only.

WSDL

The WSDL and corresponding XSD’s are available as downloadable files:

Change history

The following items have changed since the previous version Notification 4.2:

Information about a license block/unblock action is added
The specifyState enum is changed to better understandable values
The description of the errorCode is added in an errorMessage field

Operation overview

Operations

prematchChanged

Description

Any change on a prematch value will produce a notify message and deliver it on the prematchChanged operation. For instance when an ELO adds or deletes a prematch value to a persons profile the prematchChanged operation will be triggered. Only the owner of the persons profile will receive the message.

Authentication

Name

Type

Cardinality

loginHeader

1...1

Source

 <urn:loginHeader>
    <urn:username>?</urn:username>
    <urn:password>?</urn:password>
</urn:loginHeader>

Request

Name

Type

Cardinality

Description

distributorPersonID

string256

1...1

userID

string256

0...1

Filled when person is linked c.q. prematched, empty when person in unlinked.

Source

 <urn:prematchChangedRequest>
    <urn:distributorPersonID>?</urn:distributorPersonID>
    <!--Optional:-->
    <urn:userID>?</urn:userID>
 </urn:prematchChangedRequest>

Response

Empty response

Error codes

Error code	Description
6	Validation error

specificationChanged

Description

The Edu-iX specifyengine continuously attempts to specify licenses to available LIKA environments. In either the case of a successful or failed specification, a notify message will be produced and delivered on the specificationChanged operation. Only the owner of a credit receives a message. The message to be delivered contains information about the status of the specification and additional information.

eckSpecification

This element is filled when a normal credit is specified.

eckCorrection

This element is filled when a normal credit is returned and when a return credit is processed. Whether the credit is a normal credit or a return credit, can be determined using the distributorCreditID value.

eckLicenseBlock

This element is filled when an EBF credit is blocked or unblocked (after specification).

Authentication

Name

Type

Cardinality

loginHeader

1...1

Source

 <urn:loginHeader>
    <urn:username>?</urn:username>
    <urn:password>?</urn:password>
</urn:loginHeader>

Request

Name

Type

Cardinality

distributorCreditID

string160

1...1

isSingleUpdate

boolean

1...1

eckSpecification

0...n

eckCorrection

0...n

eckLicenseBlock

0…n

Source

 <urn:specificationChangedRequest>
    <urn:distributorCreditID>?</urn:distributorCreditID>
    <urn:isSingleUpdate>?</urn:isSingleUpdate>
    <!--Zero or more repetitions:-->
    <urn:eckSpecification>
       <urn:auditID>?</urn:auditID>
       <urn:amount>?</urn:amount>
       <urn:requestID>?</urn:requestID>
       <!--Optional:-->
       <urn:responseID>?</urn:responseID>
       <urn:ownerID>?</urn:ownerID>
       <!--Optional:-->
       <urn:state>?</urn:state>
       <!--Optional:-->
       <urn:errorCode>?</urn:errorCode>
       <urn:timeStamp>?</urn:timeStamp>
    </urn:eckSpecification>
    <!--Zero or more repetitions:-->
    <urn:eckCorrection>
       <urn:auditID>?</urn:auditID>
       <urn:amount>?</urn:amount>
       <urn:requestID>?</urn:requestID>
       <!--Optional:-->
       <urn:responseID>?</urn:responseID>
       <!--Optional:-->
       <urn:state>?</urn:state>
       <!--Optional:-->
       <urn:errorCode>?</urn:errorCode>
       <urn:timeStamp>?</urn:timeStamp>
    </urn:eckCorrection>
    <!--Zero or more repetitions:-->
    <urn:eckLicenseBlock>
       <urn:requestID>?</urn:requestID>
       <!--Optional:-->
       <urn:specificationID>?</urn:specificationID>
       <!--Optional:-->
       <urn:responseID>?</urn:responseID>
       <!--Optional:-->
       <urn:blockType>?</urn:blockType>
       <!--Optional:-->
       <urn:state>?</urn:state>
       <!--Optional:-->
       <urn:errorCode>?</urn:errorCode>
       <!--Optional:-->
       <urn:errorMessage>?</urn:errorMessage>
       <urn:timeStamp>?</urn:timeStamp>
    </urn:eckLicenseBlock>
 </urn:specificationChangedRequest>

Response

Successful calls return an empty response. In case of an error, a Fault is returned.

Error codes

Error code	Description
6	Validation error

Error codes

General errors

Error code	Description
0	Unkown error
1	General error This occurs in for example: database errors or internal server errors.
2	Authentication error For instance when invalid credentials are provided.
3	Session expired The given sessionID is no longer active and has expired. Acquire a new sessionID to proceed.
4	Authorization error You do not have permission to use this operation.
5	Bad request Parsing error, for instance when invalid xml has been provided.
6	Validation error One or more fields do not meet the XSD constraints.

Complex Types

loginHeader

Name

Type

Cardinality

Description

username

string100

0...1

password

string64

0...1

Source

 <xs:complexType name="loginHeader">
 	<xs:sequence>
    	<xs:element name="username" type="types:string100" minOccurs="0" maxOccurs="1"/>
    	<xs:element name="password" type="types:string64" minOccurs="0" maxOccurs="1"/>
 	</xs:sequence>
</xs:complexType>

eckCorrection

Name	Type	Cardinality	Description
auditID	integer	1...1	Unique identifier of the specify action
amount	amount	1...1
requestID	string160	1...1	Unique identifier of the correction.
responseID	string160	0...1	Response identifier of the correction.
state	specifyState	0...1
errorCode	integer	0...1
errorMessage	string	0...1
timeStamp	dateTime	1...1

eckSpecification

Name	Type	Cardinality	Description
auditID	integer	1...1	Unique identifier of the specify action
amount	amount	1...1
requestID	string160	1...1	Unique identifier of the specification.
responseID	string160	0...1	Response identifier of the specification.
ownerID	string256	1...1	Identifier of the owner of the specification (userID in case of an EBF, organisationID in case of IBF).
state	specifyState	0...1
errorCode	integer	0...1
errorMessage	string	0...1
timeStamp	dateTime	1...1

eckLicenseBlock

Name	Type	Cardinality	Description
auditID	integer	1...1	Unique identifier of the block/unblock action (is different to eckCorrection and eckSpecification auditID).
requestID	string160	1...1	Unique identifier of the block request (automatically generated by Edu-iX)
specificationID	string160	1...1	Identifier of the specification which is blocked/unblocked (see requestID field of eckSpecification element)
responseID	string160	0...1	Response identifier when the block/unblock request is successfully executed.
blockType	blockType	1...1
state	blockState	0...1
errorCode	integer	0...1
errorMessage	string	0...1
timeStamp	dateTime	1...1

Simple Types

Name	Type	Possible values / format	Description
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.
string160	String	Max length: 160 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.
specifyState	Enum	Possible values: specified returned transport_error external_error internal_error
blockState	Enum	Possible values: blocked unblocked transport_error internal_error external_error
blockType	Enum	Possible values: block unblock
amount	Integer	Minimal value must be at least 1