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'.
departmentId	string	The department ID.
name	string	The department name.
code	string	The department code.
parentDepartmentId	string	The parent department ID.
subordination (optional)	array	An array with data on the type of department supervisor subordination.
coSubordination (optional)	array	An array with data on the type of functional manager subordination.
subordinationType (required)	string	The type of supervisor and functional manager subordination. inherit — Inherit from parent department. manual — Assign manually. no_supervisor — No supervisor.
supervisorId (optional)	string	The supervisor and functional manager ID.	Specify the supervisor ID, if subordinationType = manual.
supervisorId (optional)	string	-	If subordinationType = inherit, no_supervisor, there is no need to specify the supervisor ID.

Sample Call

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

XML

Sample Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://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>

XML