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

You can get information about a department with the getDepartment method.

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

Parameters

Parameter

TypeDescription
credentials (required)credentialsRead the description of the Credentials object.
departmentId (required)stringThe ID of the department to get information on.

Return Value

ParameterTypeDescription
departmentarray

An array containing values like '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>
    <GetDepartmentRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
      <departmentId>string</departmentId>
    </GetDepartmentRequest>
  </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>
    <GetDepartmentResult>
      <department>
        <departmentId>string</departmentId>
        <name>string</name>
        <code>string</code>
        <parentDepartmentId>string</parentDepartmentId>
      </department>
    </GetDepartmentResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels