Versions Compared

Key

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

...

Name

Type

Cardinality

loginHeader

loginHeader

1...1

Source

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

...

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

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

...

Error codes

Error code

Description

6

Validation error

...

specificationChanged

Description

...

Name

Type

Cardinality

loginHeader

loginHeader

1...1

Source

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

...

Name

Type

Cardinality

distributorCreditID

string160

1...1

isSingleUpdate

boolean

1...1

eckSpecification

eckSpecification

0...n

eckCorrection

eckCorrection

0...n

eckLicenseBlock

eckLicenseBlock

0…n

Source

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

...

Error codes

Error code

Description

6

Validation error

...

Error codes

General errors

...

Name

Type

Cardinality

Description

username

string100

0...1


password

string64

0...1


Source

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

...

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


...

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


...

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


...