Group Management Service overview

Cirrus Assessment Support Team -

Managing groups

The Group Management Service contains the basic operations defined by the IMS consortium.

Important:

A group corresponds to a hierarchy level in Cirrus.

Please note that hierarchies created manually via the UI often do not get a sync key. Contact us if you need help with that.

Data mapping Group record mapping
Data mapping Cirrus Group Record Extensions
Data mapping Group relationship mapping
Methods for group management Methods for group management
 Service URL https://svc.cirrusplatform.com/IMSLIS/GroupManagementService.svc
WSDL URL  https://svc.cirrusplatform.com/IMSLIS/GroupManagementService.svc?wsdl

IMS LIS online documentation.

 

Function descriptions, original WSDL files, request/response examples:

https://www.imsglobal.org/lis/
https://www.imsglobal.org/lis/lisv2p0p1/GMSInfoModelv2p0p1.html

Methods for group management

Cirrus platform supports the following operations:

Data mapping

Group record mapping

IMS LIS Field Mandatory Cirrus Comment
sourcedId X syncId Maps to Syncronization key in the UI. Unique. Needs to be GUID.
groupType/scheme  X N/A  Only "Group" value is allowed 
org/orgName  X Title Maps to 'Title' in the Cirrus edit hierarchy User Interface.
relationships    N/A See group relationship mapping in the next section 
extensions      see Cirrus Group Record Extensions

 

Cirrus IMS LIS Extensions on Group Record Mapping

Cirrus has defined several extensions to the standard IMS group object. Using this extension you can set the following: 

Extension Field name Extension Field value Cirrus
fieldName  AllowRelationshipWithSchedules  
fieldType  Boolean  
fieldValue  true/false  
Example  <ims1:fieldName>AllowRelationshipWithSchedules</ims1:fieldName>
<ims1:fieldType>Boolean</ims1:fieldType>
<ims1:fieldValue>false</ims1:fieldValue>
</ims1:extensionField>
Maps to 'Allow relationship with scheduled assessments' in the Cirrus edit hierarchy UI.
     
fieldName IsOrganisation  Rootlevel: yes/no
fieldType Boolean  
fieldValue true/false  
 Example  

<ims1:extensionField>
<ims1:fieldName>IsOrganisation</ims1:fieldName>
<ims1:fieldType>Boolean</ims1:fieldType>
<ims1:fieldValue>true</ims1:fieldValue>
</ims1:extensionField>

 

 

Maps to 'Define this level as a new Rootlevel' in the Cirrus edit hierarchy User Interface.

     
fieldName OrganisationAdress  not used
fieldType String  
fieldValue    
 Example

<ims:extension>
<ims1:extensionField>
<ims1:fieldName>OrganisationAdress</ims1:fieldName><ims1:fieldType>String</ims1:fieldType><ims1:fieldValue>London</ims1:fieldValue>
</ims1:extensionField>
<ims1:extensionField>

Currently not used in the Cirrus edit hierarchy User Interface.

 
     
fieldName OrganisationId  
fieldType String  
fieldValue    
Example   <ims1:fieldName>OrganisationId</ims1:fieldName>
<ims1:fieldType>String</ims1:fieldType>
<ims1:fieldValue>BerlinXVI</ims1:fieldValue>
</ims1:extensionField>
<ims1:extensionField>
 Maps to 'Organisation ID' in the Cirrus edit hierarchy User Interface.
     

 

Group record example

<ims:groupRecord>
   <ims:sourcedGUID>
      <ims1:refAgentInstanceID>YourSystemName</ims1:refAgentInstanceID>
      <ims1:sourcedId>2c942c76414e43cc962f90de28116dc4</ims1:sourcedId>
   </ims:sourcedGUID>
   <ims:group>
      <ims:groupType>
         <ims:typevalue>
            <ims:type>
               <ims1:textString>Group</ims1:textString>
            </ims:type>
         </ims:typevalue>
      </ims:groupType>
      <ims:org>
         <ims:orgName>
            <ims1:textString>Course A Group C</ims1:textString>
         </ims:orgName>
      </ims:org>     
      <ims:extension>
        <ims1:extensionField>         
         <ims1:fieldName>AllowRelationshipWithSchedules</ims1:fieldName> 
         <ims1:fieldType>Boolean</ims1:fieldType>    
         <ims1:fieldValue>false</ims1:fieldValue>
         </ims1:extensionField> 
        <ims1:extensionField>         
         <ims1:fieldName>IsOrganisation</ims1:fieldName> 
         <ims1:fieldType>Boolean</ims1:fieldType>    
         <ims1:fieldValue>false</ims1:fieldValue>
         </ims1:extensionField> 
         <ims1:extensionField>
            <ims1:fieldName>OrganisationAdress</ims1:fieldName>
            <ims1:fieldType>String</ims1:fieldType>
            <ims1:fieldValue>Berlin</ims1:fieldValue>
          </ims1:extensionField>
         <ims1:extensionField>
            <ims1:fieldName>OrganisationId</ims1:fieldName>
            <ims1:fieldType>String</ims1:fieldType>
            <ims1:fieldValue>Berlin</ims1:fieldValue>
          </ims1:extensionField>
       <ims:extension>
   </ims:group>
</ims:groupRecord>

 

Group relationship mapping

Important note: Cirrus doesn't implement a separate relationship object for groups. That's why there is no direct data mapping.

 

IMS LIS Field Mandatory Cirrus Comment
relationId X N/A Syncronization key. Unique. Type: GUID.
relationType  X N/A  Only "Parent" value is allowed.
sourcedId  X N/A SourcedId of parent group, i.e. syncId in Cirrus. (a unique synchronisation key. Type: GUID)
label   N/A Label will be generated automatically 

Example of Group relationship mapping

<ims:relationship>
   <ims:relationId>a4e90c872a9c4127a794ecf96d67561e</ims:relationId>
   <ims:relation>Parent</ims:relation>
   <ims:sourcedId>0852e382ec3b405cbed5086d0d048655</ims:sourcedId>
</ims:relationship>

Comments 0

Cirrus uses Zendesk to provide our Help Center services. Check out Zendesk's Terms of Service and Privacy Policy, as they govern your use of these services.

Powered by Zendesk