Method: getDepartment

Permissions to Run the Request

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

Department Administrators and users with a custom role can get info about the departments they manage and their sub-departments.

Parameters

Parameter

TypeDescription
token (required)stringAccess token. You can obtain a token by making a request
departmentId (required)stringThe ID of the department to get information on

Return Value

ParameterTypeDescription
departmentarray

An array containing values like '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 IDSpecify 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>
    <GetDepartmentRequest>
      <credentials>
         <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
      </credentials>
      <departmentId>string</departmentId>
    </GetDepartmentRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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>
    <GetDepartmentResult>
      <department>
        <departmentId>string</departmentId>
        <name>string</name>
        <code>string</code>
        <parentDepartmentId>string</parentDepartmentId>
      </department>
    </GetDepartmentResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>