Product 5.0

Owned by Former user (Deleted)
Last updated: Apr 20, 2023 by André Mussche
4 min read

Documentation (in progress)

Documentation

Endpoints

Environment

URL

Environment

URL

Production

https://lika.edu-ix.nl/soap/5.0/product

Acceptance

https://ketentest-lika.edu-ixstaging.nl/soap/5.0/product

*Extend the URL with /wsdl to retrieve the WSDL

Operation overview

Operation authentication

All operations need the loginHeader to authenticate.

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>



Operations

getProducts

Description 

The getProducts call can be used to search and retrieve available products.

Authentication

You must provide a loginHeader for authentication, see "Operation authentication".

Request



Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

searchTitle

string250

0...1

Partial search (case insensitive) is done.

searchProductId

string250

0...1

Exact match is done.



<xs:complexType> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="1"> <xs:element name="searchTitle" type="types:string250" minOccurs="0" maxOccurs="1"/> <xs:element name="searchProductId" type="types:string250" minOccurs="0" maxOccurs="1"/> </xs:choice> </xs:sequence> </xs:complexType>



Response

When the search was successful, one or more elements are returned. In case nothing was found, zero elements are returned.

Name

Type

Cardinality

Name

Type

Cardinality

product

product

0...n

Error codes

Error code

Description

Error code

Description

2

Authentication error

4

Authorization error

5

Invalid request

6

Missing required field(s)



uploadProducts

Description

The uploadProducts call can be used to upload one or more products at once. In case a ProductId already exists, an update is done.
Otherwise, new products will be inserted after validation. 

Authentication

You must provide a loginHeader for authentication, see "Operation authentication".

Request

Name

Type

Cardinality

Name

Type

Cardinality

product

product

1...100

Source

<xs:complexType> <xs:sequence> <xs:element name="product" type="types:product" minOccurs="1" maxOccurs="100"/> </xs:sequence> </xs:complexType>



Response

An empty response is given when there are no errors.
In case of errors on one or more uploaded product elements, a faultPerProduct element is returned for each occurred error.

Error codes

Error code

Description

Error code

Description

2

Authentication error

4

Authorization error

5

Invalid request

6

Missing required field(s) or other validation error(s)



Complex types

authHeader

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

loginHeader

loginHeader

1...1

contains credentials.

Source



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



product

Name

Type





Description

Name

Type





Description

productId

ProductIdType

1...1

Unieke code van het product

publisher

MinLengthOneCharType

1...1

De uitgever van het Product

publisherThumbnailLocation

UrlType

1...1

Publieke referentie naar thumbnail van het Logo van de uitgever

title

MinLengthOneCharType

1...1

De titel van het product

authors

Authors

0...1



intendedEndUserRole

RoleType

0...1

Indicatie voor welke rol of het Product is bedoeld is. Vulling: onderwijsgever, onderwijsvolger, beheerder

sectors

Sectors

1...1

Container voor Sectors

courses

Courses

1...1

Container voor Courses

levels

Levels

1...1

Container voor Levels

durationDays

int

1...1

DurationDays: geeft aan hoe lang een licenties van het product geldig is.

serviceCreditAllowed

boolean

0...1

Dit gegeven geeft aan of servicetegoeden voor dit product zijn toegestaan

zeroEnabled

boolean

0...1

Dit gegeven geeft aan of zerolicenties voor dit product zijn toegestaan

activationCodeEnabled

boolean

0...1

Dit gegeven geeft aan of het product activatiecodes toelaat

priceIsIndicative

boolean

0...1

Dit gegeven geeft aan dat de prijs (indicatie) zeer waarschijnlijk tijdelijk is, het product is nog in ontwikkeling, op een later moment zal er een meer definitieve prijs vastgesteld worden. Waarde TRUE als het een indicatie betreft

saleUnitSize

int

1...1

Verkoopeenheid: het aantal exemplaren van het (mogelijk samengesteld) product dat als eenheid wordt verkocht (cpi.AantalExemplarenPerVerkoopeenheid). Vullingsregels: waarde >= 0, waarde 0=niet apart leverbaar.

productState

ProductStateType

0...1

Geeft de status van het product aan. Mogelijke waarden zijn: Nog niet leverbaar, Beperkt leverbaar, Leverbaar, Tijdelijk niet leverbaar, Niet meer leverbaar, Zal niet verschijnen

prices

Prices

0...

De prijs excl. btw van het product in centen. Per prijs kan het btw percentage aangegeven worden. Er kan optioneel ook een consumentenprijs in centen opgenomen worden. Vullingsregel: Het Prices element moet aanwezig zijn indien IsCatalogItem de waarde TRUE heeft. Er is dan minimaal 1 price element aanwezig

contentLocation

UrlType

0...1

Referentie (URL)  naar productpagina / methodepagina

productThumbnailLocation

UrlType

0...1

Publieke referentie naar thumbnail van het product

redirectURL

UrlType

1...1

Uiteindelijke redirect naar de content van de gebruiker bij het achterliggende LIKA

medium

mediumType

0...1

Geeft aan wat voor een soort product het is.

AccessLocation

UrlType

0...1

Referentie (URL) die toegang tot het product geeft.
Note: veld bestaat alleen in de response.

Source



faultPerProduct

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

productFault

productFault

0...n



Source



productFault

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

position

integer

1...1

Position of the element in the request array

productId

productIdType

0...1



code

integer

0...1



message

string

0...1

Specific message which describes the fault.

Source



Simple types

Name

Type

Possible values / format

Description

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.

string256

String

Max length: 256 characters

String limited by a number of maximum allowed characters.

possitiveInteger

Integer

Greater then 0

Integer value, can only be positive.

minLengthOneCharType

String

Min length: 1 character

String with minimum number of characters.

urlType

String

AnyURI pattern (e.g. http://.*)

Must be a valid URL.

productIdType

String

Min length: 1, max length: 160 characters

String limited by a number of minimum and maximum allowed characters.

roleType

Enum

Possible values:

  • Onderwijsgever

  • Onderwijsvolger

  • Beheerder

Role of a user.

productStateType

Enum

Possible values:

  • Nog niet leverbaar

  • Beperkt leverbaar

  • Leverbaar

  • Tijdelijk niet leverbaar

  • Niet meer leverbaar

  • Zal niet verschijnen

State of the product.

mediumType

Enum

Possible values:

  • Downloadable installer

  • Boek

  • USB

  • CD-ROM

  • DVD

  • Anders"

Geeft aan wat voor een soort product het is.