getDepartment: Get a specific Department

Description Usage Arguments Value References

View source: R/StaffFunctions.R

Description

This function returns fields for a Department.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
getDepartment(
  DepartmentID,
  EntityID = 1,
  returnDepartmentID = F,
  returnCode = F,
  returnCodeDescription = F,
  returnCreatedTime = F,
  returnDepartmentIDClonedFrom = F,
  returnDepartmentIDClonedTo = F,
  returnDescription = F,
  returnEntityGroupKey = F,
  returnEntityID = F,
  returnModifiedTime = F,
  returnSchoolYearID = F,
  returnStaffIDDepartmentHead = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F
)

Arguments

DepartmentID

The id of the Department.
Run getAllDepartments for a list of Departments.

EntityID

The id of the entity. Run getAllEntities for a list of entities.

returnFieldName

A TRUE or FALSE value determining whether or not to return FieldName for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.

Value

Details for the Department.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub


samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.