readGroupsForPerson

Method description

A method to read all groups related to a person

Preconditions for use

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

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
personSourcedId/identifier	The *syndID* of the person	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
readGroupsForPersonResponse	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 all hierarchy group related to person with syncID = 99998888 who is a member of the following hierarchy structure in itslearning:

Example request message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/gms/xsd/imsGroupManMessSchema_v1p0" xmlns:ims2="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0" xmlns:ims3="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0">
 <soapenv:Header>
      <ims3:syncRequestHeaderInfo>
         <ims3:messageIdentifier>1234567890</ims3:messageIdentifier>
      </ims3:syncRequestHeaderInfo>
   </soapenv:Header>
   <soapenv:Body>
      <ims:readGroupsForPersonRequest>
         <ims:personSourcedId>
            <ims2:identifier>99998888</ims2:identifier>
         </ims:personSourcedId>
      </ims:readGroupsForPersonRequest>
   </soapenv:Body>
</soapenv:Envelope>

Example response message

<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>
         </statusInfoSet>
      </h:syncResponseHeaderInfo>
      <o:Security s:mustUnderstand="1" >
         <u:Timestamp u:Id="_0">
            <u:Created>2011-02-03T12:31:37.492Z</u:Created>
            <u:Expires>2011-02-03T12:36:37.492Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body>
      <readGroupsForPersonResponse >
         <groupSet>
            <group>
               <sourcedId>
                  <identifier>root</identifier>
               </sourcedId>
               <group>
                 <groupType >
                     <scheme>ItslearningOrganisationTypes</scheme>
                     <typeValue>
                        <type>Unspecified</type>
                        <level>-1</level>
                     </typeValue>
                  </groupType>
                  <relationship >
                     <relation>Parent</relation>
                     <sourceId>
                        <identifier>root</identifier>
                     </sourceId>
                     <label>Is parent of</label>
                  </relationship>
                  <description >
                     <descShort>TestImport</descShort>
                  </description>
                  <extension>
                     <extensionField >
                        <fieldName>visibleinsearch</fieldName>
                        <fieldType>Boolean</fieldType>
                        <fieldValue>True</fieldValue>
                     </extensionField>
                  </extension>
               </group>
            </group>
            <group>
               <sourcedId>
                  <identifier>HHH</identifier>
               </sourcedId>
               <group>
                 <groupType >
                     <scheme>ItslearningOrganisationTypes</scheme>
                     <typeValue>
                        <type>Unspecified</type>
                        <level>-1</level>
                     </typeValue>
                  </groupType>
                  <relationship >
                     <relation>Parent</relation>
                     <sourceId>
                        <identifier>root</identifier>
                     </sourceId>
                     <label>Is parent of</label>
                  </relationship>
                  <description >
                     <descShort>School AB</descShort>
                  </description>
                     <extensionField >
                        <fieldName>visibleinsearch</fieldName>
                        <fieldType>Boolean</fieldType>
                        <fieldValue>True</fieldValue>
                     </extensionField>
                  </extension>
               </group>
            </group>
            <group>
               <sourcedId>
                  <identifier >III</identifier>
               </sourcedId>
               <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>Course group</descShort>
                  </description>
                  <extension >
                     <extensionField >
                        <fieldName>visibleinsearch</fieldName>
                        <fieldType>Boolean</fieldType>
                        <fieldValue>True</fieldValue>
                     </extensionField>
                  </extension>
               </group>
            </group>
         </groupSet>
      </readGroupsForPersonResponse>
   </s:Body>
</s:Envelope>