AVAILABLE WITH BUSINESS SUBSCRIPTION

Method: getDepartments

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, Publishersor 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

token (required)stringAccess token. You can obtain a token by making a request.

Return Value

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

Parameter

Type

Description

departmentarrayAn array containing the following values: 'departmentId', 'name', 'code', 'parentDepartmentId'. 
departmentIdstringThe department ID.
namestringThe department name.
codestringThe department code.
parentDepartmentIdstringThe parent department ID.
subordination (optional)arrayAn array with data on the type of department supervisor subordination.
coSubordination (optional)arrayAn 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)stringThe supervisor and functional manager ID.Specify the supervisor ID, if subordinationType = manual.
-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>
        <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
      </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