SOAP Groups API with Web Services 2.0

Overview

The Groups SOAP API allows FullAccess users to add or modify groups. Using Web Services enables you to manage user and group information on a large scale. User information and groups can be modified using two methods.

You can generate a skeleton input for each operation in the Groups WSDL, which contains the following operations:

• getGroups
• modifyGroups

For each operation, the following fields are always required in the header:

• UsernameToken

  • Username
  • Password Type
• category: Security
• schemaLocation

Groups SOAP API Details

For all SOAP APIs, the Failure Response Variables are exceptionCode and exceptionMessage.

SOAP API	Description	Required Input Variables	Success Response Variables
getGroups	Allows you to obtain group information.	category schemaLocation variable_name	status success message groups group
modifyGroups	Allows you to create a new group and add users to the group. You can also add or remove user(s) to/from an existing group(s).	category schemaLocation variable_name	status success message

---

Administration

Accessing Groups WSDL and Generating Skeleton Input

1. Click Admin to go to the Admin Home Page.

2. Click Web Services in the Integration Platform section.

   The Web Services Test page opens.

3. Confirm that the Web Service Version is 2.0.
4. Click the Groups tab.
5. Select an API from the drop-down.

6. Click Generate Input to retrieve the skeleton.

   For more information on the body of the Groups Web Service, and for code examples, see the topic SOAP Groups API with Web Services 1.0. With the exception of the header, the Web Services 1.0 code examples are valid in Web Services 2.0.

---

Header Information for Web Services 2.0

---

Related Topics

See Also