updateGroups

Method description

A method to update one or more properties of one or more groups. Can also be used to create groups.

Preconditions for use

You will need to know the syncID of the parent hierarchy where you want to update/add the group in itslearning.

Message Schema

Input parameters / request message elements

Name

Description

Data type

Allowed values

M/O

groupIdPairSet

Wrapper for a list of groupIDPair elements

groupIdPair

Wrapper for a set of one <sourcedid><identifier and one <group> element

<sourcedId ><identifier>

The syncID of the group to be updated.

Text

Max 64 chars

M

<group>

The full or partial group object to be updated. Refer to GroupManagement service and the group object for details

Object

Valid (partial) 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

updateGroupsResponse

Empty createGroupResponse element

Empty

For each <identifier> in the request you will get a status in the <statusinfoSet><status> in the response. The order of the <statusInfoset><status> corresponds to the the order of the <identifier> in the request.

Comments

If the syncID to update does not exist, itslearning will try to create it. Depending on the data provided, there may or may not be enough data to successfully create the group.

Example

Example request message

You need to add a <relationship> element to the request with correct syncID of the parent hierarchy, even though this does not change.

Identical to createGroups request, just different method name and with the possibility to include only the elements to update.

Example response message

Identical to createGroups response, just different method name