Registration 1.1

Owned by Former user (Deleted)
Last updated: Jun 08, 2023 by André Mussche
5 min read

Documentation

Endpoints

Environment

URL

Environment

URL

Production

(end of life op 1-8-2022)

https://cr.directetoegang.nl/soap/1.1/registration

Acceptance
(school year 2021-2022)

(end of life)

https://acc-cr.directetoegang.nl/soap/1.1/registration

Acceptance
(school year 2022-2023)

(end of life)

https://acc-cr.directetoegang.nl/2022-2023/soap/1.1/registration

*Extend the URL with /wsdl to retrieve the WSDL

Important: end of life!

This service will be shutdown on 1-8-2022, so only Registration 3.1 can be used after this date.
See the Migration page for a list a changes between version 1.1 and 3.1 service.

Authorization

In order to access the Registration service you need an account which is provided by support@edu-ix.nl

Operation overview

  • getCustomer

  • getRegistration

Operations

getCustomer

Description

This operation allows to retrieve 1 or more customer records.

Authentication

Identifies the Supplier

Name

Type

Cardinality

Name

Type

Cardinality

AuthenticationHeader

AuthenticationHeader

1...1

Source

<urn:AuthenticationHeader> <SupplierId>?</SupplierId> <SupplierCode>?</SupplierCode> </urn:AuthenticationHeader>

Request

  • Specify DistributorSchool to retrieve one specific customer record.

  • Specify a timestamp in ModifiedSince to retrieve all changes since this timestamp.

  • Send an empty request to retrieve alle customer records

Name

Type

Cardinality

Name

Type

Cardinality

DistributorSchool

DistributorSchool

0...1

ModifiedSince

dateTime

0...1

Source

<urn:GetCustomerRequest> <!--Optional:--> <DistributorSchool> <DistributorId>?</DistributorId> <DistributorSchoolId>?</DistributorSchoolId> </DistributorSchool> <!--Optional:--> <ModifiedSince>?</ModifiedSince> </urn:GetCustomerRequest>

Response

In case of an error, a RegistrationFault is returned.

Name

Type

Cardinality

Name

Type

Cardinality

Customer

Customer

0...n

 

 

getRegistration

Description

This operation allows to retrieve 1 or more Registration records.

Authentication

Name

Type

Cardinality

Name

Type

Cardinality

AuthenticationHeader

AuthenticationHeader

1...1

Source

<urn:AuthenticationHeader> <SupplierId>?</SupplierId> <SupplierCode>?</SupplierCode> </urn:AuthenticationHeader>

Request

  • Specify HubPortal to retrieve one specific Registration record.

  • Specify a timestamp in ModifiedSince to retrieve all changes since this timestamp.

  • Send an empty request to retrieve alle registration records.

Name

Type

Cardinality

Name

Type

Cardinality

HubPortal

HubPortal

0...1

ModifiedSince

dateTime

0...1

RegistrationId

string

0…1

Source

Response

In case of an error, a RegistrationFault is returned.

Name

Type

Cardinality

Name

Type

Cardinality

Registration

Registration

0...n

 

Errors

General errors

General errors may occur within every operation.

Error code

Description

Error code

Description

-1

Generic Error

-2

Authentication Error

For instance when invalid credentials are provided.

Specific errors

Specific errors are bound to the given input or request and depend on the operation you execute.

Error code

Description

Error code

Description

-

-



 

Complex types

AuthenticationHeader

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

SupplierId

string

1...1

Username

SupplierCode

string

1...1

Password

Source

 

Address

Name

Type

Cardinality

Name

Type

Cardinality

Street

string

0...1

HouseNumber

string

0...1

HouseNumberSuffix

string

0…1

PostalCode

PostalCode

0…1

City

string

0…1

Source

 

Customer

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

Active

boolean

1...1

Activation state

DateCreated

dateTime

0...1

 

DateModified

dateTime

1…1

 

DistributorId

string

1…1

Unique identifier of the distributor linked to the customer

DistributorSchoolId

string

1…1

Unique identifier of the school linked to the customer

DeliveryType

DeliveryType

1…1

IBF or EBF

Name

NotEmptyString

1…1

 

Address

Address

1…1

 

Brin

Brin

0…1

see simple types

Contact

Contact

0…n

contact details

Source

 

Contact

Name

Type

Cardinality

Name

Type

Cardinality

Name

string

1...1

Role

string

1...1

JobTitle

string

0…1

Email

Email

0…1

PhoneNumber

Phone

0…1

SchoolName

string

0…1

Source

 

DistributorSchool

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

DistributorId

string

1...1

Unique identifier of a distributor

DistributorSchoolID

string

1...1

Unique identifier for a school

Source

 

HubPortal

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

HubId

HubId

1...1

Unique identifier of the hub

PortalId

PortalId

0...1

Unique identifier of the portal

Source

 

PortalConfiguration

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

DateCreated

dateTime

1...1

 

HubId

string

1...1

Unique identifier of the hub

PortalId

PortalId

1...1

Unique identifier of the portal

Contact

PortalContact

1...1

Primary contact of the portal

PortalUrl

string

0...1

 

Source

 

Portal

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

PortalType

PortalType

1...1

Enum, see simpleTypes

PortalDescription

string

1...1

 

Source

 

PortalContact

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

PortalUserID

string

1...1

Unique identifier of the user

Name

string

1...1

 

Source

 

PrimaryContact

Name

Type

Cardinality

Name

Type

Cardinality

Name

string

1...1

Role

string

1...1

JobTitle

string

0...1

Email

Email

1...1

PhoneNumber

Phone

0...1

SchoolName

string

0...1

Source

 

Registration

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

RegitrationId

string

1...1

Unique Identifier

DateCreated

dateTime

1...1

 

DateModified

dateTime

1...1

 

StartDate

date

1...1

 

EndDate

date

1...1

 

Description

string

1...1

 

Portal

Portal

1...1

 

Status

RegistrationStatus

1...1

 

PrimaryContact

PrimaryContact

0…1

contact details

Customer

RegistrationCustomer

0…n

customer details

PortalConfiguration

PortalConfiguration

0…1

portal configuration details

Source

 

RegistrationCustomer

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

Active

boolean

1...1

 

DateCreated

dateTime

1...1

 

DateModified

dateTime

1...1

 

StartDate

date

1...1

 

EndDate

date

1...1

 

DistributorId

string

1...1

 

DistributorSchoolId

string

1...1

 

DeliveryType

DeliveryType

1...1

EBF or IBF

Name

NotEmptyString

1…1

 

Address

Address

1…1

 

Brin

Brin

0…1

see: simple types

Contact

Contact

0…n

 

Source

 

RegistrationStatus

Name

Type

Cardinality

Name

Type

Cardinality

Active

boolean

1...1

Source

 

RegistrationFault

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

Code

integer

1...1

Code to identify the fault type.

Message

string

1...1

Specific message which describes the fault.

Source



 

Simple types

Name

Type

Possible values / format

Description

Name

Type

Possible values / format

Description

Brin

String

 

The BRIN(Basisregistratie instellingen) is an identifier. The first four characters are alphanumerical and represent an educational institution. The last characters are numerical and represent an identifier for the location of a educational institution.

DeliveryType

Enum

Possible values:

  • EBF

  • IBF

EBF = External Book Fund

IBF = Internal Book Fund

Email

String

Max length: 254 characters

String limited by a number of maximum allowed characters.

HubId

Enum

Possible values:

  • DAF

  • Eduroute

  • Kennisnet

  • OpenID

 

NotEmptyString

string

Min length: 1 character

String limited by a number of minimum allowed characters.

PortalId

String

Max length: 256 characters

String limited by a number of maximum allowed characters.

PortalType

Enum

Possible values:

  • SCHOOL_PORTAL

  • DISTRIBUTOR_PORTAL

  • DOWNLOAD

 

Phone

String

Max length: 15 characters

String limited by a number of maximum allowed characters.

PostalCode

String

 

The following regex should be applied: [0-9]{4} [A-Z]{2}