readGroup

Method description

A method to read a single group.

Preconditions for use

You will need to know the syncID of the group you want to read.

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
sourcedId/identifier	The syncID of the group 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
readGroupResponse	Wrapper element for <group> object
group	The group object requested. Refer to page on GroupManagement for description of content

Example

Description

I want to read group with syncID = AAA from itslearning.

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:readGroupRequest>
         <ims1:sourcedId>
            <ims2:identifier>AAA</ims2:identifier>
         </ims1:sourcedId>
      </ims1:readGroupRequest>
   </soapenv:Body>
</soapenv:Envelope>

Example response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/>
   <s:Header>
      <h:syncResponseHeaderInfo >
         <messageIdentifier>1234567890</messageIdentifier>
         <statusInfo>
            <codeMajor>success</codeMajor>
            <severity>status</severity>
            <messageIdRef>1234567890</messageIdRef>
         </statusInfo>
      </h:syncResponseHeaderInfo>
      <o:Security s:mustUnderstand="1">
         <u:Timestamp u:Id="_0">
            <u:Created>2011-02-03T11:10:47.816Z</u:Created>
            <u:Expires>2011-02-03T11:15:47.816Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body >
      <readGroupResponse >
         <group>
            <groupType >
               <scheme>ItslearningOrganisationTypes</scheme>
               <typeValue>
                  <type>Unspecified</type>
                  <level>-1</level>
               </typeValue>
            </groupType>
            <relationship>              
                  <relation>Parent</relation>
               <sourceId>
                  <identifier >AAA</identifier>
               </sourceId>
               <label>Is parent of</label>
            </relationship>
            <description >
               <descShort>English</descShort>
               <descFull>English for 13-18 yr olds</descFull>
            </description>
            <extension >
               <extensionField >
                  <fieldName>visibleinsearch</fieldName>
                  <fieldType>Boolean</fieldType>
                  <fieldValue>True</fieldValue>
               </extensionField>
               <extensionField >
                  <fieldName>course</fieldName>
                  <fieldType>String</fieldType>
                  <fieldValue>English course</fieldValue>
               </extensionField>
               <extensionField >
                  <fieldName>course/code</fieldName>
                  <fieldType>String</fieldType>
                  <fieldValue>ENG13/18</fieldValue>
               </extensionField>
               <extensionField >
                  <fieldName>course/credits</fieldName>
                  <fieldType>String</fieldType>
                  <fieldValue/>
               </extensionField>
            </extension>
         </group>
      </readGroupResponse>
   </s:Body>
</s:Envelope>