createGroups

Method description

The method used to create one or several groups in itslearning.

NB! If the group(s) to be inserted already exist in itslearning, the group(s) will be updated instead.

Preconditions for use

You will need to know the syncID of the parent hierarchy group(s) where you want to add the new group(s) in itslearning

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
groupIdPair	A wrapper element for each ID/group pair, repeat for each group to create		Pair of sourcedId/identifier and group elements	M
sourcedId/Identifier	The syncId of the group to create	Text	Max 255 chars	M
group	The group data to be inserted. Refer to Managing groups for full details on the element structure	Object	Valid group object	M

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

Response message elements

Name	Description	Data type
createGroupsResponse	Empty response element, status conveyed in SOAP header	Empty

Example

Description

I want to create a new hierarchy group in itslearning with syncID = HHH. This group should be a sub-group of the existing hierarchy group with syncID = root.

I also want to create a new hierarchy group in itslearning with syncID = III. This group should be a sub-group of the group with syncID = HHH

In addition I want to create a new course related to this hierarchy group with syncID = HHH. This is done by adding an <extension> section to the request, specifying the course name (mandatory) and the course code (optional). This course will get the same syncID as the related hierarchy group; syndID = HHH.

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:ims1="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0" xmlns:ims2="http://www.imsglobal.org/services/gms/xsd/imsGroupManDataSchema_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:createGroupsRequest>
    <ims:groupIdPairSet>
      <ims:groupIdPair>
        <ims:sourcedId>
          <ims1:identifier>HHH</ims1:identifier>
        </ims:sourcedId>
        <ims:group>
            <ims2:groupType>
               <ims2:scheme>ItslearningOrganisationTypes</ims2:scheme>
               <ims2:typeValue>
                   <ims2:type>Unspecified</ims2:type>
                  <ims2:level>-1</ims2:level>
               </ims2:typeValue>
            </ims2:groupType>
          <ims2:relationship>
            <ims2:relation>Parent</ims2:relation>
            <ims2:sourceId>
              <ims1:identifier>root</ims1:identifier>
            </ims2:sourceId>
          </ims2:relationship>
          <ims2:description>
            <ims2:descShort>School AB</ims2:descShort>
          </ims2:description>
        </ims:group>
      </ims:groupIdPair>
     <ims:groupIdPair>
        <ims:sourcedId>
          <ims1:identifier>III</ims1:identifier>
        </ims:sourcedId>
        <ims:group>
            <ims2:groupType>
               <ims2:scheme>ItslearningOrganisationTypes</ims2:scheme>
               <ims2:typeValue>
                   <ims2:type>Unspecified</ims2:type>
                  <ims2:level>-1</ims2:level>
               </ims2:typeValue>
            </ims2:groupType>
          <ims2:relationship>
            <ims2:relation>Parent</ims2:relation>
            <ims2:sourceId>
              <ims1:identifier>HHH</ims1:identifier>
            </ims2:sourceId>
          </ims2:relationship>
          <ims2:description>
            <ims2:descShort>Course group</ims2:descShort>
           </ims2:description>
          <ims2:extension>
            <ims1:extensionField>
              <ims1:fieldName>course</ims1:fieldName>
              <ims1:fieldType>String</ims1:fieldType>
              <ims1:fieldValue>History</ims1:fieldValue>
            </ims1:extensionField>
            <ims1:extensionField>
              <ims1:fieldName>course/code</ims1:fieldName>
              <ims1:fieldType>String</ims1:fieldType>
              <ims1:fieldValue>HIS-01</ims1:fieldValue>
            </ims1:extensionField>
          </ims2:extension>
        </ims:group>
      </ims:groupIdPair>
    </ims:groupIdPairSet>
  </ims:createGroupsRequest>
 </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>
            <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-03T09:52:38.629Z</u:Created>
            <u:Expires>2011-02-03T09:57:38.629Z</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">
      <createGroupsResponse/>
   </s:Body>
</s:Envelope>