WSDLv1.1 File Information ------------------------- Services: PersonManagementService (Synchronous Communications) Author: Colin Smythe Date: 31st January, 2010 Version: Final 1.0 Status: Public Draft Description: The Person Management Service. This forms a part of the IMS GLC Learning Informaton Services v2.0 Specification. History: Release 1.0: This is the first formal release of version 2.0 of this service. This version supercedes v1.0. This is an integration of the Person Service from the Learning Information Services and the 'identification' data model from the IMS GLC Learner Information Package v1.0 specification. WSDL Binding: WSDL Binding is based upon the IMS GLC General Web Services Base Profile v1.0 The IMS GLC GWS Basic Profile is derived from the WS-I Basic Profile v1.1. This profile uses: WSDL 1.1, SOAP 1.1, HTTP 1.1 and XML 1.0. Extension profiles to the IMS GLC GWS Base Profile are available but are not supported using this tool version. License: IPR, License and Distribution Notices This machine readable file is derived from IMS Global Learning Consortium (GLC) specification IMS GLC LIS Person Management Service Version 1.0 found at http://www.imsglobal.org/lis and the original IMS GLC schema binding or code base http://www.imsglobal.org/lis. 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 the schema binding contained in this document. IMS GLC 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 IMS GLCs procedures with respect to rights in IMS GLC specifications can be found at the IMS GLC Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf. Copyright (c) IMS Global Learning Consortium 1999-2010. All Rights Reserved. License Notice for Users Users of products or services that include this document are hereby granted a worldwide, royalty-free, non-exclusive license to use this document. Distribution Notice for Developers Developers of products or services that are not original incorporators of this document and have not changed this document, that is, are distributing a software product that incorporates this document as is from a third-party source other than IMS, are hereby granted permission to copy, display and distribute the contents of this document in any medium for any purpose without fee or royalty provided that you include this IPR, License and Distribution notice in its entirety on ALL copies, or portions thereof. Developers of products or services that are original incorporators of this document and wish to provide distribution of this document as is or with modifications and developers of products and services that are not original incorporators of this document and have changed this document, are required to register with the IMS GLC community on the IMS GLC website as described in the following two paragraphs:- * If you wish to distribute this document as is, with no modifications, you are hereby granted permission to copy, display and distribute the contents of this document in any medium for any purpose without fee or royalty provided that you include this IPR, License and Distribution notice in its entirety on ALL copies, or portions thereof, that you make and you complete a valid license registration with IMS and receive an email from IMS granting the license. To register, follow the instructions on the IMS website: http://www.imsglobal.org/specificationdownload.cfm. Once registered you are granted permission to transfer unlimited distribution rights of this document for the purposes of third-party or other distribution of your product or service that incorporates this document as long as this IPR, License and Distribution notice remains in place in its entirety; * If you wish to create and distribute a derived work from this document, you are hereby granted permission to copy, display and distribute the contents of the derived work in any medium for any purpose without fee or royalty provided that you include this IPR, License and Distribution notice in its entirety on ALL copies, or portions thereof, that you make and you complete a valid profile registration with IMS GLC and receive an email from IMS GLC granting the license. To register, follow the instructions on the IMS GLC website: http://www.imsglobal.org/profile/. Once registered you are granted permission to transfer unlimited distribution rights of the derived work for the purposes of third-party or other distribution of your product or service that incorporates the derived work as long as this IPR, License and Distribution notice remains in place in its entirety. The limited permissions granted above are perpetual and will not be revoked by IMS GLC 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 IMPLEMENTERS 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. UML Source File Information --------------------------- Choreography: Sync Transport: SOAPv1.1 Source UML File Information --------------------------- The source file information must be supplied as an XMI file (without diagram layout information). The supported UML authoring tools are: (a) Poseidon – v6 (and later) Source XSLT File Information ---------------------------- XSL Generator: UMLtoWSDLv1.1Transformv0p9.xsl XSLT Processor: Xalan Release: 1.0 Beta 3 Date: 31st May, 2009 IMS GLC Auto-generation Binding Tool-kit (I-BAT) ------------------------------------------------ This file was auto-generated using the IMS GLC Binding Auto-generation Tool-kit (I-BAT). While every attempt has been made to ensure that this tool auto-generates the files correctly, users should be aware that this is an experimental tool. Permission is given to make use of this tool. IMS GLC makes no claim on the materials created by third party users of this tool. Details on how to use this tool are contained in the IMS GLC "I-BAT" Documentation available at the IMS GLC web-site. Tool Copyright: 2005-2010 (c) IMS Global Learning Consortium Inc. All Rights Reserved. The Person data-type is the top-level container for the Person data model. The data model consists of: (1) Zero or more formatted names; (2) Zero or more partenised names; (3) Zero or more addresses; (4) Zero or more contact information sets; (5) Zero or more demographic sets; (6) Zero or more agents; (7) Zero or more roles within the Enterprise; (8) An optional extension point. The PersonCore data-type is the top level container for the mandatory aspects of the Person data-model. The data model consists of: (1) SourcedId; (2) Formatted name; (3) UserId. The PersonRecord complexType is the container for the collation of the Person data structure and its sourcedGUID. The Name type is the container for Person. The name is supplied in a defined parts. There is no order of preference of those parts. Each Name is typed e.g. alias, prefered, etc. An external vocabulary is used for the set of types of name. This vocabulary is contained in the VDEX file "ims_names_vocabularyv1p0.xml." A separate external vocabulary is used to contain the types of name parts. This vocabulary is contained in the VDEX file "ims_partnames_vocabularyv1p0.xml". The Demographics data-type is the container for the demographics information for the Person. The type of demographics is contained in an external vocabulary. The vocabulary is contained in the VDEX file "ims_demographicstype_vocabularyv1p0.xml". The set of demographics structrues can be extended using a vocabulary. The default vocabulary is contained in the external VDEX file "ims_demographics_vocabularyv1p0.xml". The Representation data-type is a container for information that is used to represent the Person e.g. photograph. An external vocabulary is used to define the type of representation. This vocabulary is contained in the VDEX file "ims_representaton_vocabularyv1p0.xml". The ContactInfo compexType is the container for the electronic-oriented contact information. The type of contact information is defined in an extenal viocabulary. the vocabulary is contained in the VDEX file "ims_contactinfo_vocabularyv1p0.xml". The EnterpriseRole data-type is a container for all of the information used to define roles and access within the institution and system. The system roles are defined in an external vocabulary. This vocabulary is contained in the VDEX file "ims_systemroles_vocabularyv1p0.xml". The UserId data-type is the container for the user's access information in the learning management system. The InstitutionRole data-type is the container used to identify the roles of the Person within the institution. The set of roles is defined in an external vocabulary. This vocabulary is contained within the VDEX file "ims_institution_vocabularyv1p0.xml". The GUIDSet data-type is the container for a set of SourcedIds. The Text data-type is the container for the languge-string tuple. The ContentType data-type is the container is for the structure that is used to identify a value from a named vocabulary. The Description data-type is the container for all of the material that is used to describe something. It has short (text), long (text) and full (multimedia) forms. The FullDescription data-type is the container for the multimedia-based description. The BaseValueSingle complexType is the container for the structure that is used to identify a name/value pair from a vocabulary (the name is in the vocabulary). The IMSExtension data-type is the container for the set of extensions. The ExtensionField is the data-type for the 3-tuples that describe each extension field. PortType Description -------------------- This is the PersonManager interface. The operations are: 1) CreatePerson 2) CreateByProxyPerson 3) DeletePerson 4) ReadPerson 5) ReadPersonCore 6) ReadAllPersonIds 7) ReadPersonIdsFromSavePoint 8) ReadPersons 9) ReadPersonsFromSavePoint 10) UpdatePerson 11) ReplacePerson 12) DiscoverPersonIds 13) ChangePersonIdentifier Operation Description --------------------- When the source issues the 'createPerson' request the target is instructed to create the populated Person object and to allocate that structure to the 'sourcedId' passed by the source. If the supplied 'sourcedId' has already been allocated to another object then the request is rejected and the appropriate failure code is returned. The save- point identifier is set to 'zero' for the Person object in both the source and target. Operation Description --------------------- Operation Description --------------------- When the source issues the 'deletePerson' request the target is instructed to delete the identified Person object and to remove the reference to the Person from any of the related Membership objects. This is a hard cascaded delete from which there is no recovery. If the object identified by the supplied 'sourcedId' cannot be located then the request is rejected and the appropriate failure code is returned. Operation Description --------------------- Operation Description --------------------- Operation Description --------------------- Operation Description --------------------- Operation Description --------------------- Operation Description --------------------- Operation Description --------------------- Operation Description --------------------- Operation Description --------------------- Operation Description --------------------- Service Information ------------------- Author: Colin Smythe Date: 31st January, 2010 Version: Final 1.0 Status: Public Draft Description: The Person Management Service is composed of a single interface. History: Version 1.0: This is the first formal release of this service.