readGroups

Method description

A method to read a collection of groups

Preconditions for use

You will need to know the syncIDs of the groups you want to read.

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
sourcedIdSet	Wrapper element for list of identifier
sourcedIdSet/identifier	The syncIDs of the groups to read	Text	Valid syncID	M

Please refer to the WSDL for the full element structure, only key elements are described here

Response message elements

Name	Description	Data type
readGroupsResponse	Wrapper element for <groupSet> object
groupSet	Wrapper element for <group>
group	The group objects requested. Refer to page on GroupManagement for description of content

Example

Description

I want to read hierarchy group data from itslearning with

syncID HHH
syncID III (this group also has relationship to a course named ‘History’

Example request message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0" xmlns:ims1="http://www.imsglobal.org/services/gms/xsd/imsGroupManMessSchema_v1p0" xmlns:ims2="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">
   <soapenv:Header>
      <ims:syncRequestHeaderInfo>
         <ims:messageIdentifier>1234567890</ims:messageIdentifier>
      </ims:syncRequestHeaderInfo>
   </soapenv:Header>
   <soapenv:Body>
      <ims1:readGroupsRequest>
         <ims1:sourcedIdSet>
            <ims2:identifier>HHH</ims2:identifier>
            <ims2:identifier>III</ims2:identifier>
         </ims1:sourcedIdSet>
      </ims1:readGroupsRequest>
   </soapenv:Body>
</soapenv:Envelope>

Example response message

For each <sourcedIdSet><identifier> in the request you will get a status in the <statusinfoSet><status> in the response. The order of the <statusInfoset><status> corresponds to the the order of the <sourcedIdset><idendifier> in the request. Only group data of hierarchy groups with status ‘success’ will be present in the <readGroupResponse> section.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope>
   <s:Header>
      <h:syncResponseHeaderInfo >
         <messageIdentifier>1234567890</messageIdentifier>
         <statusInfoSet>
            <statusInfo>
               <codeMajor>success</codeMajor>
               <severity>status</severity>
               <messageIdRef>1234567890</messageIdRef>
            </statusInfo>
            <statusInfo>
               <codeMajor>success</codeMajor>
               <severity>status</severity>
               <messageIdRef>1234567890</messageIdRef>
            </statusInfo>
         </statusInfoSet>
      </h:syncResponseHeaderInfo>
      <o:Security s:mustUnderstand="1" >
         <u:Timestamp u:Id="_0">
            <u:Created>2011-02-03T11:28:34.584Z</u:Created>
            <u:Expires>2011-02-03T11:33:34.584Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body >
      <readGroupsResponse >
         <groupSet>
            <group>
               <groupType >
                  <scheme>ItslearningOrganisationTypes</scheme>
                  <typeValue>
                     <type>Unspecified</type>
                     <level>-1</level>
                  </typeValue>
               </groupType>
               <relationship >
                  <relation>Parent</relation>
                  <sourceId>
                     <identifier >HHH</identifier>
                  </sourceId>
                  <label>Is parent of</label>
               </relationship>
               <description >
                  <descShort>School AB</descShort>
               </description>
               <extension >
                  <extensionField >
                     <fieldName>visibleinsearch</fieldName>
                     <fieldType>Boolean</fieldType>
                     <fieldValue>True</fieldValue>
                  </extensionField>
               </extension>
            </group>
            <group>
               <groupType >
                  <scheme>ItslearningOrganisationTypes</scheme>
                  <typeValue>
                     <type>Unspecified</type>
                     <level>-1</level>
                  </typeValue>
               </groupType>
               <relationship >
                  <relation>Parent</relation>
                  <sourceId>
                     <identifier >III</identifier>
                  </sourceId>
                  <label>Is parent of</label>
               </relationship>
               <description >
                  <descShort>Course group</descShort>
               </description>
               <extension >
                  <extensionField >
                     <fieldName>visibleinsearch</fieldName>
                     <fieldType>Boolean</fieldType>
                     <fieldValue>True</fieldValue>
                  </extensionField>
                  <extensionField >
                     <fieldName>course</fieldName>
                     <fieldType>String</fieldType>
                     <fieldValue>History</fieldValue>
                  </extensionField>
                  <extensionField >
                     <fieldName>course/code</fieldName>
                     <fieldType>String</fieldType>
                     <fieldValue>HIS-01</fieldValue>
                  </extensionField>
                  <extensionField >
                     <fieldName>course/credits</fieldName>
                     <fieldType>String</fieldType>
                     <fieldValue/>
                  </extensionField>
               </extension>
            </group>
         </groupSet>
      </readGroupsResponse>
   </s:Body>
</s:Envelope>