...
Name | Type | Cardinality | Description |
|---|
loginHeader sessionIDHeader | loginHeader sessionIDHeader | 1...1 1...1 | You can choose use either one of the variables |
Source | Code Block |
|---|
<urn:authHeader>
<!--You have a CHOICE of the next 2 items at this level-->
<urn:loginHeader>
<!--Optional:-->
<urn:username>?</urn:username>
<!--Optional:-->
<urn:password>?</urn:password>
</urn:loginHeader>
<urn:sessionIDHeader>
<urn:sessionID>?</urn:sessionID>
</urn:sessionIDHeader>
</urn:authHeader> |
|
...
Authentication
Name | Type | Cardinality | Description |
|---|
loginHeader | loginHeader | 1...1 | |
Source | Code Block |
|---|
<urn:loginHeader>
<!--Optional:-->
<urn:username>?</urn:username>
<!--Optional:-->
<urn:password>?</urn:password>
</urn:loginHeader> |
|
Request
Empty request
Response
Name | Type | Cardinality | Description |
|---|
sessionID | string64 | 1...1 | |
Error codes
...
The userID or eckID is used to retrieve credits of a specific person. Ean, start- & endDate can be used to filter for specific credits.
Name | Type | Cardinality | You have a CHOICE of the next 2 items at this levelDescription |
|---|
userID eckID | string256 eckID | 1...1 1...1 | You can use either one of these variables |
startDate | date | 0...1 | |
endDate | date | 0...1 | |
ean | string160 | 0...1 | |
Source | Code Block |
|---|
<urn:getPersonCreditRequest>
<!--You have a CHOICE of the next 2 items at this level-->
<!--Optional:-->
<urn:userID>?</urn:userID>
<!--Optional:-->
<urn:eckID>?</urn:eckID>
<!--Optional:-->
<urn:startDate>?</urn:startDate>
<!--Optional:-->
<urn:endDate>?</urn:endDate>
<!--Optional:-->
<urn:ean>?</urn:ean>
</urn:getPersonCreditRequest> |
|
Response
The response contains 0 to all credits found for a specific person. In case of an error, a Fault object is returned.
Name | Type | Cardinality | Description |
|---|
personCreditInformation | personCreditInformation | 0...n | |
Source | Code Block |
|---|
<urn:getPersonCreditResponse>
<!--Zero or more repetitions:-->
<urn:personCreditInformation>
<urn:personCredit>
<urn:ean>?</urn:ean>
<urn:startDate>?</urn:startDate>
<!--Optional:-->
<urn:endDate>?</urn:endDate>
<urn:state>?</urn:state>
</urn:personCredit>
</urn:personCreditInformation>
</urn:getPersonCreditResponse> |
|
Error codes
Error code | Description |
|---|
6 | Missing required field(s) |
...
The userID or eckID is used to retrieve credits of a specific person. Ean, start- & endDate can be used to filter for specific credits.
Name | Type | Cardinality | You have a CHOICE of the next 2 items at this levelDescription |
|---|
userID eckID | string256 eckID | 1...1 1...1 | You can use either one of these variables |
startDate | date | 0...1 | |
endDate | date | 0...1 | |
ean | string160 | 0...1 | |
Source | Code Block |
|---|
<urn:getPersonCreditRawRequest>
<!--You have a CHOICE of the next 2 items at this level-->
<!--Optional:-->
<urn:userID>?</urn:userID>
<!--Optional:-->
<urn:eckID>?</urn:eckID>
<!--Optional:-->
<urn:startDate>?</urn:startDate>
<!--Optional:-->
<urn:endDate>?</urn:endDate>
<!--Optional:-->
<urn:ean>?</urn:ean>
</urn:getPersonCreditRawRequest> |
|
Response
The response contains 0 to all credits found for a specific person. In case of an error, a Fault object is returned.
Name | Type | Cardinality | Description |
|---|
personCreditInformation | personCreditInformation | 0...n | |
Source | Code Block |
|---|
<urn:getPersonCreditRawResponse>
<!--Zero or more repetitions:-->
<urn:personCreditInformation>
<urn:personCredit>
<urn:ean>?</urn:ean>
<urn:startDate>?</urn:startDate>
<!--Optional:-->
<urn:endDate>?</urn:endDate>
<urn:state>?</urn:state>
</urn:personCredit>
</urn:personCreditInformation>
</urn:getPersonCreditRawResponse> |
|
Error codes
Error code | Description |
|---|
6 | Missing required field(s) |
...
Credits of a specifc school are retrieved based on the organisationID. Ean, start- & endDate can be used to filter for specific credits.
Name | Type | Cardinality | Description |
|---|
organisationID | organisationID | 1...1 | |
startDate | date | 0...1 | |
endDate | date | 0...1 | |
ean | string160 | 0...1 | |
Source | Code Block |
|---|
<urn:getSchoolCreditRequest>
<urn:organisationID>?</urn:organisationID>
<!--Optional:-->
<urn:ean>?</urn:ean>
<!--Optional:-->
<urn:startDate>?</urn:startDate>
<!--Optional:-->
<urn:endDate>?</urn:endDate>
</urn:getSchoolCreditRequest> |
|
Response
The response contains 0 to all credits found for a specific school. In case of an error, a Fault object is returned.
Name | Type | Cardinality | Description |
|---|
schoolCreditInformation | schoolCreditInformation | 0...n | |
Source | Code Block |
|---|
<urn:getSchoolCreditResponse>
<!--Zero or more repetitions:-->
<urn:schoolCreditInformation>
<urn:schoolCredit>
<urn:organisationID>?</urn:organisationID>
<urn:ean>?</urn:ean>
<urn:startDate>?</urn:startDate>
<!--Optional:-->
<urn:endDate>?</urn:endDate>
</urn:schoolCredit>
<!--Optional:-->
<urn:amountActive>?</urn:amountActive>
<!--Optional:-->
<urn:amountNotActive>?</urn:amountNotActive>
</urn:schoolCreditInformation>
</urn:getSchoolCreditResponse> |
|
Error codes
Error code | Description |
|---|
6 | Missing required field(s) |
...
Credits of a specifc school are retrieved based on the organisationID. Ean, start- & endDate can be used to filter for specific credits.
Name | Type | Cardinality | Description |
|---|
organisationID | organisationID | 1...1 | |
startDate | date | 0...1 | |
endDate | date | 0...1 | |
ean | string160 | 0...1 | |
Source | Code Block |
|---|
<urn:getSummedSchoolCreditRequest>
<urn:organisationID>?</urn:organisationID>
<!--Optional:-->
<urn:ean>?</urn:ean>
<!--Optional:-->
<urn:startDate>?</urn:startDate>
<!--Optional:-->
<urn:endDate>?</urn:endDate>
</urn:getSummedSchoolCreditRequest> |
|
Response
The response contains 0 to all summed credits found for a specific school. In case of an error, a Fault object is returned.
Name | Type | Cardinality | Description |
|---|
summedSchoolCredit | summedSchoolCredit | 0...n | |
Source | Code Block |
|---|
<urn:getSummedSchoolCreditResponse>
<!--Zero or more repetitions:-->
<urn:summedSchoolCredit>
<urn:ean>?</urn:ean>
<urn:amount>?</urn:amount>
<!--Optional:-->
<urn:used>?</urn:used>
</urn:summedSchoolCredit>
</urn:getSummedSchoolCreditResponse> |
|
Error codes
Error code | Description |
|---|
6 | Missing required field(s) |
...