Method description
The method used to create a single group in itslearning. Using extensions, it can also be used to create courses.
If the group exists, the group with the SyncID will be updated instead!
Preconditions for use
None
Message Schema
Input parameters / request message elements
Name | Description | Data type | Allowed values | M/O |
---|---|---|---|---|
<sourcedId ><identifier> | The syncID of the group to be inserted. | Text | Max 64 chars | M |
<group> | The group object to be inserted. Refer to Managing groups for details | 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 |
---|---|---|
createGroupResponse | Empty createGroupResponse element | Empty |
Example
Description
I want to create a new hierarchy group in itslearning with syncID = DDDD. This group should be a sub-group of the existing group with syncID = AAAAA.
In addition I want to create a new course related to this hierarchy group. This is done by adding an <extension> section to the request, specifying the course name (mandatory) and the course code (optional).
(You can now also use the OrganisationType grouptype scheme to create courses, as well as schools and course groups - see Managing groups for a full reference)
Group hierarchy structure created in itslearning:
Course created 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: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
:createGroupRequest>
<
ims
:sourcedId>
<
ims1
:identifier>DDD</
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>AAAAA</
ims1
:identifier>
</
ims2
:sourceId>
</
ims2
:relationship>
<
ims2
:description>
<
ims2
:descShort>English</
ims2
:descShort>
<
ims2
:descLong>English Language Course for 13-18 yr olds</
ims2
:descLong>
<
ims2
:descFull>English for 13-18 yr olds</
ims2
:descFull>
</
ims2
:description>
<
ims2
:extension>
<
ims1
:extensionField>
<
ims1
:fieldName>course</
ims1
:fieldName>
<
ims1
:fieldType>String</
ims1
:fieldType>
<
ims1
:fieldValue>English course</
ims1
:fieldValue>
</
ims1
:extensionField>
<
ims1
:extensionField>
<
ims1
:fieldName>course/code</
ims1
:fieldName>
<
ims1
:fieldType>String</
ims1
:fieldType>
<
ims1
:fieldValue>ENG13/18</
ims1
:fieldValue>
</
ims1
:extensionField>
</
ims2
:extension>
</
ims
:group>
</
ims
:createGroupRequest>
</
soapenv
:Body>
</
soapenv
:Envelope>
Example response message
<
s
:Envelope
xmlns:s
=
"http://schemas.xmlsoap.org/soap/envelope/"
xmlns:u
=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
>
<
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-02T16:50:45.883Z</
u
:Created>
<
u
:Expires>2011-02-02T16:55:45.883Z</
u
:Expires>
</
u
:Timestamp>
</
o
:Security>
</
s
:Header>
<
s
:Body >
<
createGroupResponse
/>
</
s
:Body>
</
s
:Envelope>