IMS Final Release

IMS logo

IMS Global Group Management Service WSDL/XSD Binding

Version 2.0.1

Final Release

 

Date Issued: 30 September 2013

Latest version: http://www.imsglobal.org/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.

IMS 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 IMSs procedures with respect to rights in IMS specifications can be found at the IMS Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

Copyright © 2013 IMS Global Learning Consortium. All Rights Reserved.

Use of this specification to develop products or services is governed by the license with IMS found on the IMS website: http://www.imsglobal.org/license.html.

Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.

The limited permissions granted above are perpetual and will not be revoked by IMS 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.

top

Table of Contents

  1. Introduction

a.       Scope and Context

b.      Structure of this Document

c.       Nomenclature

d.      References

  1. Platform Specific Model of the Binding

 .        Service Description

a.       Data for the Service Operations

b.      Group Data Model

c.       File-based Exchange Data Model

  1. Application of the Binding Guidelines
  2. WSDL File Documentation

 .        Overview

a.       Messages

  1. XSD File Documentation

 .        Service Data Model XSD Documentation

a.       File Data Model XSD Documentation

  1. Binding of the Vocabularies
  2. Appendix A - Listing of the WSDLs
  3. Appendix B - Listing of the XSDs
  4. Appendix C - Vocabulary VDEX Instance File Listings
  5. Appendix D - Example SOAP Messages
  6. About This Document
  7. Revision History

top

1. Introduction

This document is a part of the IMS Global Group Management Service (GMS) v2.0 specification. The binding details how the Group Management Service Information Model is realised as a Web Service; in the form of a Web Services Description Language (WSDL) file. The GMS binding is contained in a set of WSDL, XSD and vocabulary files. The vocabulary files are instances of the IMS Vocabulary Definition Exchange specification [VDEX, 04a], [VDEX, 04b]. The IMS Global Learning Information Services (LIS) Best Practice and Implementation Guide [LIS, 13b] 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, 13a]. For a discussion of potential applications, see the Best Practice Guide.

1.1 Scope and Context

The IMS Global GMS WSDL Binding v1.0 is used in conjunction with the following documents:

  1. IMS Global Group Management Service Information Model v1.0 [GMS, 13] the behaviour and data model definition of the Group Management Service;
  2. IMS Global Learning Information Services Best Practice and Implementation Guide v1.0 [LIS, 13b] key information on how to adopt and implement the specification.

As such the Group Management Service specification supersedes the original Enterprise Services specifications:

  1. IMS Global Group Management Service Information Model Final Specification v1.0 [GMS, 04a];
  2. IMS Global Group Management Service WSDL Binding Final Specification v1.0 [GMS, 04b].

This WSDL binding takes the Group Management Service Information Model and produces an encoding of that description in WSDL. This WSDL binding is generated as recommended by the IMS Global 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:

2. Platform Specific Model of the Binding

The description platform specific models in the form of the IMS GLC UML-Profile service/data models representation of the IMS Global GMS specification information model. This representation is used by the IMS Global I-BAT tool to auto-generate the corresponding WSDL/XSDs;

3. Application of the Binding Guidelines

Explanation of how the platform specific model is realised as the WSDL/XSD binding. This addresses how the information model is realised as a Web Service;

4. WSDL File Documentation

The description of the Web Services used to realise the service model components of the binding. This part of the binding document was created using the schema documentation tool provided as part of the Oxygen 12.2 product;

5. XSD File Documentation

The description of the elements used within the data model components of the binding. This part of the binding document was created using the schema documentation tool provided as part of the Oxygen 12.2 product;

6. Vocabulary Binding Using VDEX Instances

Contains the description of how the set of external vocabulary files realised as VDEX files;

Appendix A - Listing of the WSDL Files

This is the full listing of the GMS WSDL files;

Appendix B - Listing of the XSD Files

This is the full listing of the GMS XSD files;

Appendix C - Vocabulary VDEX Instance File Listings

This is the full listing of the set of external vocabulary VDEX instance files.

Appendix D - Examples SOAP Messages

Examples of the SOAP messages that are exchanged to realise the service.

1.3 Nomenclature

GMS

Group Management Service

HTTP

HyperText Transfer Protocol

I-BAT

IMS Global Binding Auto-generation Tool-kit

IMS Global

IMS Global Learning Consortium

LIS

Learning Information Services

MDA

Model Driven Architecture

PIM

Protocol Independent Model

PSM

Platform Specific Model

UML

Unified Modelling Language

VDEX

Vocabulary Definition Exchange

W3C

World Wide Web Consortium

WSDL

Wed Services Description Language

XMI

XML Meta-data Interchange

XML

Extensible Mark-up Language

XSD

XML Schema Definition

XSL

Extensible Stylesheet Language

XSLT

XSL Transformations

1.4 References

[GMS, 04a]

IMS Global Group Management Services Information Model Specification Final Release v1.0, C.Vento and C.Smythe, IMS Global Learning Consortium, June 2004.

[GMS, 04b]

IMS Global Group Management Services WSDL Binding Specification Final Release v1.0, C.Vento and C.Smythe, IMS Global Learning Consortium, June 2004.

[GMS, 13]

IMS Global Group Management Services Information Model Specification v2.0.1 Final Release , L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium, September 2013.

[GWS, 06a]

IMS Global General Web Services Base Profile Specification Final Release v1.0, C.Schroeder, J.Simon and C.Smythe, IMS Global Learning Consortium, January 2006.

[GWS, 06b]

IMS Global General Web Services WSDL Binding Guidelines Final Release v1.0, C.Schroeder, J.Simon and C.Smythe, IMS Global Learning Consortium, January 2006.

[I-BAT, 06]

IMS Binding Auto-generation Toolkit Manual v1.0, C.Smythe, IMS Global Learning Consortium, July 2006.

[LIS, 13a]

IMS Global Learning Information Services Specification v2.0.1 Final Release , L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium, September 2013.

[LIS, 13b]

IMS Global Learning Information Services Best Practice and Implementation Guide v2.0.1 Final Release , L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium, September 2013.

[SDN11, 06]

IMS Global Specification Note 11: Vocabulary Definition, Registration & Maintenance Procedures, C.Smythe, IMS Global Learning Consortium, October 2006.

[VDEX, 04a]

IMS Vocabulary Definition Exchange Information Model Specification Final Release v1.0, A.Cooper, IMS Global Learning Consortium, February 2004.

[VDEX, 04b]

IMS Vocabulary Definition Exchange XML Binding Specification Final Release v1.0, A.Cooper, IMS Global Learning Consortium, February 2004.

top | toc

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 GMS. This information is used to establish the mapping to the binding flavors of WSDL.

Figure 2.1 The PSM representation of the service group model description for the GMS.

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 GMS specification [GMS, 13].

Figure 2.2 The PSM representation of the service model description for the GMS.

2.2 Data for the Service Operations

The data model for the service opertaions 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.

Figure 2.3 The PSM representation of the parameters data model description for the GMS.

Figure 2.4 The PSM representation of the status information data model description for the GMS.

2.3 Group Data Model

The PSM for the Group data models are shown in Figures 2.5 and 2.6. Figure 2.5 is the Group data model and Figure 2.6 contains the set of common data model classes.

Figure 2.5 The PSM representation of the Group data model description for the GMS.

Figure 2.6 The PSM representation of the common data models description for the GMS.

2.4 File-based Data Exchange Data Model

The PSM for the file-based Group data models are shown in Figures 2.7 and 2.8. Figure 2.7 is the GroupRecord data model and Figure 2.8 contains the set of common data model classes.

Figure 2.7 The PSM representation of the GroupRecord data model description for file storage in the GMS.

Figure 2.8 The PSM representation of the common data model descriptions for file storage in the GMS.

top | toc

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 GroupManagementServiceSyncSingle.wsdl;
  • Separated WSDL and XSD files GroupManagementServiceSyncWSDL.wsdl and GroupManagementServiceSyncXSD.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.

Table 3.1 Mapping between the PIM, PSM and XSD descriptions for the data models.

PSM Reference

PIM Reference

XSD Reference

Name

UML Type

Figure

Type

Table

Name

Type

GroupRecordSet

Class

2.5

GroupRecordSet

 

GroupRecordSet.Type

ComplexType
  • groupRecord

Attribute

2.5

GroupRecord

 

groupRecord

Element

GroupRecord

Class

2.5

 

5.3

GroupRecord.Type

ComplexType
  • sourcedGUID

Attribute

2.5

SourcedGUID

5.4

sourcedGUID

Element
  • group

Attribute

2.5

Group

5.10

group

Element

SourcedGUID

Class

2.5

 

5.5

SourcedGUID.Type

ComplexType
  • refAgentInstanceId

Attribute

2.5

NormalizedString

5.6

refAgentInstanceId

Element
  • sourcedId

Attribute

2.5

SourcedId

5.7

sourcedId

Element

Group

Class

2.5

 

5.10

Group.Type

ComplexType
  • groupType

Attribute

2.5

GroupType

5.11

groupType

Element
  • email

Attribute

2.5

Email

5.12

email

Element
  • url

Attribute

2.5

URL

5.13

url

Element
  • timeFrame

Attribute

2.5

TimeFrame

5.14

timeFrame

Element
  • relationship

Attribute

2.5

Relationship

5.15

relationship

Element
  • enrollControll

Attribute

2.5

EnrollControll

5.16

enrollControll

Element
  • org

Attribute

2.5

Org

5.17

org

Element
  • description

Attribute

2.5

Description

5.18

description

Element
  • dataSource

Attribute

2.5

GUID

5.19

dataSource

Element
  • recordInfo

Attribute

2.5

Metadata

5.20

recordInfo

Element
  • extension

Attribute

2.5

IMSExtension

5.21

extension

Element

GroupType

Class

2.5

 

5.22

GroupType.Type

ComplexType
  • scheme

Attribute

2.5

Text

5.23

scheme

Element
  • typeValue

Attribute

2.5

TypeValue

5.24

typeValue

Element

TypeValue

Class

2.5

 

5.25

TypeValue.Type

ComplexType
  • id

Attribute

2.5

LUID

5.26

id

Element
  • type

Attribute

2.5

Text

5.27

type

Element
  • level

Attribute

2.5

Text

5.28

level

Element

Relationship

Class

2.5

 

5.29

Relationship.Type

ComplexType
  • relationId

Attribute

2.5

GUID

5.30

relationId

Element
  • relation

Attribute

2.5

Enumerated

5.31

relation

Element
  • sourcedId

Attribute

2.5

GUID

5.32

sourcedId

Element
  • label

Attribute

2.5

Text

5.33

label

Element

EnrollControll

Class

2.6

 

5.34

EnrollControll.Type

ComplexType
  • enrollAccept

Attribute

2.6

Boolean

5.35

enrollAccept

Element
  • enrollAllowed

Attribute

2.6

Boolean

5.36

enrollAllowed

Element

Org

Class

2.6

 

5.37

Org.Type

ComplexType
  • orgName

Attribute

2.6

Text

5.38

orgName

Element
  • orgUnit

Attribute

2.6

Text

5.39

orgUnit

Element
  • type

Attribute

2.6

Text

5.40

type

Element
  • id

Attribute

2.6

Text

5.41

id

Element

TimeFrame

Class

2.6

 

5.51

TimeFrame.Type

ComplexType
  • begin

Attribute

2.6

DateTime

5.52

begin

Element
  • end

Attribute

2.6

DateTime

5.53

end

Element
  • restrict

Attribute

2.6

Boolean

5.54

restrict

Element
  • adminPeriod

Attribute

2.6

Text

5.55

adminPeriod

Element

Description

Class

2.6

 

5.42

Description.Type

ComplexType
  • shortDescription

Attribute

2.6

Text

5.43

shortDescription

Element
  • longDescription

Attribute

2.6

Text

5.44

longDescription

Element
  • fullDescription

Attribute

2.6

FullDescription

5.45

fullDescription

Element

FullDescription

Class

2.6

 

5.46

FullDescription.Type

ComplexType
  • mediamode

Attribute

2.6

Enumerated

5.47

mediamode

Element
  • contentRefType

Attribute

2.6

Enumerated

5.48

contentRefType

Element
  • mimeType

Attribute

2.6

NormailsedString

5.49

mimeType

Element
  • descriptionText

Attribute

2.6

Text

5.50

description

Element

Metadata

Class

2.6

 

5.59

Metadata.Type

ComplexType
  • metadataNameVocabulary

Attribute

2.6

AnyURI

5.60

metadataNameVocabulary

Element
  • metadataTypeVocabulary

Attribute

2.6

AnyURI

5.61

metadataTypeVocabulary

Element
  • metadataField

Attribute

2.6

ExtensionField

5.62

metadataField

Element

IMSExtension

Class

2.6

 

5.63

IMSExtension.Type

ComplexType
  • extensionNameVocabulary

Attribute

2.6

AnyURI

5.64

extensionNameVocabulary

Element
  • extensionTypeVocabulary

Attribute

2.6

AnyURI

5.65

extensionTypeVocabulary

Element
  • extensionField

Attribute

2.6

ExtensionField

5.66

extensionField

Element

ExtensionField

Class

2.6

 

5.67

ExtensionField.Type

ComplexType
  • fieldName

Attribute

2.6

NormalisedString

5.68

fieldName

Element
  • fieldType

Attribute

2.6

NormalisedString

5.69

fieldType

Element
  • fieldValue

Attribute

2.6

NormalisedString

5.70

fieldValue

Element

Text

Class

2.6

 

5.56

Text.Type

ComplexType
  • language

Attribute

2.6

Enumerated

5.57

language

Element
  • textString

Attribute

2.6

String

5.58

textString

Element

imsx_StatusInfo

Class

2.4

n/a

n/a

imsx_StatusInfo.Type

ComplexType
  • imsx_codeMajor

Attribute

2.4

n/a

n/a

imsx_codeMajor

Element
  • imsx_severity

Attribute

2.4

n/a

n/a

imsx_severity

Element
  • imsx_messageRefIdentifier

Attribute

2.4

n/a

n/a

imsx_messageRefIdentifier

Element
  • imsx_operationRefIdentifier

Attribute

2.4

n/a

n/a

imsx_operationRefIdentifier

Element
  • imsx_description

Attribute

2.4

n/a

n/a

imsx_description

Element
  • imsx_codeMinor

Attribute

2.4

n/a

n/a

imsx_codeMinor

Element

imsx_CodeMinor

Class

2.4

n/a

n/a

imsx_CodeMinor.Type

ComplexType
  • imsx_codeMinorField

Attribute

2.4

n/a

n/a

imsx_codeMinorField

Element

imsx_CodeMinorField

Class

2.4

n/a

n/a

imsx_CodeMinorField.Type

ComplexType
  • imsx_codeMinorFieldName

Attribute

2.4

n/a

n/a

imsx_codeMinorFieldName

Element
  • imsx_codeMinorFieldValue

Attribute

2.4

n/a

n/a

imsx_codeMinorFieldValue

Element

imsx_StatusBinding

Class

2.4

n/a

n/a

imsx_StatusBinding.Type

ComplexType
  • imsx_syncRequestHeaderInfo

Attribute

2.4

n/a

n/a

imsx_syncRequestHeaderInfo

Element
  • imsx_syncResponseHeaderInfo

Attribute

2.4

n/a

n/a

imsx_syncResponseHeaderInfo

Element

imsx_RequestHeaderInfo

Class

2.4

n/a

n/a

imsx_RequestHeaderInfo.Type

ComplexType
  • imsx_version

Attribute

2.4

n/a

n/a

imsx_version

Element
  • imsx_messageIdentifier

Attribute

2.4

n/a

n/a

imsx_messageIdentifier

Element

imsx_ResponseHeaderInfo

Class

2.4

n/a

n/a

imsx_ResponseHeaderInfo.Type

ComplexType
  • imsx_version

Attribute

2.4

n/a

n/a

imsx_version

Element
  • imsx_messageIdentifier

Attribute

2.4

n/a

n/a

imsx_messageIdentifier

Element
  • imsx_statusInfo

Attribute

2.4

n/a

n/a

imsx_statusInfo

Element

Key:

I.                        The 'PSM Reference' field refers to information in the PSM description (Section 2 in this document). The sub-fields are:

a.       Name the name of the data structure in the PSM and PIM

b.      UML Type the type of UML construct i.e. either Class or Attribute

c.       Figure the reference Figure number in this document;

       II.            The 'PIM Reference' field refers to infomation in the GMS Information Model [GMS, 13]. The sub-fields are:

 .        Type the type of the data structure in the Information Model

a.       Table the reference number of Tabular description in the corresponding Information Model document;

      III.            The 'XSD Reference' field refers to infrmation in the XSD descriptions (Section 5 in this document). The sub-fields are:

 .        Name the name of the field in the XSD(s)

a.       Type the type of XSD construct i.e. either a ComplexType or Element.

top | toc

4. WSDL File Documentation

WSDL file: "GroupManagementServiceSyncSingle.wsdl"

Target namespace: http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0

4.1 Overview

Services

GroupManagementServiceSyncService

Bindings

GroupManagerSyncSoapBinding

Port types

GroupManagerSyncPortType

Messages

createGroupRequest, createGroupResponse, createByProxyGroupRequest, createByProxyGroupResponse, deleteGroupRequest, deleteGroupResponse, addGroupRelationshipRequest, addGroupRelationshipResponse, removeGroupRelationshipRequest, removeGroupRelationshipResponse, readGroupRequest, readGroupResponse, readAllGroupIdsRequest, readAllGroupIdsResponse, readGroupIdsForPersonRequest, readGroupIdsForPersonResponse, readGroupIdsFromSavePointRequest, readGroupIdsFromSavePointResponse, readGroupsRequest, readGroupsResponse, readGroupsFromSavePointRequest, readGroupsFromSavePointResponse, updateGroupRequest, updateGroupResponse, replaceGroupRequest, replaceGroupResponse, discoverGroupIdsRequest, discoverGroupIdsResponse, changeGroupIdentifierRequest, changeGroupIdentifierResponse,

 

WSDL Definition

Name

Documentation

GroupManagementServiceSyncServices

WSDL File Information

Services: GroupManagementService (Synchronous Communications)

Author: Colin Smythe

Date: 31st May, 2011

Version: Final 1.0

Status: Final Release

Description: The Group Management Service.

History: Version 1.0: This is the first formal release of this service.

WSDL Binding: WSDL Binding is based upon the IMS General Web Services Base Profile v1.0 The IMS 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 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 Global Group Management Service Version 2.0 found at http://www.imsglobal.org/lis/gmsv2p0/imsgms_InfoFinalv1p0.html and the original IMS schema binding or code base http://www.imsglobal.org/lis/gmsv2p0/imsgms_BindFinalv1p0.html. 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 Global 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 Globals procedures with respect to rights in IMS Global specifications can be found at the IMS Global Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

Copyright IMS Global Learning Consortium 1999-2011. 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 Global community on the IMS Global 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 Global and receive an email from IMS Global 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 Global 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: UMLtoWSDLTransformv0p9.xsl

XSLT Processor: Xalan

Release: 1.0 Beta 4

Date: 31st March, 2011

IMS Global Auto-generation Binding Tool-kit (I-BAT)

This file was auto-generated using the IMS Global 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 Global 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 Global "I-BAT" Documentation available at the IMS Global web-site.

Tool Copyright: 2005-2011 (c) IMS Global Learning Consortium Inc. All Rights Reserved.

 

Services

Name

Documentation

GroupManagementServiceSyncService

Service Information

Author: Colin Smythe

Date: 31st May, 2011

Version: Final 1.0

Status: Final Releas

Description: The Group Management Service is composed of a single interface.

History: Version 1.0: This is the first formal release of this service.

 

Service : GroupManagementServiceSyncService

Port Name

Binding

Address Extensibility

Documentation

GroupManagerSyncSoapPort

GroupManagerSyncSoapBinding

<soap11:address location="http://www.imsglobal.org/lis/gms2p0/GroupManagerSyncSoap/"/>

N/A

 

Binding : GroupManagerSyncSoapBinding

Port Type

GroupManagerSyncPortType

Extensibility

<soap11:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>

Operations

createGroup, createByProxyGroup, deleteGroup, addGroupRelationship, removeGroupRelationship, readGroup, readAllGroupIds, readGroupIdsForPerson, readGroupIdsFromSavePoint, readGroups, readGroupsFromSavePoint, updateGroup, replaceGroup, discoverGroupIds, changeGroupIdentifier,

 

Port Type : GroupManagerSyncPortType

Operation Name

Input message

Output message

Documentation

createGroup

createGroupRequest

createGroupResponse

The 'createGroup' operation is responsible for creating a new Group object on the service provider. The service consumer supplies the 'sourcedId' to be used to identify the new Group.

createByProxyGroup

createByProxyGroupRequest

createByProxyGroupResponse

The 'createByProxyGroup' operation is responsible for creating a new Group object on the service provider. The service provider supplies the 'sourcedId' to be used to identify the new Group.

deleteGroup

deleteGroupRequest

deleteGroupResponse

The 'deleteGroup' operation deletes the identified Group object. This means the 'sourcedId' can then be reused for another object.

addGroupRelationship

addGroupRelationshipRequest

addGroupRelationshipResponse

The 'addGroupRelationship' operation provides a mechanism by which new relationships to other Group and, some, Course objects can be created.

removeGroupRelationship

removeGroupRelationshipRequest

removeGroupRelationshipResponse

The 'removeGroupRelationship' operation provides a mechanism by which established relationships to other Group and, some, Course objects can be deleted.

readGroup

readGroupRequest

readGroupResponse

The 'readGroup' operation requests the service provider to return all of the data stored for the identified Group object.

readAllGroupIds

readAllGroupIdsRequest

readAllGroupIdsResponse

The 'readAllGroupIds' operation requests the service provider to return the SourcedIds for all of the Group objects.

readGroupIdsForPerson

readGroupIdsForPersonRequest

readGroupIdsForPersonResponse

The 'readAllGroupIdsForPerson' operation requests the service provider to return the SourcedIds for all of the Group objects for which the supplied Person is a member.

readGroupIdsFromSavePoint

readGroupIdsFromSavePointRequest

readGroupIdsFromSavePointResponse

The 'readAllGroupIdsFromSavePoint' operation requests the service provider to return the SourcedIds for all of the Group objects from the defined reference 'savePoint'.

readGroups

readGroupsRequest

readGroupsResponse

The 'readGroups' operation requests the service provider to return all of the data stored for the identified set of Group objects.

readGroupsFromSavePoint

readGroupsFromSavePointRequest

readGroupsFromSavePointResponse

The 'readGroupsFromSavePoint' operation requests the service provider to return all of the data stored for the identified set of Group objects from the defined reference 'savePoint'.

updateGroup

updateGroupRequest

updateGroupResponse

The 'updateGroup' operation is responsible for changing the Group object on the service provider by making an additive write to the previously stored data.

replaceGroup

replaceGroupRequest

replaceGroupResponse

The 'replaceGroup' operation is responsible for changing the Group object on the service provider by making a destructive replacement of all the previously stored data. If the original object cannot be found, this operation acts as if it was a 'createGroup' operation call.

discoverGroupIds

discoverGroupIdsRequest

discoverGroupIdsResponse

The 'discoverGroupIds' operation requests the service provider to return the SourcedIds of all of the Group objects that sustain the query criteria. At present, there is no defined format for the query i.e. the query is passed as a string.

changeGroupIdentifier

changeGroupIdentifierRequest

changeGroupIdentifierResponse

The 'changeGroupIdentifier' operation enables the service consumer to change the 'SourcedId' assigned to a Group object on a service provider.

 

4.2 Messages

createGroupRequest

Part Name

Element

Type

Documentation

Parameters

tns:createGroupRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createGroupResponse

Part Name

Element

Type

Documentation

Response

tns:createGroupResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createByProxyGroupRequest

Part Name

Element

Type

Documentation

Parameters

tns:createByProxyGroupRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createByProxyGroupResponse

Part Name

Element

Type

Documentation

Response

tns:createByProxyGroupResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

deleteGroupRequest

Part Name

Element

Type

Documentation

Parameters

tns:deleteGroupRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

deleteGroupResponse

Part Name

Element

Type

Documentation

Response

tns:deleteGroupResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

addGroupRelationshipRequest

Part Name

Element

Type

Documentation

Parameters

tns:addGroupRelationshipRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

addGroupRelationshipResponse

Part Name

Element

Type

Documentation

Response

tns:addGroupRelationshipResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

removeGroupRelationshipRequest

Part Name

Element

Type

Documentation

Parameters

tns:removeGroupRelationshipRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

removeGroupRelationshipResponse

Part Name

Element

Type

Documentation

Response

tns:removeGroupRelationshipResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readGroupRequest

Part Name

Element

Type

Documentation

Parameters

tns:readGroupRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readGroupResponse

Part Name

Element

Type

Documentation

Response

tns:readGroupResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readAllGroupIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readAllGroupIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readAllGroupIdsResponse

Part Name

Element

Type

Documentation

Response

tns:readAllGroupIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readGroupIdsForPersonRequest

Part Name

Element

Type

Documentation

Parameters

tns:readGroupIdsForPersonRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readGroupIdsForPersonResponse

Part Name

Element

Type

Documentation

Response

tns:readGroupIdsForPersonResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readGroupIdsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readGroupIdsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readGroupIdsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readGroupIdsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readGroupsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readGroupsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readGroupsResponse

Part Name

Element

Type

Documentation

Response

tns:readGroupsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readGroupsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readGroupsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readGroupsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readGroupsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

updateGroupRequest

Part Name

Element

Type

Documentation

Parameters

tns:updateGroupRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

updateGroupResponse

Part Name

Element

Type

Documentation

Response

tns:updateGroupResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

replaceGroupRequest

Part Name

Element

Type

Documentation

Parameters

tns:replaceGroupRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

replaceGroupResponse

Part Name

Element

Type

Documentation

Response

tns:replaceGroupResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

discoverGroupIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:discoverGroupIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

discoverGroupIdsResponse

Part Name

Element

Type

Documentation

Response

tns:discoverGroupIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

changeGroupIdentifierRequest

Part Name

Element

Type

Documentation

Parameters

tns:changeGroupIdentifierRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

changeGroupIdentifierResponse

Part Name

Element

Type

Documentation

Response

tns:changeGroupIdentifierResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

top | toc

5. XSD File Documentation

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

5.1 Service Data Model XSD Documentation

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

5.2 File Data Model XSD Documentation

Click on the Section header to access this documentation for the data models for the exchange of Group objects in an external file.

top | toc

6. Binding of the Vocabularies

The vocabularies in the GMS are:

  • 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.1.

This vocabulary is the default set maintained under the IMS Global 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 IMS Global. As part of a profiling process entirely new vocabularies may be defined to replace the default set.

Figure 6.1 The PSM representation of the extension data-type vocabulary for the GMS.

top | toc

Appendix A - Listing of the WSDLs

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

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

top | toc

Appendix B - Listing of the XSDs

The XSD files are:

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.

top | toc

Appendix C - Vocabulary VDEX Instance File Listings

The GMS vocabularies are:

  • Extension data-types vocabulary extensionvocabularyv1p0.xml. The online version of this vocabulary is available in the directory: http://www.imsglobal.org/vdex/lis/gmsv2p0;
  • Language codes languagecodesvocabularyv1p0p1.xml. The set of codes used to identifiy the language for a string (based upon RFC4646).

These vocabularies are expressed as an instance of the IMS Global Vocabulary Data Exchange (VDEX) v1.0 specification. Documentation for the vocabularies is supplied in Section 6.

top | toc

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.

Operation Name

Input (Request) SOAP Message

Output (Response) SOAP Message

createGroup

createGroupRequest

createGroupResponse

createByProxyGroup

createByProxyGroupRequest

createByProxyGroupResponse

deleteGroup

deleteGroupRequest

deleteGroupResponse

addGroupRelationship

addGroupRelationshipRequest

addGroupRelationshipResponse

removeGroupRelationship

removeGroupRelationshipRequest

removeGroupRelationshipResponse

readGroup

readGroupRequest

readGroupResponse

readAllGroupIds

readAllGroupIdsRequest

readAllGroupIdsResponse

readGroupIdsForPerson

readGroupIdsForPersonRequest

readGroupIdsForPersonResponse

readGroupIdsFromSavePoint

readGroupIdsFromSavePointRequest

readGroupIdsFromSavePointResponse

readGroups

readGroupsRequest

readGroupsResponse

readGroupsFromSavePoint

readGroupsFromSavePointRequest

readGroupsFromSavePointResponse

updateGroup

updateGroupRequest

updateGroupResponse

replaceGroup

replaceGroupRequest

replaceGroupResponse

discoverGroupIds

discoverGroupIdsRequest

discoverGroupIdsResponse

changeGroupIdentifier

changeGroupIdentifierRequest

changeGroupIdentifierResponse

top | toc

About This Document

Title

IMS Global Group Management Service WSDL/XSD Binding

Editor

Colin Smythe (IMS Global)

Co-Chairs

Linda Feng (Oracle), Bill Lee (Desire2learn)

Version

2.0.1

Version Date

30 September 2013

Status

Final Release

Summary

This document contains the description of the IMS Global Group Management Service v2.0.1 WSDL/XSD binding. This service is used to exchange information about Groups. The business transactions include the simple create, read, update and delete of the Group data model for a single instance. This document contains the definition of the corresponding Web Service based upon SOAP/HTTP messaging.

Revision Information

This version supersedes the IMS Global Group Management Service v1.0 specification.

Purpose

This document is made available for adoption by the public community at large.

Document Location

http://www.imsglobal.org/lis/

top | toc

List of Contributors

The following individuals contributed to the development of this document:

Name

Organization

Kerry Blinco

DEEWR (Australia)

Kirk Bunte

SungardHE (USA)

Angus Chan

Desire2learn (Canada)

Adam Cooper

JISC (UK)

Michael De Ridder

Desire2Learn (Canada)

Michael Feldstein

Cengage (USA)

Linda Feng

Oracle (USA)

John Fontaine

Blackboard (USA)

Chris Hatton

Pearson (USA)

Karen Kuffner

University of Michigan (USA)

Zack Leavitt

eCollege (USA)

Bill Lee

Desire2learn (Canada)

Richard Moon

SungardHE (USA)

Phil Nicholls

Psydev Ltd (UK)

Mike Parkhill

Desire2learn (Canada)

Colin Smythe

IMS Global Learning Consortium, Inc.

Reinhold Staudinger

Blackboard (USA)

top | toc

Revision History

Version No.

Release Date

Comments

GMS Final Release 2.0

30 June 2011

The first formal release of the Final Release version of this document.

GMS Final Release 2.0.1

30 September 2013

Corrections

 

 

 

top | toc

IMS Global Learning Consortium, Inc. (“IMS Global”) is publishing the information contained in this document (“Specification”) for purposes of scientific, experimental, and scholarly collaboration only.

IMS Global makes no warranty or representation regarding the accuracy or completeness of the Specification.

This material is provided on an “As Is” and “As Available” basis.

The Specification is at all times subject to change and revision without notice.

It is your sole responsibility to evaluate the usefulness, accuracy, and completeness of the Specification as it relates to you.

IMS Global would appreciate receiving your comments and suggestions.

Please contact IMS Global through our website at http://www.imsglobal.org.

Please refer to Document Name: IMS Global GMS v2.0.1 WSDL/XSD Binding Final Release

Date: 30 September 2013.