Documentation
Endpoints
Environment | URL |
|---|---|
Production | |
Acceptance | |
Test |
*Extend the URL with /wsdl to retrieve the WSDL
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 |
|---|---|---|
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 |
|---|---|---|
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 |
|---|---|---|
Customer | Customer | 0...n |
getRegistration
Description
This operation allows to retrieve 1 or more Registration records.
Authentication
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 |
|---|---|---|
HubPortal | HubPortal | 0...1 |
ModifiedSince | dateTime | 0...1 |
RegistrationId | string | 0…1 |
Source <urn:GetRegistrationRequest>
<!--Optional:-->
<HubPortal>
<HubId>?</HubId>
<PortalId>?</PortalId>
</HubPortal>
<!--Optional:-->
<ModifiedSince>?</ModifiedSince>
<!--Optional:-->
<RegistrationId>?</RegistrationId>
</urn:GetRegistrationRequest>
| ||
Response
In case of an error, a RegistrationFault is returned.
Name | Type | Cardinality |
|---|---|---|
Registration | Registration | 0...n |
Errors
General errors
General errors may occur within every operation.
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 |
|---|---|
- | - |
Complex types
AuthenticationHeader
Name | Type | Cardinality | Description |
|---|---|---|---|
SupplierId | string | 1...1 | Username |
SupplierCode | string | 1...1 | Password |
Source <xsd:element name="AuthenticationHeader"> <xsd:complexType> <xsd:sequence> <xsd:element name="SupplierId" type="xsd:string"/> <xsd:element name="SupplierCode" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:element> | |||
Address
Name | Type | Cardinality |
|---|---|---|
Street | string | 0...1 |
HouseNumber | string | 0...1 |
HouseNumberSuffix | string | 0…1 |
PostalCode | PostalCode | 0…1 |
City | string | 0…1 |
Source <xsd:complexType name="Address"> <xsd:sequence> <xsd:element name="Street" type="xsd:string" minOccurs="0" /> <xsd:element name="HouseNumber" type="xsd:int" minOccurs="0" /> <xsd:element name="HouseNumberSuffix" type="xsd:string" minOccurs="0" /> <xsd:element name="PostalCode" type="types:PostalCode" minOccurs="0" /> <xsd:element name="City" type="xsd:string" minOccurs="0" /> </xsd:sequence> </xsd:complexType> | ||
Customer
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 <xsd:complexType name="Customer"> <xsd:sequence> <xsd:element name="Active" type="xsd:boolean" /> <xsd:element name="DateCreated" type="xsd:dateTime" /> <xsd:element name="DateModified" type="xsd:dateTime" /> <xsd:element name="DistributorId" type="xsd:string" /> <xsd:element name="DistributorSchoolId" type="xsd:string" /> <xsd:element name="DeliveryType" type="types:DeliveryType" /> <xsd:element name="Name" type="types:NotEmptyString" /> <xsd:element name="Address" type="types:Address" /> <xsd:element name="Brin" type="types:Brin" minOccurs="0" /> <xsd:element name="Contact" type="types:Contact" maxOccurs="unbounded" minOccurs="0" /> </xsd:sequence> </xsd:complexType> | |||
Contact
Name | Type | Cardinality |
|---|---|---|
Name | string | 1...1 |
Role | string | 1...1 |
JobTitle | string | 0…1 |
0…1 | ||
PhoneNumber | Phone | 0…1 |
SchoolName | string | 0…1 |
Source <xsd:complexType name="Contact"> <xsd:sequence> <xsd:element name="Name" type="xsd:string" /> <xsd:element name="Role" type="xsd:string" /> <xsd:element name="JobTitle" type="xsd:string" minOccurs="0" /> <xsd:element name="Email" type="types:Email" minOccurs="0" /> <xsd:element name="PhoneNumber" type="types:Phone" minOccurs="0" /> <xsd:element name="SchoolName" type="xsd:string" minOccurs="0" /> </xsd:sequence> </xsd:complexType> | ||
DistributorSchool
Name | Type | Cardinality | Description |
|---|---|---|---|
DistributorId | string | 1...1 | Unique identifier of a distributor |
DistributorSchoolID | string | 1...1 | Unique identifier for a school |
Source <xsd:complexType name="DistributorSchool"> <xsd:sequence> <xsd:element name="DistributorId" type="xsd:string" /> <xsd:element name="DistributorSchoolId" type="xsd:string" /> </xsd:sequence> </xsd:complexType> | |||
HubPortal
Name | Type | Cardinality | Description |
|---|---|---|---|
HubId | HubId | 1...1 | Unique identifier of the hub |
PortalId | PortalId | 0...1 | Unique identifier of the portal |
Source <xsd:complexType name="HubPortal"> <xsd:sequence> <xsd:element name="HubId" type="types:HubId" /> <xsd:element name="PortalId" type="types:PortalId" /> </xsd:sequence> </xsd:complexType> | |||
PortalConfiguration
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 <xsd:complexType name="PortalConfiguration"> <xsd:sequence> <xsd:element name="DateCreated" type="xsd:dateTime" /> <xsd:element name="HubId" type="types:HubId" /> <xsd:element name="PortalId" type="types:PortalId" /> <xsd:element name="Contact" type="types:PortalContact" /> <xsd:element name="PortalUrl" type="xsd:string" minOccurs="0" /> </xsd:sequence> </xsd:complexType> | |||
Portal
Name | Type | Cardinality | Description |
|---|---|---|---|
PortalType | PortalType | 1...1 | Enum, see simpleTypes |
PortalDescription | string | 1...1 | |
Source <xsd:complexType name="Portal"> <xsd:sequence> <xsd:element name="PortalType" type="types:PortalType" /> <xsd:element name="PortalDescription" type="xsd:string" /> </xsd:sequence> </xsd:complexType> | |||
PortalContact
Name | Type | Cardinality | Description |
|---|---|---|---|
PortalUserID | string | 1...1 | Unique identifier of the user |
Name | string | 1...1 | |
Source <xsd:complexType name="PortalContact"> <xsd:sequence> <xsd:element name="PortalUserID" type="xsd:string" /> <xsd:element name="Name" type="xsd:string" /> </xsd:sequence> </xsd:complexType> | |||
PrimaryContact
Name | Type | Cardinality |
|---|---|---|
Name | string | 1...1 |
Role | string | 1...1 |
JobTitle | string | 0...1 |
1...1 | ||
PhoneNumber | Phone | 0...1 |
SchoolName | string | 0...1 |
Source <xsd:complexType name="PrimaryContact"> <xsd:complexContent> <xsd:restriction base="types:Contact"> <xsd:sequence> <xsd:element name="Name" type="xsd:string" /> <xsd:element name="Role" type="xsd:string" /> <xsd:element name="JobTitle" type="xsd:string" minOccurs="0" /> <xsd:element name="Email" type="types:Email" /> <xsd:element name="PhoneNumber" type="types:Phone" minOccurs="0" /> <xsd:element name="SchoolName" type="xsd:string" minOccurs="0" /> </xsd:sequence> </xsd:restriction> </xsd:complexContent> </xsd:complexType> | ||
Registration
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 <xsd:complexType name="Registration"> <xsd:sequence> <xsd:element name="RegistrationId" type="xsd:string" /> <xsd:element name="DateCreated" type="xsd:dateTime" /> <xsd:element name="DateModified" type="xsd:dateTime" /> <xsd:element name="StartDate" type="xsd:date" /> <xsd:element name="EndDate" type="xsd:date" /> <xsd:element name="Description" type="xsd:string" /> <xsd:element name="Portal" type="types:Portal" /> <xsd:element name="Status" type="types:RegistrationStatus" /> <xsd:element name="PrimaryContact" type="types:PrimaryContact" minOccurs="0" /> <xsd:element name="Customer" type="types:RegistrationCustomer" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="PortalConfiguration" type="types:PortalConfiguration" minOccurs="0" /> </xsd:sequence> </xsd:complexType> | |||
RegistrationCustomer
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 <xsd:complexType name="RegistrationCustomer"> <xsd:sequence> <xsd:element name="Active" type="xsd:boolean"></xsd:element> <xsd:element name="DateCreated" type="xsd:dateTime"></xsd:element> <xsd:element name="DateModified" type="xsd:dateTime"></xsd:element> <xsd:element name="StartDate" type="xsd:date"></xsd:element> <xsd:element name="EndDate" type="xsd:date"></xsd:element> <xsd:element name="DistributorId" type="xsd:string" /> <xsd:element name="DistributorSchoolId" type="xsd:string" /> <xsd:element name="DeliveryType" type="types:DeliveryType" /> <xsd:element name="Name" type="types:NotEmptyString" /> <xsd:element name="Address" type="types:Address" /> <xsd:element name="Brin" type="types:Brin" minOccurs="0" /> <xsd:element name="Contact" type="types:Contact" maxOccurs="unbounded" minOccurs="0" /> </xsd:sequence> </xsd:complexType> | |||
RegistrationStatus
Name | Type | Cardinality |
|---|---|---|
Active | boolean | 1...1 |
Source <xsd:complexType name="RegistrationStatus"> <xsd:sequence> <xsd:element name="Active" type="xsd:boolean"></xsd:element> </xsd:sequence> </xsd:complexType> | ||
RegistrationFault
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 <xsd:element name="RegistrationFault"> <xsd:complexType> <xsd:sequence> <xsd:element name="Code" type="xsd:int"/> <xsd:element name="Message" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:element> | |||
Simple types
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 = External Book Fund IBF = Internal Book Fund |
String | Max length: 254 characters | String limited by a number of maximum allowed characters. | |
HubId | Enum | Possible values:
| |
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:
| |
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} |