1EdTech GLC Person Management Service WSDL/XSD Binding Version 2.0 Final Release Specification Final 1.0

Date Issued: 30 June 2011

Latest version: /lis/

IPR and Distribution Notices

Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.

1EdTech takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on 1EdTech's procedures with respect to rights in 1EdTech specifications can be found at the 1EdTech Intellectual Property Rights web page: /imsipr_policyFinal.pdf.

Copyright © 2011 1EdTech Consortium. All Rights Reserved.

If you wish to copy or distribute this document, you must complete a valid Registered User license registration with 1EdTech and receive an email from 1EdTech granting the license to distribute the specification. To register, follow the instructions on the 1EdTech website: /specificationdownload.cfm

This document may be copied and furnished to others by Registered Users who have registered on the 1EdTech website provided that the above copyright notice and this paragraph are included on all such copies. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to 1EdTech, except as needed for the purpose of developing 1EdTech specifications, under the auspices of a chartered 1EdTech project group.

Use of this specification to develop products or services is governed by the license with 1EdTech found on the 1EdTech website: /license.html

The limited permissions granted above are perpetual and will not be revoked by 1EdTech or its successors or assigns.

THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.

Table of Contents

1. Introduction
   1. Scope and Context
   2. Structure of this Document
   3. Nomenclature
   4. References
       
2. Platform Specific Model of the Binding
   1. Service Description
   2. Data for the Service Operations
   3. Person Data Model
   4. File-based Exchange Data Model
       
3. Application of the Binding Guidelines
4. WSDL File Documentation
   1. Overview
   2. Messages
       
5. XSD File Documentation
   1. Service Data Model
   2. File Data Model
       
6. Binding of the Vocabularies
7. Appendix A - Listing of the WSDLs
8. Appendix B - Listing of the XSDs
9. Appendix C - Vocabulary VDEX Instance File Listings
10. Appendix D - Example SOAP Messages
11. About This Document
12. Revision History

1. Introduction

This document is a part of the 1EdTech GLC Person Management Service (PMS) v2.0 specification. The binding details how the Person Management Service Information Model is realised as a Web Service; in the form of a Web Services Description Language (WSDL) file. The PMS binding is contained in a set of WSDL, XSD and vocabulary files. The vocabulary files are instances of the 1EdTech Vocabulary Definition Exchange specification [VDEX, 04a], [VDEX, 04b]. The 1EdTech GLC Learning Information Services (LIS) Best Practice and Implementation Guide [LIS, 11b] provides non-normative guidance on how to use the Binding and Information Model. For a conceptual overview of the LIS Specification, please see the overall services description [LIS, 11a]. For a discussion of potential applications, see the Best Practice Guide.

1.1 Scope and Context

The 1EdTech GLC PMS WSDL Binding v2.0 is used in conjunction with the following documents:

1. 1EdTech GLC Person Management Service v2.0 Information Model v1.0 [PMS, 11] – the behaviour and data model definition of the Person Management Service;
2. 1EdTech GLC Learning Information Services v2.0 Best Practice and Implementation Guide v1.0 [LIS, 11b] – key information on how to adopt and implement the specification.

As such the Person Management Services specification supersedes the original Enterprise Services specifications:

1. 1EdTech GLC Person Management Services v1.0 Information Model Final Specification v1.0 [PMS, 04a];
2. 1EdTech GLC Person Management Services v1.0 WSDL Binding Final Specification v1.0 [PMS, 04b].

This WSDL binding takes the Membership Management Service Information Model and produces an encoding of that description in WSDL. This WSDL binding is generated as recommended by the 1EdTech GLC General Web Services documents [GWS, 06a], [GWS, 06b]. The WSDL is created using the IMC GLC Binding Auto-generation Tool-kit (I-BAT) [I-BAT, 06].

1.2 Structure of this Document

The structure of this document is:

1.3 Nomenclature

1.4 References

2. Platform Specific Model of the Binding

2.1 Service Description

Figure 2.1 is the PSM of the service group model description for the PMS. This information is used to establish the mapping to the binding flavors of WSDL.

Figure 2.2 is the PSM of the service model description for the GMS. The PSM is derived from the Platform Independent Model that was documented within the information model for the PMS specification [PMS, 10].

2.2 Data for the Service Operations

The data model for the service operations is shown in Figure 2.3 and 2.4. Figure 2.3 shows the data models for the set of parameters. Figure 2.4 is the data model for the Status Information and other WSDL-specific binding data structures.

2.3 Person Data Model

The PSM for the Person data models are shown in Figures 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12 and 2.13. Figure 2.5 is the Person data model, Figure 2.6 the FormName data model, Figure 2.7 is the NAme data model, Figure 2.8 is the Address data model, Figure 2.9 is the ContactInfo data model, Figure 2.10 is the Demographics data model, Figure 2.11 is the Enterprise Roles data model, Figure 2.12 is the Agent data model and Figure 2.13 contains the set of common data model classes.

3. Application of the Binding Guidelines

The WSDL/XSD bindings have been generated using the methodology documented in [GWS 06a] and [GWS, 06b]. Only the synchronous service binding has been created. The binding files are available in two forms:

• A single combined WSDL/XSD – PersonManagementServiceSyncSingle.wsdl;
• Separated WSDL and XSD files – PersonManagementServiceSyncWSDL.wsdl and PersonManagementServiceSyncXSD.xsd respectively.

It is recommended that only the combined form is used (many WSDL-based code generation tools do not process the 'import' instructions).

The mapping between the PIM and PSM descriptions is detailed in Table 3.1.

Key:

1. The 'PSM Reference' field refers to information in the PSM description (Section 2 in this document). The sub-fields are:
   1. Name – the name of the data structure in the PSM and PIM
   2. UML Type – the type of UML construct i.e. either Class or Attribute
   3. Figure – the reference Figure number in this document;
2. The 'PIM Reference' field refers to infomation in the PMS Information Model [PMS, 11]. The sub-fields are:
   1. Type – the type of the data structure in the Information Model
   2. Table – the reference number of Tabular description in the corresponding Information Model document;
3. The 'XSD Reference' field refers to infrmation in the XSD descriptions (Section 5 in this document). The sub-fields are:
   1. Name – the name of the field in the XSD(s)
   2. Type – the type of XSD construct i.e. either a ComplexType or Element.

4. WSDL File Documentation

WSDL file: "PersonManagementServiceSyncSingle.wsdl"

Target namespace: /services/lis/pms2p0/wsdl11/sync/imspms_v2p0

4.1 Overview

4.2 Messages

createByProxyPersonRequest

createPersonResponse

createByProxyPersonRequest

createByProxyPersonResponse

deletePersonRequest

deletePersonResponse

readPersonRequest

readPersonResponse

readPersonCoreRequest

readPersonCoreResponse

readAllPersonIdsRequest

readAllPersonIdsResponse

readPersonIdsFromSavePointRequest

readPersonIdsFromSavePointResponse

readPersonsRequest

readPersonsResponse

readPersonsFromSavePointRequest

readPersonsFromSavePointResponse

updatePersonRequest

updatePersonResponse

replacePersonRequest

replacePersonResponse

discoverPersonIdsRequest

discoverPersonIdsResponse

changePersonIdentifierRequest

changePersonIdentifierResponse

5. XSD File Documentation

The XSD file documentation has been produced by the Oxygen XML Editing tool.

5.1 Service Data Model

Click on the Section header to access this documentation for the data models in the service description.

5.2 File Data Model

Click on the Section header to access this documentation for the data models used in the BDEMS-based file data exchange.

6. Binding of the Vocabularies

The vocabularies in the PMS are:

• The type of formatted name vocabulary – the set of values for the type of formatted name. The PSM is shown in Figure 6.1;
• The type of name vocabulary – the set of values for the type of name. The PSM is shown in Figure 6.2;
• The type of name part-name vocabulary – the set of values for the allowed name parts. The PSM is shown in Figures 6.3a and 6.3b;
• The type of address vocabulary – the set of values for the type of address. The PSM is shown in Figures 6.4a and 6.4b;
• The address part vocabulary – the set of values for the allowed address parts. The PSM is shown in Figures 6.5a, 6.5b and 6.5c;
• The type of contact information vocabulary – the set of values for the type of contact information. The PSM is shown in Figures 6.6a, 6.6b, 6.6c and 6.6d;
• The type of demographics vocabulary – the set of values for the type of demographics. The PSM is shown in Figures 6.7a, 6.7b and 6.7c;
• The demographics information vocabulary – the set of values for the parts of demographics information. The PSM is shown in Figure 6.8;
• The type of representations vocabulary – the set of values for the parts of representation information. The PSM is shown in Figure 6.9;
• The type of enterprise system role vocabulary – the set of values for the type of enterprise system roles. The PSM is shown in Figure 6.10;
• The type of instutition role vocabulary – the set of values for the type of institution roles. The PSM is shown in Figures 6.11a and 6.11b;
• The type of system role vocabulary – the set of values for the type of system roles. The PSM is shown in Figures 6.12;
• The enrollment information vocabualry – the set of values for the enrollments. The PSM is shown in Figure 6.13;
• The type of agent vocabulary– the set of values for the type of agent. The PSM is shown in Figures 6.14;
• The type of event date vocabulary – the set of values for the type of event date. The PSM is shown in Figures 6.15;
• Extension data-type vocabulary – the set of data-types that are permitted for extensions in the Group data model. The PSM for the extension data-type vocabulary is shown in Figure 6.16.

These vocabularies are the default set maintained under the 1EdTech GLC Vocabulary Registry [SDN11, 06].  It is the responsibility of an implementation to ensure that it is using the correct and latest versions of the vocabulary files.  Changes to the default vocabularies are permitted; this results in the creation of a new vocabulary that should be registered with 1EdTech GLC.  As part of a profiling process entirely new vocabularies may be defined to replace the default set.

Appendix A - Listing of the WSDLs

The WSDL bindings are for a Synchronous SOAP implementation only. The WSDL files, expressed using WSDLv1.1, are:

• The combined WSDL/XSD file (this contains the WSDL and XSD descriptions in a single file) – PersonManagementServicev2p0_SyncSingle_v1p0.wsdl
• The single WSDL file (used in conjunction with the separate XSD file) is available to LIS Alliance members. Click here to join the Alliance.

These files were generated by the I-BATv0.9.5 tool using the PSM representation described in Section 2.

Appendix B - Listing of the XSDs

The XSD files are:

• The stand-alone XSD is available to LIS Alliance members. Click here to join the Alliance;
• The XSD for the external data file – imspms_filemodel_v2p0.xsd.

This file was generated by the I-BATv0.9.5 tool using the PSM representation described in Section 2. Documentation of the XSDs is supplied in Section 5.

Appendix C - Vocabulary VDEX Instance File Listings

The PMS vocabularies are:

• The type of formatted name vocabulary – formatnmetypevocabularyv1p0.xml;
• The type of name vocabulary – nametypevocabularyv1p0.xml;
• The type of name part-name vocabulary – partnamevocabularyv1p0.xml;
• The type of address vocabulary – addresstypevocabularyv1p0.xml;
• The address part vocabulary – addresspartvocabularyv1p0.xml;
• The type of contact information vocabulary – contactinfotypevocabularyv1p0.xml;
• The type of demographics vocabulary – demographicstypevocabulartv1p0.xml;
• The type of representations vocabulary – representationtypevocabularyv1p0.xml;
• The demographics information vocabulary – demographicsinfovocabulartv1p0.xml;
• The type of enterprise system role vocabulary – epriserolestypevocabularyv1p0.xml;
• The type of institution role vocabulary – institutionroletypevocabularyv1p0.xml;
• The type of system role vocabulary – systemrolevocabularyv1p0.xml;
• The enrollment information vocabulary – enrollmentinfovocabularyv1p0.xml;
• The type of agent vocabulary – agenttypevocabularyv1p0.xml;
• The type of event date vocabulary – eventdatevocabularyv1p0.xml;
• Extension data-types vocabulary – extensionvocabularyv1p0.xml;
• Language codes – languagecodesvocabularyv1p0.xml. The set of codes used to identifiy the language for a string (based upon RFC4646).

The online versions of these vocabularies are available in the directory: /vdex/lis/pmsv2p0. These vocabularies are expressed as instances of the 1EdTech GLC Vocabulary Data Exchange (VDEX) v1.0 specification. Documentation of the vocabulary is supplied in Section 6.

Appendix D - Example SOAP Messages

The set of examples for the SOAP messages are listed in Table D.1. The messaging pattern is a Request/Response exchange to support the Synchronous Service definition.

Table D.1 The set of SOAP message examples for each operation.

About This Document

List of Contributors

The following individuals contributed to the development of this document:

Revision History