readGroups

Cirrus Assessment Support Team -

Method description

readGroups is the method used to read information of several groups from Cirrus.

Message schema

Request parameters

Name

Data type

Description

sourcedIdSet

Array<GUID>

The syncIDs of the groups to be read

Response parameters

Name

Data type

Description

groupRecordSet

Array<Object>

The array of group records. See group record mapping here

Example

Request message

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ims="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0" xmlns:ims1="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
   <soap:Header>
      <ims:imsx_syncRequestHeaderInfo>
         <ims1:imsx_version>V1.0</ims1:imsx_version>
         <ims1:imsx_messageIdentifier>0123456789</ims1:imsx_messageIdentifier>
      </ims:imsx_syncRequestHeaderInfo>
   </soap:Header>
   <soap:Body>
      <ims:readGroupsRequest>
         <ims:sourcedIdSet>
            <ims:sourcedId>9c34d19065f74ca78e9b3cbce0343496</ims:sourcedId>
            <ims:sourcedId>0852e382ec3b405cbed5086d0d048655</ims:sourcedId>
         </ims:sourcedIdSet>
      </ims:readGroupsRequest>
   </soap:Body>
</soap:Envelope>

Response message

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <a:Action s:mustUnderstand="1">http://www.imsglobal.org/soap/lis/gms2p0/readGroupsResponse</a:Action>
      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0" xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
         <imsx_version xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">V1.0</imsx_version>
         <imsx_statusInfo xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
            <imsx_codeMajor>success</imsx_codeMajor>
            <imsx_severity>status</imsx_severity>
            <imsx_codeMinor>
               <imsx_codeMinorField>
                  <imsx_codeMinorFieldName>TargetEndSystem</imsx_codeMinorFieldName>
                  <imsx_codeMinorFieldValue>fullsuccess</imsx_codeMinorFieldValue>
               </imsx_codeMinorField>
            </imsx_codeMinor>
         </imsx_statusInfo>
      </h:imsx_syncResponseHeaderInfo>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2015-07-23T07:26:56.692Z</u:Created>
            <u:Expires>2015-07-23T07:31:56.692Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <readGroupsResponse xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0">
         <groupRecordSet>
            <groupRecord>
               <sourcedGUID>
                  <refAgentInstanceID xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Cirrus</refAgentInstanceID>
                  <sourcedId xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">9c34d19065f74ca78e9b3cbce0343496</sourcedId>
               </sourcedGUID>
               <group>
                  <groupType>
                     <typevalue>
                        <type>
                           <language xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">en-US</language>
                           <textString xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Group</textString>
                        </type>
                     </typevalue>
                  </groupType>
                  <relationship>
                     <relationId>27a062726b264f5d962ec0c946ad6f27</relationId>
                     <relation>Child</relation>
                     <sourcedId>8df15ffaf5354721b410a275eef9437f</sourcedId>
                     <label>
                        <language xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">en-US</language>
                        <textString xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Group (id: 9c34d19065f74ca78e9b3cbce0343496) is a child of group (id: 8df15ffaf5354721b410a275eef9437f)</textString>
                     </label>
                  </relationship>
                  <org>
                     <orgName>
                        <language xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">en-US</language>
                        <textString xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Course A Group C</textString>
                     </orgName>
                  </org>
                  <extension>
                     <extensionField xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
                        <fieldName>OrganisationAdress</fieldName>
                        <fieldType>String</fieldType>
                        <fieldValue>Berlin</fieldValue>
                     </extensionField>
                  </extension>
               </group>
            </groupRecord>
            <groupRecord>
               <sourcedGUID>
                  <refAgentInstanceID xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Cirrus</refAgentInstanceID>
                  <sourcedId xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">0852e382ec3b405cbed5086d0d048655</sourcedId>
               </sourcedGUID>
               <group>
                  <groupType>
                     <typevalue>
                        <type>
                           <language xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">en-US</language>
                           <textString xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Group</textString>
                        </type>
                     </typevalue>
                  </groupType>
                  <relationship>
                     <relationId>02f61589185045bbbe466cc9c05af3a3</relationId>
                     <relation>Child</relation>
                     <sourcedId>8df15ffaf5354721b410a275eef9437f</sourcedId>
                     <label>
                        <language xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">en-US</language>
                        <textString xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Group (id: 0852e382ec3b405cbed5086d0d048655) is a child of group (id: 8df15ffaf5354721b410a275eef9437f)</textString>
                     </label>
                  </relationship>
                  <org>
                     <orgName>
                        <language xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">en-US</language>
                        <textString xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Test Group</textString>
                     </orgName>
                  </org>
                  <extension/>
               </group>
            </groupRecord>
         </groupRecordSet>
      </readGroupsResponse>
   </s:Body>
</s:Envelope>

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