| WSDL | Endpoint | |
|---|---|---|
| Production | https://lika.edu-ix.nl/soap/4.0/profile/wsdl | https://lika.edu-ix.nl/soap/4.0/profile |
| Sandbox | https://acc-lika.edu-ix.nl/soap/4.0/profile/wsdl | https://acc-lika.edu-ix.nl/soap/4.0/profile |
Returns a profile.
| Header | [authHeader Object] | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Request |
getEduProfileRequest
|
||||||||||||||||||||||||||||||||||||||||||||
| Response |
getEduProfileResponse
|
||||||||||||||||||||||||||||||||||||||||||||
| Fault | [Fault Object] | ||||||||||||||||||||||||||||||||||||||||||||
| CRUD | Read | ||||||||||||||||||||||||||||||||||||||||||||
| Role(s) | This function is not limited to specific roles. | ||||||||||||||||||||||||||||||||||||||||||||
| Errors |
In case of an error in the server or application, a Fault-element will be returned, containing more detailed information.
| Element | Description | Type | Card. |
|---|---|---|---|
| code | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. | Attr | [1..1] |
| message | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. | Attr | [1..1] |
Header for authentication. It can contain either a loginHeader-element or a sessionIDHeader-element
| Element | Description | Type | Card. |
|---|---|---|---|
| loginHeader | Header object for authentication with username and password | Obj | [1..1] |
| Attribute | Length | Type | Description |
|---|---|---|---|
| affiliation | 50 | string | String with minimum length 1 and maximum allowed length 50 |
| code | 10 | integer | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. |
| digiDeliveryID | 256 | string | String with minimum length 1 and maximum allowed length 256 |
| givenName | 50 | string | String with minimum length 1 and maximum allowed length 50 |
| homeOrganization | 50 | string | String with minimum length 1 and maximum allowed length 50 |
| homeOrganizationID | 6 | string | String with minimum length 4 and maximum allowed length 6 |
| message | 4096 | string | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. |
| password | 64 | string | Password for authentication access to service |
| personProfileID | 256 | string | String with minimum length 1 and maximum allowed length 256 |
| personRealID | 256 | string | String with minimum length 1 and maximum allowed length 256 |
| personTussenvoegsels | 15 | string | String with minimum length 1 and maximum allowed length 15 |
| redirectSessionID | 160 | string | String with minimum length 1 and maximum allowed length 160 |
| sn | 50 | string | String with minimum length 1 and maximum allowed length 50 |
| uid | 256 | string | String with minimum length 1 and maximum allowed length 256 |
| username | 100 | string | Username for authentication on a service |
| Code | Field | Description | Type |
|---|---|---|---|
| 20 | authHeader -> loginHeader | Missing | Object |
| 28 | authHeader -> loginHeader | Not Authorized | Object |
| 40 | loginHeader -> username | Missing | Attribute |
| 41 | loginHeader -> username | Value is too small. (Min 1) | Attribute |
| 42 | loginHeader -> username | Value is too long. (Max 100) | Attribute |
| 45 | loginHeader -> username | Incorrect type. Must be string. | Attribute |
| 48 | loginHeader -> username | Not Authorized | Attribute |
| 60 | loginHeader -> password | Missing | Attribute |
| 61 | loginHeader -> password | Value is too small. (Min 1) | Attribute |
| 62 | loginHeader -> password | Value is too long. (Max 64) | Attribute |
| 65 | loginHeader -> password | Incorrect type. Must be string. | Attribute |
| 68 | loginHeader -> password | Not Authorized | Attribute |
| 80 | getEduProfileRequest -> redirectSessionID | Missing | Attribute |
| 81 | getEduProfileRequest -> redirectSessionID | Value is too small. (Min 1) | Attribute |
| 82 | getEduProfileRequest -> redirectSessionID | Value is too long. (Max 160) | Attribute |
| 85 | getEduProfileRequest -> redirectSessionID | Incorrect type. Must be string. | Attribute |
| 87 | getEduProfileRequest -> redirectSessionID | Not found | Attribute |
| 88 | getEduProfileRequest -> redirectSessionID | Not Authorized | Attribute |
| 1000 | Fault -> code | Missing | Attribute |
| 1005 | Fault -> code | Incorrect type. Must be integer. | Attribute |
| 1007 | Fault -> code | Not found | Attribute |
| 1008 | Fault -> code | Not Authorized | Attribute |
| 1160 | Fault -> message | Missing | Attribute |
| 1162 | Fault -> message | Value is too long. (Max 4096) | Attribute |
| 1165 | Fault -> message | Incorrect type. Must be string. | Attribute |
| 1167 | Fault -> message | Not found | Attribute |
| 1168 | Fault -> message | Not Authorized | Attribute |
Credit service
| WSDL | Endpoint | |
|---|---|---|
| Production | https://lika.edu-ix.nl/soap/4.0/credit/wsdl | https://lika.edu-ix.nl/soap/4.0/credit |
| Sandbox | https://acc-lika.edu-ix.nl/soap/4.0/credit/wsdl | https://acc-lika.edu-ix.nl/soap/4.0/credit |
Retrieve zero or more personcredits.
| Header | [authHeader Object] | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Request |
getPersonCreditRequest
|
||||||||||||||||||||||||||||||||||||||||
| Response |
getPersonCreditResponse
|
||||||||||||||||||||||||||||||||||||||||
| Fault | [Fault Object] | ||||||||||||||||||||||||||||||||||||||||
| CRUD | Read | ||||||||||||||||||||||||||||||||||||||||
| Role(s) |
|
||||||||||||||||||||||||||||||||||||||||
| Errors | |||||||||||||||||||||||||||||||||||||||||
Retrieve zero or more schoolcredits.
| Header | [authHeader Object] | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Request |
getSchoolCreditRequest
|
||||||||||||||||
| Response |
getSchoolCreditResponse
|
||||||||||||||||
| Fault | [Fault Object] | ||||||||||||||||
| CRUD | Read | ||||||||||||||||
| Role(s) | This function is not limited to specific roles. | ||||||||||||||||
| Errors |
In case of an error in the server or application, a Fault-element will be returned, containing more detailed information.
| Element | Description | Type | Card. |
|---|---|---|---|
| code | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. | Attr | [1..1] |
| message | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. | Attr | [1..1] |
Header for authentication. It can contain either a loginHeader-element or a sessionIDHeader-element
| Element | Description | Type | Card. |
|---|---|---|---|
| loginHeader | Header object for authentication with username and password | Obj | [1..1] |
License information object
| Element | Description | Type | Card. |
|---|---|---|---|
| activationDate | Date on which a license was activated | Attr | [0..1] |
| licenseStartDate | Start date of a license | Attr | [0..1] |
| licenseEndDate | End date of a license. | Attr | [0..1] |
Header object for authentication with username and password
| Element | Description | Type | Card. |
|---|---|---|---|
| username | Username for authentication on a service | Attr | [1..1] |
| password | Password for authentication access to service | Attr | [1..1] |
A personcredit is an entity that contains credit information on a product for a individual person.
| Element | Description | Type | Card. |
|---|---|---|---|
| ean | EAN, following the EAN-13 standard | Attr | [1..1] |
| creditStartDate | The date from which the credit will be available. | Attr | [1..1] |
| creditEndDate | The date until which the personcredit will be available. | Attr | [0..1] |
| personProductState | State of a personcredit entity. The state Returned can never be changed by the create or update functions. This state wil be set by the returnCredit-function. | Attr | [1..1] |
| schoolYear | A representation of a school year | Attr | [1..1] |
A object containing all information about a personCredit.
| Element | Description | Type | Card. |
|---|---|---|---|
| personCredit | A personcredit is an entity that contains credit information on a product for a individual person. | Obj | [1..1] |
| specification | Information about the specification of a credit. | Obj | [0..1] |
| license | License information object | Obj | [0..1] |
A schoolCredit is an entity that contains credit information on a product available to all users of a school.
| Element | Description | Type | Card. |
|---|---|---|---|
| organisationID | organisationID | Attr | [1..1] |
| ean | EAN, following the EAN-13 standard | Attr | [1..1] |
| creditStartDate | The date from which the credit will be available. | Attr | [1..1] |
| creditEndDate | The date until which the personcredit will be available. | Attr | [0..1] |
| schoolYear | A representation of a school year | Attr | [1..1] |
| amountNotActive | not active amount | Attr | [1..1] |
| amountActive | active amount | Attr | [1..1] |
| amountInProcess | amount being processed at te moment | Attr | [1..1] |
| amountExpired | expired amount | Attr | [1..1] |
Information about a schoolCredit.
| Element | Description | Type | Card. |
|---|---|---|---|
| schoolCredit | A schoolCredit is an entity that contains credit information on a product available to all users of a school. | Obj | [1..1] |
| specification | Information about the specification of a credit. | Obj | [0..1] |
| license | License information object | Obj | [0..n] |
Information about the specification of a credit.
| Element | Description | Type | Card. |
|---|---|---|---|
| specificationState | The state of the specification of a credit. | Attr | [0..1] |
| specificationStateDate | The date on which the specificationState was set. | Attr | [1..1] |
| Attribute | Length | Type | Description |
|---|---|---|---|
| activationDate | date |
Date on which a license was activated format: [YYYY]-[MM]-[DD] |
|
| amountActive | 10 | integer | active amount |
| amountExpired | 10 | integer | expired amount |
| amountInProcess | 10 | integer | amount being processed at te moment |
| amountNotActive | 10 | integer | not active amount |
| code | 10 | integer | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. |
| creditEndDate | date |
The date until which the personcredit will be available. format: [YYYY]-[MM]-[DD] |
|
| creditStartDate | date |
The date from which the credit will be available. format: [YYYY]-[MM]-[DD] |
|
| ean | 30 | string | EAN, following the EAN-13 standard |
| eckID | 128 | string | EckId, The derived ECK ID. |
| licenseEndDate | date |
End date of a license. format: [YYYY]-[MM]-[DD] |
|
| licenseStartDate | date |
Start date of a license format: [YYYY]-[MM]-[DD] |
|
| message | 4096 | string | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. |
| organisationID | 40 | string | organisationID |
| password | 64 | string | Password for authentication access to service |
| personProductState | enum |
State of a personcredit entity. The state Returned can never be changed by the create or update functions. This state wil be set by the returnCredit-function. possible values: Active, Returned |
|
| redirectSessionID | 160 | string | String with minimum length 1 and maximum allowed length 160 |
| schoolYear | 4 | integer |
A representation of a school year rules: When substracting the first group of two numbers from the second group of two numbers, the result should be "1". |
| specificationState | 1 | enum |
The state of the specification of a credit. possible values: Fault, Specified |
| specificationStateDate | date |
The date on which the specificationState was set. format: [YYYY]-[MM]-[DD] |
|
| userID | 100 | string | Unique identifier for a portal user |
| username | 100 | string | Username for authentication on a service |
| Code | Field | Description | Type |
|---|---|---|---|
| 20 | authHeader -> loginHeader | Missing | Object |
| 28 | authHeader -> loginHeader | Not Authorized | Object |
| 40 | loginHeader -> username | Missing | Attribute |
| 41 | loginHeader -> username | Value is too small. (Min 1) | Attribute |
| 42 | loginHeader -> username | Value is too long. (Max 100) | Attribute |
| 45 | loginHeader -> username | Incorrect type. Must be string. | Attribute |
| 48 | loginHeader -> username | Not Authorized | Attribute |
| 60 | loginHeader -> password | Missing | Attribute |
| 61 | loginHeader -> password | Value is too small. (Min 1) | Attribute |
| 62 | loginHeader -> password | Value is too long. (Max 64) | Attribute |
| 65 | loginHeader -> password | Incorrect type. Must be string. | Attribute |
| 68 | loginHeader -> password | Not Authorized | Attribute |
| 300 | getPersonCreditRequestChoice -> redirectSessionID | Missing | Attribute |
| 301 | getPersonCreditRequestChoice -> redirectSessionID | Value is too small. (Min 1) | Attribute |
| 302 | getPersonCreditRequestChoice -> redirectSessionID | Value is too long. (Max 160) | Attribute |
| 305 | getPersonCreditRequestChoice -> redirectSessionID | Incorrect type. Must be string. | Attribute |
| 308 | getPersonCreditRequestChoice -> redirectSessionID | Not Authorized | Attribute |
| 320 | getPersonCreditRequestChoice -> eckID | Missing | Attribute |
| 321 | getPersonCreditRequestChoice -> eckID | Value is too small. (Min 128) | Attribute |
| 322 | getPersonCreditRequestChoice -> eckID | Value is too long. (Max 128) | Attribute |
| 325 | getPersonCreditRequestChoice -> eckID | Incorrect type. Must be string. | Attribute |
| 328 | getPersonCreditRequestChoice -> eckID | Not Authorized | Attribute |
| 340 | getPersonCreditRequestChoice -> userID | Missing | Attribute |
| 341 | getPersonCreditRequestChoice -> userID | Value is too small. (Min 1) | Attribute |
| 342 | getPersonCreditRequestChoice -> userID | Value is too long. (Max 100) | Attribute |
| 345 | getPersonCreditRequestChoice -> userID | Incorrect type. Must be string. | Attribute |
| 348 | getPersonCreditRequestChoice -> userID | Not Authorized | Attribute |
| 360 | getPersonCreditRequest -> (choice element) | Missing | Object |
| 367 | getPersonCreditRequest -> (choice element) | Not found | Object |
| 368 | getPersonCreditRequest -> (choice element) | Not Authorized | Object |
| 381 | getPersonCreditRequest -> ean | Value is too small. (Min 1) | Attribute |
| 382 | getPersonCreditRequest -> ean | Value is too long. (Max 30) | Attribute |
| 385 | getPersonCreditRequest -> ean | Incorrect type. Must be string. | Attribute |
| 387 | getPersonCreditRequest -> ean | Not found | Attribute |
| 388 | getPersonCreditRequest -> ean | Not Authorized | Attribute |
| 405 | getPersonCreditRequest -> schoolYear | Incorrect type. Must be integer. | Attribute |
| 407 | getPersonCreditRequest -> schoolYear | Not found | Attribute |
| 408 | getPersonCreditRequest -> schoolYear | Not Authorized | Attribute |
| 440 | personCreditInformation -> personCredit | Missing | Object |
| 447 | personCreditInformation -> personCredit | Not found | Object |
| 448 | personCreditInformation -> personCredit | Not Authorized | Object |
| 467 | personCreditInformation -> specification | Not found | Object |
| 468 | personCreditInformation -> specification | Not Authorized | Object |
| 487 | personCreditInformation -> license | Not found | Object |
| 488 | personCreditInformation -> license | Not Authorized | Object |
| 500 | personCredit -> ean | Missing | Attribute |
| 501 | personCredit -> ean | Value is too small. (Min 1) | Attribute |
| 502 | personCredit -> ean | Value is too long. (Max 30) | Attribute |
| 505 | personCredit -> ean | Incorrect type. Must be string. | Attribute |
| 507 | personCredit -> ean | Not found | Attribute |
| 508 | personCredit -> ean | Not Authorized | Attribute |
| 520 | personCredit -> creditStartDate | Missing | Attribute |
| 523 | personCredit -> creditStartDate | Incorrect format. (yyyy-mm-dd) | Attribute |
| 527 | personCredit -> creditStartDate | Not found | Attribute |
| 528 | personCredit -> creditStartDate | Not Authorized | Attribute |
| 543 | personCredit -> creditEndDate | Incorrect format. (yyyy-mm-dd) | Attribute |
| 547 | personCredit -> creditEndDate | Not found | Attribute |
| 548 | personCredit -> creditEndDate | Not Authorized | Attribute |
| 560 | personCredit -> personProductState | Missing | Attribute |
| 564 | personCredit -> personProductState | Value is not allowed | Attribute |
| 567 | personCredit -> personProductState | Not found | Attribute |
| 568 | personCredit -> personProductState | Not Authorized | Attribute |
| 580 | personCredit -> schoolYear | Missing | Attribute |
| 585 | personCredit -> schoolYear | Incorrect type. Must be integer. | Attribute |
| 587 | personCredit -> schoolYear | Not found | Attribute |
| 588 | personCredit -> schoolYear | Not Authorized | Attribute |
| 604 | specification -> specificationState | Value is not allowed | Attribute |
| 607 | specification -> specificationState | Not found | Attribute |
| 608 | specification -> specificationState | Not Authorized | Attribute |
| 620 | specification -> specificationStateDate | Missing | Attribute |
| 623 | specification -> specificationStateDate | Incorrect format. (yyyy-mm-dd) | Attribute |
| 627 | specification -> specificationStateDate | Not found | Attribute |
| 628 | specification -> specificationStateDate | Not Authorized | Attribute |
| 643 | license -> activationDate | Incorrect format. (yyyy-mm-dd) | Attribute |
| 647 | license -> activationDate | Not found | Attribute |
| 648 | license -> activationDate | Not Authorized | Attribute |
| 663 | license -> licenseStartDate | Incorrect format. (yyyy-mm-dd) | Attribute |
| 667 | license -> licenseStartDate | Not found | Attribute |
| 668 | license -> licenseStartDate | Not Authorized | Attribute |
| 683 | license -> licenseEndDate | Incorrect format. (yyyy-mm-dd) | Attribute |
| 687 | license -> licenseEndDate | Not found | Attribute |
| 688 | license -> licenseEndDate | Not Authorized | Attribute |
| 700 | getSchoolCreditRequest -> organisationID | Missing | Attribute |
| 701 | getSchoolCreditRequest -> organisationID | Value is too small. (Min 1) | Attribute |
| 702 | getSchoolCreditRequest -> organisationID | Value is too long. (Max 40) | Attribute |
| 705 | getSchoolCreditRequest -> organisationID | Incorrect type. Must be string. | Attribute |
| 707 | getSchoolCreditRequest -> organisationID | Not found | Attribute |
| 708 | getSchoolCreditRequest -> organisationID | Not Authorized | Attribute |
| 721 | getSchoolCreditRequest -> ean | Value is too small. (Min 1) | Attribute |
| 722 | getSchoolCreditRequest -> ean | Value is too long. (Max 30) | Attribute |
| 725 | getSchoolCreditRequest -> ean | Incorrect type. Must be string. | Attribute |
| 727 | getSchoolCreditRequest -> ean | Not found | Attribute |
| 728 | getSchoolCreditRequest -> ean | Not Authorized | Attribute |
| 745 | getSchoolCreditRequest -> schoolYear | Incorrect type. Must be integer. | Attribute |
| 747 | getSchoolCreditRequest -> schoolYear | Not found | Attribute |
| 748 | getSchoolCreditRequest -> schoolYear | Not Authorized | Attribute |
| 780 | schoolCreditInformation -> schoolCredit | Missing | Object |
| 787 | schoolCreditInformation -> schoolCredit | Not found | Object |
| 788 | schoolCreditInformation -> schoolCredit | Not Authorized | Object |
| 807 | schoolCreditInformation -> specification | Not found | Object |
| 808 | schoolCreditInformation -> specification | Not Authorized | Object |
| 827 | schoolCreditInformation -> license | Not found | Object |
| 828 | schoolCreditInformation -> license | Not Authorized | Object |
| 840 | schoolCredit -> organisationID | Missing | Attribute |
| 841 | schoolCredit -> organisationID | Value is too small. (Min 1) | Attribute |
| 842 | schoolCredit -> organisationID | Value is too long. (Max 40) | Attribute |
| 845 | schoolCredit -> organisationID | Incorrect type. Must be string. | Attribute |
| 847 | schoolCredit -> organisationID | Not found | Attribute |
| 848 | schoolCredit -> organisationID | Not Authorized | Attribute |
| 860 | schoolCredit -> creditStartDate | Missing | Attribute |
| 861 | schoolCredit -> ean | Value is too small. (Min 1) | Attribute |
| 862 | schoolCredit -> ean | Value is too long. (Max 30) | Attribute |
| 863 | schoolCredit -> creditStartDate | Incorrect format. (yyyy-mm-dd) | Attribute |
| 865 | schoolCredit -> ean | Incorrect type. Must be string. | Attribute |
| 867 | schoolCredit -> creditStartDate | Not found | Attribute |
| 868 | schoolCredit -> creditStartDate | Not Authorized | Attribute |
| 883 | schoolCredit -> creditEndDate | Incorrect format. (yyyy-mm-dd) | Attribute |
| 887 | schoolCredit -> creditEndDate | Not found | Attribute |
| 888 | schoolCredit -> creditEndDate | Not Authorized | Attribute |
| 900 | schoolCredit -> amountNotActive | Missing | Attribute |
| 905 | schoolCredit -> amountNotActive | Incorrect type. Must be integer. | Attribute |
| 907 | schoolCredit -> amountNotActive | Not found | Attribute |
| 908 | schoolCredit -> amountNotActive | Not Authorized | Attribute |
| 920 | schoolCredit -> amountActive | Missing | Attribute |
| 925 | schoolCredit -> amountActive | Incorrect type. Must be integer. | Attribute |
| 927 | schoolCredit -> amountActive | Not found | Attribute |
| 928 | schoolCredit -> amountActive | Not Authorized | Attribute |
| 940 | schoolCredit -> amountInProcess | Missing | Attribute |
| 945 | schoolCredit -> amountInProcess | Incorrect type. Must be integer. | Attribute |
| 947 | schoolCredit -> amountInProcess | Not found | Attribute |
| 948 | schoolCredit -> amountInProcess | Not Authorized | Attribute |
| 960 | schoolCredit -> amountExpired | Missing | Attribute |
| 965 | schoolCredit -> amountExpired | Incorrect type. Must be integer. | Attribute |
| 967 | schoolCredit -> amountExpired | Not found | Attribute |
| 968 | schoolCredit -> amountExpired | Not Authorized | Attribute |
| 980 | schoolCredit -> schoolYear | Missing | Attribute |
| 985 | schoolCredit -> schoolYear | Incorrect type. Must be integer. | Attribute |
| 987 | schoolCredit -> schoolYear | Not found | Attribute |
| 988 | schoolCredit -> schoolYear | Not Authorized | Attribute |
| 1000 | Fault -> code | Missing | Attribute |
| 1005 | Fault -> code | Incorrect type. Must be integer. | Attribute |
| 1007 | Fault -> code | Not found | Attribute |
| 1008 | Fault -> code | Not Authorized | Attribute |
| 1160 | Fault -> message | Missing | Attribute |
| 1162 | Fault -> message | Value is too long. (Max 4096) | Attribute |
| 1165 | Fault -> message | Incorrect type. Must be string. | Attribute |
| 1167 | Fault -> message | Not found | Attribute |
| 1168 | Fault -> message | Not Authorized | Attribute |
Product service
| WSDL | Endpoint | |
|---|---|---|
| Production | https://lika.edu-ix.nl/soap/4.0/product/wsdl | https://lika.edu-ix.nl/soap/4.0/product |
| Sandbox | https://acc-lika.edu-ix.nl/soap/4.0/product/wsdl | https://acc-lika.edu-ix.nl/soap/4.0/product |
Using the getProducts call you can retrieve products from the Eduroute content library which belongs to your Publishers account. Using the available elements, you can filter the result. This function has a maximum of 100 products in the result.
| Header | [authHeader Object] | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Request |
getProductRequest
|
||||||||||||||||||||||||||||
| Response |
getProductResponse
|
||||||||||||||||||||||||||||
| Fault | [Fault Object] | ||||||||||||||||||||||||||||
| CRUD | Read | ||||||||||||||||||||||||||||
| Role(s) | This function is not limited to specific roles. | ||||||||||||||||||||||||||||
| Errors | |||||||||||||||||||||||||||||
Using the createProduct call you can add a product to the content library of Eduroute. If a product (identified by EAN) already exists, you need to use the updateProduct function instead.
| Header | [authHeader Object] | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Request |
createProductRequest
|
||||||||
| Response |
createProductResponse
|
||||||||
| Fault | [Fault Object] | ||||||||
| CRUD | Create | ||||||||
| Role(s) | This function is not limited to specific roles. | ||||||||
| Errors |
Using the updateProduct function you can update an existing product in the Edu-iX content library. Publishers can only update their own content. If the product does not exist in the Edu-iX content library, please use the createProduct call instead.
| Header | [authHeader Object] | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Request |
updateProductRequest
|
||||||||
| Response |
updateProductResponse
|
||||||||
| Fault | [Fault Object] | ||||||||
| CRUD | |||||||||
| Role(s) | This function is not limited to specific roles. | ||||||||
| Errors |
In case of an error in the server or application, a Fault-element will be returned, containing more detailed information.
| Element | Description | Type | Card. |
|---|---|---|---|
| code | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. | Attr | [1..1] |
| message | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. | Attr | [1..1] |
Header for authentication. It can contain either a loginHeader-element or a sessionIDHeader-element
| Element | Description | Type | Card. |
|---|---|---|---|
| loginHeader | Header object for authentication with username and password | Obj | [1..1] |
Object describing a criterion for use in a selection.
| Element | Description | Type | Card. |
|---|---|---|---|
| comparator | The type of comparison | Attr | [1..1] |
| value | The value for use with the comparator | Attr | [1..1] |
Header object for authentication with username and password
| Element | Description | Type | Card. |
|---|---|---|---|
| username | Username for authentication on a service | Attr | [1..1] |
| password | Password for authentication access to service | Attr | [1..1] |
A complextype product which contains the product information
| Element | Description | Type | Card. |
|---|---|---|---|
| ean | EAN, following the EAN-13 standard | Attr | [1..1] |
| title | Product title | Attr | [1..1] |
| ssoUrl | Single Sign-on url van het product. | Attr | [0..1] |
| url | Valid URL | Attr | [1..1] |
| productType | Value indicating the producttype of a product-entity | Attr | [1..1] |
| availableFrom | The date from which an entity will be available | Attr | [0..1] |
| study | Object representing a study | Obj | [0..n] |
| subject | Object representing a subject | Obj | [0..n] |
Product information object
| Element | Description | Type | Card. |
|---|---|---|---|
| product | A complextype product which contains the product information | Obj | [1..1] |
Object describing the criteria for the EAN-value of the entity
| Element | Description | Type | Card. |
|---|---|---|---|
| criterion | Object describing a criterion for use in a selection. | Obj | [1..n] |
Object describing the criteria for the name-value of the entity
| Element | Description | Type | Card. |
|---|---|---|---|
| criterion | Object describing a criterion for use in a selection. | Obj | [1..n] |
| Attribute | Length | Type | Description |
|---|---|---|---|
| availableFrom | date |
The date from which an entity will be available format: [YYYY]-[MM]-[DD] |
|
| code | 10 | integer | Value indicating success, error or warning. "0" means success, negative number means error, positive number means warning. |
| comparator | enum |
The type of comparison possible values: exact, beginsWith, endsWith, contains |
|
| ean | 30 | string | EAN, following the EAN-13 standard |
| message | 4096 | string | Verbose message precisely indicating the cause of the error or warning, and constructively suggesting a solution. |
| name | 50 | string | Name of the current entity |
| password | 64 | string | Password for authentication access to service |
| productType | enum |
Value indicating the producttype of a product-entity possible values: Student, Teacher |
|
| ssoUrl | 250 | string | Single Sign-on url van het product. |
| studyID | 15 | string | Unique identifier for a study |
| subjectID | 100 | string | Unique identifier for a subject |
| title | 4096 | string | Product title |
| url | 250 | string | Valid URL |
| username | 100 | string | Username for authentication on a service |
| value | 250 | string | The value for use with the comparator |
| Code | Field | Description | Type |
|---|---|---|---|
| 20 | authHeader -> loginHeader | Missing | Object |
| 28 | authHeader -> loginHeader | Not Authorized | Object |
| 40 | loginHeader -> username | Missing | Attribute |
| 41 | loginHeader -> username | Value is too small. (Min 1) | Attribute |
| 42 | loginHeader -> username | Value is too long. (Max 100) | Attribute |
| 45 | loginHeader -> username | Incorrect type. Must be string. | Attribute |
| 48 | loginHeader -> username | Not Authorized | Attribute |
| 60 | loginHeader -> password | Missing | Attribute |
| 61 | loginHeader -> password | Value is too small. (Min 1) | Attribute |
| 62 | loginHeader -> password | Value is too long. (Max 64) | Attribute |
| 65 | loginHeader -> password | Incorrect type. Must be string. | Attribute |
| 68 | loginHeader -> password | Not Authorized | Attribute |
| 1000 | Fault -> code | Missing | Attribute |
| 1005 | Fault -> code | Incorrect type. Must be integer. | Attribute |
| 1006 | Fault -> code | Already exists | Attribute |
| 1007 | Fault -> code | Not found | Attribute |
| 1008 | Fault -> code | Not Authorized | Attribute |
| 1020 | searchName -> criterion | Missing | Object |
| 1027 | searchName -> criterion | Not found | Object |
| 1028 | searchName -> criterion | Not Authorized | Object |
| 1048 | getProductRequestChoice -> searchEan | Not Authorized | Object |
| 1060 | updateProductRequest -> product | Missing | Object |
| 1068 | updateProductRequest -> product | Not Authorized | Object |
| 1088 | getProductRequestChoice -> searchName | Not Authorized | Object |
| 1100 | getProductRequest -> (choice element) | Missing | Object |
| 1107 | getProductRequest -> (choice element) | Not found | Object |
| 1108 | getProductRequest -> (choice element) | Not Authorized | Object |
| 1144 | getProductRequest -> productType | Value is not allowed | Attribute |
| 1147 | getProductRequest -> productType | Not found | Attribute |
| 1148 | getProductRequest -> productType | Not Authorized | Attribute |
| 1160 | Fault -> message | Missing | Attribute |
| 1162 | Fault -> message | Value is too long. (Max 4096) | Attribute |
| 1165 | Fault -> message | Incorrect type. Must be string. | Attribute |
| 1166 | Fault -> message | Already exists | Attribute |
| 1167 | Fault -> message | Not found | Attribute |
| 1168 | Fault -> message | Not Authorized | Attribute |
| 1180 | searchEan -> criterion | Missing | Object |
| 1187 | searchEan -> criterion | Not found | Object |
| 1188 | searchEan -> criterion | Not Authorized | Object |
| 1200 | criterion -> comparator | Missing | Attribute |
| 1204 | criterion -> comparator | Value is not allowed | Attribute |
| 1207 | criterion -> comparator | Not found | Attribute |
| 1208 | criterion -> comparator | Not Authorized | Attribute |
| 1223 | product -> availableFrom | Incorrect format. (yyyy-mm-dd) | Attribute |
| 1226 | product -> availableFrom | Already exists | Attribute |
| 1227 | product -> availableFrom | Not found | Attribute |
| 1228 | product -> availableFrom | Not Authorized | Attribute |
| 1246 | product -> subject | Already exists | Object |
| 1247 | product -> subject | Not found | Object |
| 1248 | product -> subject | Not Authorized | Object |
| 1260 | study -> studyID | Missing | Attribute |
| 1261 | study -> studyID | Value is too small. (Min 1) | Attribute |
| 1262 | study -> studyID | Value is too long. (Max 15) | Attribute |
| 1265 | study -> studyID | Incorrect type. Must be string. | Attribute |
| 1266 | study -> studyID | Already exists | Attribute |
| 1267 | study -> studyID | Not found | Attribute |
| 1268 | study -> studyID | Not Authorized | Attribute |
| 1280 | study -> name | Missing | Attribute |
| 1281 | study -> name | Value is too small. (Min 1) | Attribute |
| 1282 | study -> name | Value is too long. (Max 50) | Attribute |
| 1285 | study -> name | Incorrect type. Must be string. | Attribute |
| 1286 | study -> name | Already exists | Attribute |
| 1287 | study -> name | Not found | Attribute |
| 1288 | study -> name | Not Authorized | Attribute |
| 1300 | product -> productType | Missing | Attribute |
| 1304 | product -> productType | Value is not allowed | Attribute |
| 1306 | product -> productType | Already exists | Attribute |
| 1307 | product -> productType | Not found | Attribute |
| 1308 | product -> productType | Not Authorized | Attribute |
| 1320 | product -> url | Missing | Attribute |
| 1321 | product -> url | Value is too small. (Min 1) | Attribute |
| 1322 | product -> url | Value is too long. (Max 250) | Attribute |
| 1325 | product -> url | Incorrect type. Must be string. | Attribute |
| 1326 | product -> url | Already exists | Attribute |
| 1327 | product -> url | Not found | Attribute |
| 1328 | product -> url | Not Authorized | Attribute |
| 1340 | subject -> subjectID | Missing | Attribute |
| 1341 | subject -> subjectID | Value is too small. (Min 1) | Attribute |
| 1342 | subject -> subjectID | Value is too long. (Max 100) | Attribute |
| 1345 | subject -> subjectID | Incorrect type. Must be string. | Attribute |
| 1346 | subject -> subjectID | Already exists | Attribute |
| 1347 | subject -> subjectID | Not found | Attribute |
| 1348 | subject -> subjectID | Not Authorized | Attribute |
| 1360 | subject -> name | Missing | Attribute |
| 1361 | subject -> name | Value is too small. (Min 1) | Attribute |
| 1362 | subject -> name | Value is too long. (Max 50) | Attribute |
| 1365 | subject -> name | Incorrect type. Must be string. | Attribute |
| 1366 | subject -> name | Already exists | Attribute |
| 1367 | subject -> name | Not found | Attribute |
| 1368 | subject -> name | Not Authorized | Attribute |
| 1381 | product -> ssoUrl | Value is too small. (Min 1) | Attribute |
| 1382 | product -> ssoUrl | Value is too long. (Max 250) | Attribute |
| 1385 | product -> ssoUrl | Incorrect type. Must be string. | Attribute |
| 1386 | product -> ssoUrl | Already exists | Attribute |
| 1387 | product -> ssoUrl | Not found | Attribute |
| 1388 | product -> ssoUrl | Not Authorized | Attribute |
| 1400 | product -> title | Missing | Attribute |
| 1402 | product -> title | Value is too long. (Max 4096) | Attribute |
| 1405 | product -> title | Incorrect type. Must be string. | Attribute |
| 1406 | product -> title | Already exists | Attribute |
| 1407 | product -> title | Not found | Attribute |
| 1408 | product -> title | Not Authorized | Attribute |
| 1420 | product -> ean | Missing | Attribute |
| 1421 | product -> ean | Value is too small. (Min 1) | Attribute |
| 1422 | product -> ean | Value is too long. (Max 30) | Attribute |
| 1425 | product -> ean | Incorrect type. Must be string. | Attribute |
| 1426 | product -> ean | Already exists | Attribute |
| 1427 | product -> ean | Not found | Attribute |
| 1428 | product -> ean | Not Authorized | Attribute |
| 1440 | createProductRequest -> product | Missing | Object |
| 1446 | createProductRequest -> product | Already exists | Object |
| 1448 | createProductRequest -> product | Not Authorized | Object |
| 1460 | productInformation -> product | Missing | Object |
| 1467 | productInformation -> product | Not found | Object |
| 1468 | productInformation -> product | Not Authorized | Object |
| 1480 | criterion -> value | Missing | Attribute |
| 1481 | criterion -> value | Value is too small. (Min 1) | Attribute |
| 1482 | criterion -> value | Value is too long. (Max 250) | Attribute |
| 1485 | criterion -> value | Incorrect type. Must be string. | Attribute |
| 1487 | criterion -> value | Not found | Attribute |
| 1488 | criterion -> value | Not Authorized | Attribute |
| 1506 | product -> study | Already exists | Object |
| 1507 | product -> study | Not found | Object |
| 1508 | product -> study | Not Authorized | Object |