SOAP Groups API with Web Services 1.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 2 operations:
For each operation, there are 3 fields that are always required in the header:
- sessionID
- category:Groups
- schemaLocation
Groups SOAP API Details
| getGroups |
Allows you to obtain group information. |
sessionID
category
schemaLocation
variable_name
|
status:
success
message
groups
|
exceptionCode
exceptionMessage
|
| 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). |
sessionID
category
schemaLocation
variable_name
|
status:
success
message
|
exceptionCode
exceptionMessage
|
Administration
Accessing Users WSDL and Generating Skeleton Input
- Navigate from Admin Home Page > Integration Platform > Web Services.
- Click the Groups tab.
- Select an API from the drop-down menu.
- Click Generate Input to retrieve the skeleton.
Sample Groups APIs
getGroups - Input SOAP XML
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<bm:userInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:sessionId>A99EA9EA9FFC03C02AF30373A60CFD60</bm:sessionId>
</bm:userInfo>
<bm:category xmlns:bm="urn:soap.bigmachines.com">Groups</bm:category>
<bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/groups/Groups.xsd</bm:schemaLocation>
</bm:xsdInfo>
</soapenv:Header>
<soapenv:Body>
<bm:getGroups xmlns:bm="urn:soap.bigmachines.com">
<bm:groups>
<bm:group>
<bm:company_name>Pm</bm:company_name>
<bm:variable_name/>
</bm:group>
</bm:groups>
</bm:getGroups>
</soapenv:Body>
</soapenv:Envelope>
Highlighted tags are required.
modifyGroups - Input SOAP XML
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<bm:userInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:sessionId>A99EA9EA9FFC03C02AF30373A60CFD60</bm:sessionId>
</bm:userInfo>
<bm:category xmlns:bm="urn:soap.bigmachines.com">Groups</bm:category>
<bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/groups/Groups.xsd</bm:schemaLocation>
</bm:xsdInfo>
</soapenv:Header>
<soapenv:Body>
<bm:modifyGroups xmlns:bm="urn:soap.bigmachines.com">
<bm:groups>
<bm:group>
<bm:company_name>Pm</bm:company_name>
<bm:variable_name/>
<bm:name/>
<bm:users>
<bm:user>
<bm:action>add</bm:action>
<bm:login>user1</bm:login>
</bm:user>
<bm:user>
<bm:action>remove</bm:action>
<bm:login>user2</bm:login>
</bm:user>
</bm:users>
</bm:group>
</bm:groups>
</bm:modifyGroups>
</soapenv:Body>
</soapenv:Envelope>
Highlighted tags are required.
Notes
SOAP requests must include "Agent" information.
Related Topics
See Also
