Usage

LmsDepartmentObject represents a department within an organization. The object is used with the CreateOrUpdate method to create and update departments. It is returned by the Search method when retrieving information about existing departments in the organization.

Permissions

A logged in client application attempting to create or modify a department must meet the following minimum requirements:

• Able to access the licensee specified in the LicenseeId field
• Administrative privilege of Licensee Administrator or greater

The licensee that is to own the department must have departments enabled (see LmsLicenseeObject field UseDepartment).

Identifying Fields

One of the following groups of fields must be specified to uniquely identify a department:

• Id, or
• DepartmentName AND LicenseeId

A description of these fields follow.

Id

A 36-character globally unique identifier to uniquely identify a department. This field is read-only but can be used when searching for or updating an LmsDepartmentObject.

DepartmentName

A string representing the department name in the licensee's default language. Department names are unique for a language within a licensee. Department names are restricted to a maximum length of 100 characters.

LicenseeId

A string representing the ID of the licensee that the department is a part of. An authenticated client application attempting to create/modify a department must have access to the licensee specified by LicenseeId.

Other Fields

ExternalDepartmentId

A string representing an external identifier for the department. External identifiers are client implementation specific. Firmwater LMS makes no assumptions on the significance of this string. External department identifiers are restricted to a maximum length of 100 characters.

ExpiryDatetime

A Datetime field representing the department's expiry date and time. A department is considered expired when the expiry date and time is earlier than the current Firmwater LMS date and time. To clear the expiry date and time of a department, simply set the value of the ExpiryDatetime field to empty string ("").