SID:Servicebeschrijvingen: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
 
(9 tussenliggende versies door 2 gebruikers niet weergegeven)
Regel 82: Regel 82:
 
|
  
|
 
* chainID, sectorID are in the form of OBK URN’s. Retrieve these values using the retrieveChains, retrieveSectors operations respectively.
  
* chainID, sectorID are in the form of OBK URN’s. Retrieve these values using the retrieveChains, retrieveSectors operations respectively.
−
* eckID is in the form of a URL: [https://id.school/2015-09/%5b128-char https://id.school/2015-09/[128-char] hex string]. Currently this url resolves to a static page containing general information about the ECK ID.
 +
* eckID is in the form of a URL: <nowiki>https://id.school/201703/[128-char]</nowiki> hex string.
 
|-
  
|-
 
| SAMPLE
  
| SAMPLE
Regel 88: Regel 88:
 
|}
  
|}
   
−
== Change Stem pseudonym (subsitution) ==
 +
== Substitute PGN for Stem pseudonym ==
   
 
{|class="wikitable"
  
{|class="wikitable"
Regel 112: Regel 112:
 
* The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  
* The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
 
* Format validations on input arguments (format Exception specific for argument on failure).
  
* Format validations on input arguments (format Exception specific for argument on failure).
−
* Old hPGN is not already in the substitution table (old and new) (BlockedPGNException otherwise)
 +
* Old hPGN is not already in the substitution table (old and new) (BlockedhPGNException otherwise)
−
* New hPGN is not already in the substitution table (old and new) (BlockedPGNException otherwise)
 +
* New hPGN is not already in the substitution table (old and new) (BlockedhPGNException otherwise)
 
* Old and new hPGN are different (substitutionOperationException otherwise)
  
* Old and new hPGN are different (substitutionOperationException otherwise)
 
* Effective date: if given, is valid and in the future (xml parse error in case of invalid date format)
  
* Effective date: if given, is valid and in the future (xml parse error in case of invalid date format)
Regel 132: Regel 132:
 
| REMARKS
  
| REMARKS
 
|
  
|
−
* Stem pseudonym is in the form of a URL: https://id.school/spv[1-9]/[128-char hex string].
+
* Stem pseudonym is in the form of a URL: <nowiki>https://id.school/201703/[128-char hex string]</nowiki>.
 
|-
  
|-
 
| SAMPLE
  
| SAMPLE
Regel 158: Regel 158:
 
* The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  
* The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
 
* The system validates the size of the input (TemporaryBannedException if too many hPgns are submitted)
  
* The system validates the size of the input (TemporaryBannedException if too many hPgns are submitted)
−
* All indexes are unique (DuplicateIndexHPgnListException otherwise)
 +
* All indexes are unique (DuplicateIndexBatchListException otherwise)
 
|-
  
|-
 
| OPERATION
  
| OPERATION
Regel 172: Regel 172:
 
* NotAllowedCallerException
  
* NotAllowedCallerException
 
* HashOperationException (indicates server configuration error)
  
* HashOperationException (indicates server configuration error)
  +
* DuplicateIndexBatchListException
−
* DuplicateIndexHPgnListException
  
 
|-
  
|-
 
| REMARKS
  
| REMARKS
Regel 211: Regel 211:
 
* The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  
* The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
 
* The system validates the size of the input (TemporaryBannedException if too many stem pseudonyms are submitted)
  
* The system validates the size of the input (TemporaryBannedException if too many stem pseudonyms are submitted)
−
* All indexes are unique (DuplicateIndexHPgnListException otherwise)
 +
* All indexes are unique (DuplicateIndexBatchListException otherwise)
 
* SectorID is one of the IDs of educational sectors (InvalidSectorIdException on failure).
  
* SectorID is one of the IDs of educational sectors (InvalidSectorIdException on failure).
 
* ChainID is one of the IDs in chains (InvalidChainIdException on failure)
  
* ChainID is one of the IDs in chains (InvalidChainIdException on failure)
Regel 229: Regel 229:
 
* NotAllowedCallerException
  
* NotAllowedCallerException
 
* HashOperationException (indicates server configuration error)
  
* HashOperationException (indicates server configuration error)
  +
* DuplicateIndexBatchListException
−
* DuplicateIndexHPgnListException
  
 
|-
  
|-
 
| REMARKS
  
| REMARKS
Regel 235: Regel 235:
 
The use of this service is limited to prevent abuse:
  
The use of this service is limited to prevent abuse:
   
−
* A batch may contain at most 20.000 hashed PGNs
 +
* A batch may contain at most 20.000 entries
 
* A batch operation may be submitted at most 3 times per 24 hours
  
* A batch operation may be submitted at most 3 times per 24 hours
   
Regel 245: Regel 245:
 
| [[SID:SampleBatchECKID|Sample request and response]]
  
| [[SID:SampleBatchECKID|Sample request and response]]
 
|}
  
|}
  +
  +
=Batch results retrieval=
   
 
{|class="wikitable"
  
{|class="wikitable"
Regel 309: Regel 311:
 
|-
  
|-
 
| CONTEXT
  
| CONTEXT
−
| This service is called by allowed LAS systems to obtain the list of chain parties for which an ECK ID can be derived. As this list changes rarely, this service will not be called often, probably not more than once per day per LAS.
 +
| This service is called by allowed LAS systems to obtain the value of the ECK chain ID, for which an ECK ID can be derived. As this list changes rarely, this service will not be called often, probably not more than once per day per LAS.
 
|-
  
|-
 
| INPUT
  
| INPUT

Huidige versie van 20 jan 2022 om 14:43

Services

Create Stem Pseudonym

SERVICE DESCRIPTION retrieveStempseudonym
CONTEXT This service is called by allowed LAS systems to obtain a stem pseudonym for, for instance, a just enrolled student. This function is called during the process of enrollment, and its availability is business critical.
INPUT
  • hpgn: HPgn, oblig, hashed PGN;
VALIDATIONS
  • The calling system, identified by its OIN in the SerialNumber field of the Certificate, is checked against the list of allowed callers (NotAllowedCallerException on failure)
  • The calling school is identified from the OIN in the wsa:from SOAP header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  • hashed PGN: format validations (InvalidHPgnException on failure)
OPERATION The service derives a stem pseudonym from the input. The derivation of a valid stem pseudonym is performed by a component that is specified in software configuration.
OUTPUT stempseudonym: The generated stem pseudonym
EXCEPTIONS
  • NotAllowedCallerException
  • HashOperationException (indicates server configuration error)
REMARKS
SAMPLE Sample request and response

Create ECK ID

SERVICE DESCRIPTION retrieveEckId
CONTEXT This service is called by allowed LAS systems to obtain a ECK ID for, for instance, a just enrolled student. This function is called during the process of enrollment, and its availability is business critical.
INPUT
  • Stempseudonym: Stem pseudonym, obtained with ‘retrieveStempseudonym’
  • chainID: xsd:string, oblig, Identifier for ECK chain
  • sectorID: xsd:string, oblig, Identifier for educational sector
VALIDATIONS
  • The calling system, identified by its OIN in the SerialNumber field of the Certificate, is checked against the list of allowed callers (NotAllowedCallerException on failure)
  • The calling school is identified from the OIN in the wsa:from SOAP header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  • Stem pseudonym, SectorID, ChainID: format validations (Format Exception specific for argument on failure, e.g. InvalidStemPseudonymException, InvalidChainIdException and InvalidSectorIdException).
  • SectorID is one of the IDs of educational sectors (InvalidSectorIdException on failure).
  • ChainID is one of the IDs in chains (InvalidChainIdException on failure)
  • Hashed PGN is not in substitutionList.old (BlockedHPgnException on failure)
OPERATION

The service combines the three inputs and from the result derives a valid ECK ID. The derivation of a valid ECK ID is performed by a component that is specified in software configuration.

If the provided stem pseudonymis in substitutionList.new and sectorID is equal to the substitutionlist.sectorID and today is later than substitutiontable.effectivedate, the previous stem pseudonym is used to derive the ECK ID from.

OUTPUT eckID: EckID, The derived ECK ID
EXCEPTIONS
  • InvalidSectorIdException InvalidChainIdException InvalidHPgnException
  • BlockedStempseudonymException
  • NotAllowedCallerException
  • HashOperationException (indicates server configuration error)
REMARKS
  • chainID, sectorID are in the form of OBK URN’s. Retrieve these values using the retrieveChains, retrieveSectors operations respectively.
  • eckID is in the form of a URL: https://id.school/201703/[128-char] hex string.
SAMPLE Sample request and response

Substitute PGN for Stem pseudonym

SERVICE DESCRIPTION replaceStempseudonym
CONTEXT This service is called when a school administration needs to indicate that a student is assigned a new PGN by the authorities. A change of PGN number is handled as follows:
  1. The old and the new stem hashed PGN are recorded in the database.
  2. Subsequent requests for the old hashed PGN are rejected.
  3. For requests with the new stem hashed PGN, the old hashed PGN is used to derive the stem pseudonym from.

See also service description Create stempseudonym.

INPUT
  • hPGNOld, hPGNNew: oblig, resp. previous hashed PGN and new hashed PGN
  • effectiveDate: Date and time that the change should take effect. Date in full gregorian calendar format, like "2017-01-01T11:26:30.806+01:00". Optional, 'now' if not given.
VALIDATIONS
  • The calling system identified by its OIN in the Certificate is checked against the list of allowed callers (NotAllowedCallerException on failure)
  • The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  • Format validations on input arguments (format Exception specific for argument on failure).
  • Old hPGN is not already in the substitution table (old and new) (BlockedhPGNException otherwise)
  • New hPGN is not already in the substitution table (old and new) (BlockedhPGNException otherwise)
  • Old and new hPGN are different (substitutionOperationException otherwise)
  • Effective date: if given, is valid and in the future (xml parse error in case of invalid date format)
OPERATION Old hPGN, new hPGN are recorded in the substitution table, and a stem pseudonym for the new hPGN is derived using function ‘Create stem pseudonym’.
OUTPUT stem pseudonym: The stem pseudonym for the new hpgn
EXCEPTIONS
  • InvalidhPGNException with information on which stem pseudonym is invalid, and why
  • SubstitutionOperationException
  • NotAllowedCallerException
  • HashOperationException (indicates server configuration error)
REMARKS
  • Stem pseudonym is in the form of a URL: https://id.school/201703/[128-char hex string].
SAMPLE Sample request and response

Batch creation of stem pseudonyms

SERVICE DESCRIPTION submitStempseudonymBatch
CONTEXT This service is called by allowed LAS systems to submit a list of stem pseudonyms, for a single Sector and a single Chain. The system processes the list and makes a corresponding list of stem pseudonyms available for retrieval (see retrieveEckBatch).
INPUT
  • stempseudonymList: a list of 1..20.000[1]
    • int: xsd:int, oblig, sequence number
    • hPgn: HPgn hashed PGNs
VALIDATIONS
  • The calling system identified by its OIN in the Certificate is checked against the list of allowed callers (NotAllowedCaller Exception on failure)
  • The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  • The system validates the size of the input (TemporaryBannedException if too many hPgns are submitted)
  • All indexes are unique (DuplicateIndexBatchListException otherwise)
OPERATION The service creates a stem pseudonym for each hashed PGN in the input list and adds it to the list of generated stem pseudonyms for output. If the list does not contain a hashed PGN or if the hashed PGN was previously indicated as changed, no stem pseudnym will be created and a message to indicate the nature of the failure will be added to the list of failed items for output.
OUTPUT
  • batchIdentifier: xsd:string, identifier of the batch request. This identifier can be used to obtain the result, using retrieveEckBatch
EXCEPTIONS
  • InvalidSectorIdException InvalidChainIdException InvalidHPgnException
  • NotAllowedCallerException
  • HashOperationException (indicates server configuration error)
  • DuplicateIndexBatchListException
REMARKS

The use of this service is limited to prevent abuse:

  • A batch may contain at most 20.000 hashed PGNs
  • A batch operation may be submitted at most 3 times per 24 hours

These limits are configured in the software and can be modified. Schools that exceed these limits are temporarily banned from submitting batch requests. Schools may contact Kennisnet servicedesk for information and for lifting of the bans. Schools may submit multiple batch requests, as long as the limits are observed. Batches are processed in the order in which they occur.

A batch result is available within one hour after submission of the request. Batch results are removed after successful retrieval. The system may remove batch results that are not retrieved within 24 hours.

SAMPLE Sample request and response

Batch creation of ECK IDs

SERVICE DESCRIPTION submitEckIdBatch
CONTEXT This service is called by allowed LAS systems to submit a list of stem pseudnyms, for a single Sector and a single Chain. The system processes the list and makes a corresponding list of ECK IDs available for retrieval (see retrieveEckBatch).
INPUT
  • stempseudonymList: a list of 1..20.000[2]
    • int: xsd:int, oblig, sequence number
    • stempseudonym: Stem pseudonym
  • chainID: xsd:string, oblig, Identifier for ECK chain
  • sectorID: xsd:string, oblig, Identifier for educational sector
VALIDATIONS
  • The calling system identified by its OIN in the Certificate is checked against the list of allowed callers (NotAllowedCaller Exception on failure)
  • The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  • The system validates the size of the input (TemporaryBannedException if too many stem pseudonyms are submitted)
  • All indexes are unique (DuplicateIndexBatchListException otherwise)
  • SectorID is one of the IDs of educational sectors (InvalidSectorIdException on failure).
  • ChainID is one of the IDs in chains (InvalidChainIdException on failure)
  • Stempseudonyms is not in substitutionList.old (offending stem pseudonym is added to the failed list for output)
OPERATION The service creates a ECK ID for each hashed PGN in the input list and adds it to the list of generated ECK IDs for output. If the list does not contain a hashed PGN or if the hashed PGN was previously indicated as changed, no ECK ID will be created and a message to indicate the nature of the failure will be added to the list of failed PGNs for output. If the provided hashed PGN is in substitutionList.new and sectorID is equal to the substitutionlist.sectorID and today is later than substitutiontable.effectivedate, the previous hashed PGN is used to derive the ECK ID from.
OUTPUT
  • batchIdentifier: xsd:string, identifier of the batch request. This identifier can be used to obtain the result, using retrieveEckBatch
EXCEPTIONS
  • InvalidSectorIdException InvalidChainIdException InvalidHPgnException
  • BlockedHPgnException
  • NotAllowedCallerException
  • HashOperationException (indicates server configuration error)
  • DuplicateIndexBatchListException
REMARKS

The use of this service is limited to prevent abuse:

  • A batch may contain at most 20.000 entries
  • A batch operation may be submitted at most 3 times per 24 hours

These limits are configured in the software and can be modified. Schools that exceed these limits are temporarily banned from submitting batch requests. Schools may contact Kennisnet servicedesk for information and for lifting of the bans. Schools may submit multiple batch requests, as long as the limits are observed. Batches are processed in the order in which they occur.

A batch result is available within one hour after submission of the request. Batch results are removed after successful retrieval. The system may remove batch results that are not retrieved within 24 hours.

SAMPLE Sample request and response

Batch results retrieval

SERVICE DESCRIPTION retrieveBatch
CONTEXT This service is called by allowed LAS systems to retrieve the status and result of a batch request.
INPUT
  • batchIdentifier: xsd:string, oblig, the batch identifier obtained in the response from a batch submission (see submitEckIdBatch)
VALIDATIONS
  • The calling system identified by its OIN in the Certificate is checked against the list of allowed callers (NotAllowedCallerException on failure)
  • The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
  • The system validates the frequency of calls (SchoolTemporaryBlockedException or BatchTemporaryBlockedException if there are too many calls registered)
  • The batch result can be retrieved at most once; ContentAlreadyRetrievedException is returned if the batch was retrieved earlier
  • If the batch indicated by the input is purged, already retrieved, or not ready yet, a NotFinishedException is returned
OPERATION The service retrieves the batch result (either StempseudonymBatch or EckIdBatch), if available, and returns it to the caller. If an error during check or processing occurs, the error is returned.
OUTPUT
  • Success: an optional list of 1..20000[3]:
    • Index: int, the sequence number of the corresponding entry from the input
    • EckId: EckId, the ECK ID of the entry indicated by the sequence number from the input
  • Failed: an optional list of 1..20000[4]:
    • Index: int, the sequence number of the corresponding entry from the input
    • errorMessage: string, indication of the error that occurred when computing the ECK ID
EXCEPTIONS
  • InvalidSectorIdException
  • InvalidChainIdException
  • InvalidHPgnException
  • BlockedHPgnException
  • NotAllowedCallerException
  • HashOperationException (indicates server configuration error)
  • SchoolTemporaryBlockedException, BatchTemporaryBlockedException
  • ContentAlreadyRetrievedException
  • NotFinishedException
REMARKS

The use of this service is limited to prevent abuse: a batch retrieval may be attempted at most once per 15 minutes (software configurable; actual limit may differ). In case this limit is exceeded, the offending school is temporarily banned from using this service. Schools may contact Kennisnet servicedesk for more information and to lift the ban.

A batch result is available within one hour after submission of the request. Batch results are removed after successful retrieval. Batch results that are not retrieved can be removed after 24 hours.

In the output of this function, both success and failure are optional arrays. If none of the input fail, the response will contain only ‘success’ values. If none of the input succeed, the response will contain only ‘failure’.

SAMPLE Sample request and response

Retrieving chains and sectors

SERVICE DESCRIPTION retrieveChains
CONTEXT This service is called by allowed LAS systems to obtain the value of the ECK chain ID, for which an ECK ID can be derived. As this list changes rarely, this service will not be called often, probably not more than once per day per LAS.
INPUT none
VALIDATIONS
  • The calling system identified by its OIN in the Certificate is checked against the list of allowed callers (NotAllowedCallerException on failure)
  • The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
OPERATION The service retrieves the list of active Chain Parties
OUTPUT

List of 1 or more :

  • Id: xsd:string, Identifier of chain that can be used to create ECK IDs for this chain
  • Name: xsd:string, unique and short name for this chain
  • Description: xsd:string, human-readable description for this chain
  • lastEdited: xsd:date, last time this entry was modified
EXCEPTIONS NotAllowedCallerException
REMARKS
SERVICE DESCRIPTION retrieveSectors
CONTEXT This service is called by allowed LAS systems to obtain the list of school types for which an ECK ID can be derived. As this list changes rarely, this service will not be called often, probably not more than once per day per LAS.
INPUT none
VALIDATIONS
  • The calling system identified by its OIN in the Certificate is checked against the list of allowed callers (NotAllowedCallerException on failure)
  • The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
OPERATION Retrieve the list of active SectorIDs from the database.
OUTPUT

List of 1 or more :

  • Id: xsd:string, Identifier of sector that can be used to create ECK IDs for this sector
  • Name: xsd:string, unique and short name for this sector
  • Description: xsd:string, human-readable description for this sector
  • lastEdited: xsd:date, last time this entry was modified
EXCEPTIONS NotAllowedCallerException
REMARKS

The names, descriptions and values are taken from OBK.

Ping operation

SERVICE DESCRIPTION pingRequest
CONTEXT This service is called by allowed LAS systems to verify the service is alive.
INPUT none
VALIDATIONS
  • The calling system identified by its OIN in the Certificate is checked against the list of allowed callers (NotAllowedCallerException on failure)
  • The calling school is identified from the OIN in the wsa:from header. If the school is not in the list of allowed schools, a NotAllowedCallerException will be thrown
OPERATION Verify the database is available for operation
OUTPUT
  • Available: Boolean, the system is available (true) or not (false)
  • applicationVersion: string, identifier for the implementation version
  • systemTime: xsd:dateTime, timestamp of the current system time
EXCEPTIONS NotAllowedCallerException
REMARKS

Common types

Name HPgn
Fields xsd:string
Constraints
  • Consists of 64 hex characters ([0-9][A-Z][[a-z]){64}
Remarks Contains the result of the prescribed hash function SCrypt
Name EckId
Fields xsd:string
Constraints
  • Is not empty
Remarks

Exceptions

Exceptions will be presented by the Nummervoorziening Service as Soap faults. To distinguish the cause Exception of an operation at the client, the element faultactor will hold the specific Exception. In the detail node, a message node is added with additional information regarding the Exception.

Example of a Soap fault as a response from the Nummervoorziening Service (omitting the Soap Headers): 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body> 
      <soap:Fault> 
         <faultcode>soap:SERVER</faultcode> 
         <faultstring>RetrieveEckIdBatch has thrown an exception while building the response</faultstring> 
         <faultactor>InvalidBatchIdentifierException</faultactor> 
         <detail> 
            <message>Batch with specified identifier does not exist</message> 
         </detail> 
      </soap:Fault> 
   </soap:Body> 
</soap:Envelope>


The reference clients will contain code in Java and C# to handle these faults and distinguish root causes.

  1. ↑ The size of the array is comfigured in software. Actual limit may differ.
  2. ↑ The size of the array is comfigured in software. Actual limit may differ.
  3. ↑ Limit is set in in software configuration; actual values may differ
  4. ↑ Idem
Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=SID:Servicebeschrijvingen&oldid=12188"