Getting a List of Departments

Method: getDepartments

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles.

Department Administrators, Publishers, and users with a custom role can get lists of departments they manage and their sub-departments.

Parameters

Parameter	Type	Description
credentials (required)	credentials	Read the description of the Credentials object.

Return Value

After the request has been completed, the system returns an object with the following properties:

Parameter	Type	Description
department	array	An array containing the following values: 'departmentId', 'name', 'code', 'parentDepartmentId'.

Sample Call

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetDepartmentsRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
    </GetDepartmentsRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetDepartmentsResult>
      <department>
        <departmentId>string</departmentId>
        <name>string</name>
        <code>string</code>
        <parentDepartmentId>string</parentDepartmentId>
      </department>
      <department>
        ...
      </department>
    </GetDepartmentsResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page tree