Page tree
Skip to end of metadata
Go to start of metadata

To get a list of departments, use the getDepartments method.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators. Publishers.

Department Administrators and Publishers can get information only on the department they manage and its daughter departments.

Parameters

Parameter

Type

Description

credentials (required)credentialsRead 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

departmentarrayAn 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>
  • No labels