Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user André Mussche

Saved on

Key

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

Documentation

Endpoints

Environment

URL

Production

https://lika.edu-ix.nl/soap/4.1/profile

Acceptance

https://ketentest-lika.edu-ixstaging.nl/soap/4.1/profile

*Extend the URL with /wsdl to retrieve the WSDL


Operation overview

  • getEduProfile

Operations

getEduprofile

Description

The getEduProfile operation provides information about users attached to a given redirectSessionID. The redirectSessionID is received as a GET paramenter within the Identity Callback.

The redirectSessionID is valid for single use and will expire 15 minutes after it has been received through the Identity Callback.

Authentication

Name

Type

Cardinality

authHeader

authHeader

1...1

Source

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

Request

Name

Type

Cardinality

redirectSessionID

string64

1...1

Source

Code Block
<urn:getEduProfileRequest>
    <urn:redirectSessionID>?</urn:redirectSessionID>
</urn:getEduProfileRequest>

Response

Name

Type

Cardinality

Description

uid

string256

1...1

personProfileID

string256

0...1

Present in case of a 'MBO' student

personRealID

string256

0...1

Present in case of a 'VO' student

givenName

string50

1...1

sn

string50

1...1

personTussenvoegsels

string15

0...1

affiliation

string50

1...1

digiDeliveryID

string256

0...1

homeOrganization

string50

1...1

homeOrganizationID

string4-6

1...1

eckID

eckID

0...1

Source

Code Block
<urn:getEduProfileResponse>
         <urn:uid>?</urn:uid>
         <!--Optional:-->
         <urn:personProfileID>?</urn:personProfileID>
         <!--Optional:-->
         <urn:personRealID>?</urn:personRealID>
         <urn:givenName>?</urn:givenName>
         <urn:sn>?</urn:sn>
         <!--Optional:-->
         <urn:personTussenvoegsels>?</urn:personTussenvoegsels>
         <urn:affiliation>?</urn:affiliation>
         <!--Optional:-->
         <urn:digiDeliveryID>?</urn:digiDeliveryID>
         <urn:homeOrganization>?</urn:homeOrganization>
         <urn:homeOrganizationID>?</urn:homeOrganizationID>
         <!--Optional:-->
         <urn:eckID>?</urn:eckID>
</urn:getEduProfileResponse>

...

Error codes

General errors

Error code

Description

-200

Bad Request

0

General error

Something went wrong during the operation.

Specific errors

Error code

Description

-1

Redirect session expired

...

Complex types

authHeader

Name

Type

Cardinality

Description

loginHeader

loginHeader

1...1

loginHeader

Name

Type

Cardinality

Description

username

string100

1...1

password

string64

1...1

...


Simple types

Name

Type

Possible values / format

Description

string4-6

String

Min length: 4 characters

Max length: 6 characters

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

string15

String

Max length: 15 characters

String limited by a number of maximum allowed characters.

string50

String

Max length: 50 characters

String limited by a number of maximum allowed characters.

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.

eckID

String

Min length: 128 characters

Max length: 256 characters

eckID is in the form of a URL: https://id.school/2015-09/[128-char hex string]. Currently this url resolves to a static page containing general information about the ECK ID.