Assigning a Department Supervisor Role
AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: changeDepartmentSubordination
Permissions to Run the Request
Account Owner and Account Administrators, or a custom role that allows you to view, create, edit, and delete departments.
Department Administrator and a user with a role with individual settings can only assign a manager to departments that they manage.
- The Account Owner and Account Administrator can assign themselves as department supervisors or functional managers.
- Neither the Department Administrator nor a user with a custom role can assign themselves as a department supervisor.
Request Headers
Parameter | Type | Description | |
---|---|---|---|
token (required) | string | Access token. You can obtain a token by making a request. | |
department_id (required) | string | The ID of the department you are assigning a supervisor for. | |
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.
| |
supervisorId (optional) | string | The supervisor and functional manager ID. | Specify if subordinationType = manual. |
- | If subordinationType = inherit, no_supervisor, there is no need to specify the supervisor ID. |
Return Value
After the request has been successfully processed, the system returns an object with the following properties:
Parameter | Type | Description |
---|---|---|
success | bool | True if the manager's subordination type has changed. |
Possible Errors
Type | Description |
---|---|
Permission Denied | The user doesn't have enough permissions to get information on subordination. |
Wrong parameters | The system failed to process the request because the parameter`s value is not specified or invalid. |
Sample Request
POST /api/v2/soap/2.0 https/1.1
SOAPAction: "ChangeEnrollment"
<?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>
<ChangeEnrollmentRequest>
<credentials>
<token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
</credentials>
<enrollmentId>2bbc2ed0-8841-11e9-93c1-0242c0a85016</enrollmentId>
<accessDate>2019-09-24 10:30:00</accessDate>
<dueDateType>string</dueDateType>
<duePeriod>int</duePeriod>
<lockAfterDueDate>true</lockAfterDueDate>
</ChangeEnrollmentRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
Sample Response
<?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>
<ns1:SuccessResult>
<ns1:success>true</ns1:success>
</ns1:SuccessResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML