Field Types

Datetime

Datetime fields represent a specific date and time. Datetime fields are full timestamps with a precision of one second. Datetimes are always transferred in the GMT/UTC time zone.

Syntax

yyyy-MM-ddTHH:mm:ss

  • yyyy - four-digit year
  • MM - two-digit month
  • dd - two-digit day
  • HH - two-digit hour (24-hour format)
  • mm - two-digit minute
  • ss - two-digit second

Include leading zeros where necessary to comply with the correct number of digits. All sections are required.

Date

Date fields represent a specific date.

Syntax

yyyy-MM-dd

  • yyyy - four-digit year
  • MM - two digit month
  • dd - two digit day
Include leading zeros where necessary to comply with the correct number of digits. All sections are required.

Timezone

Timezone fields represent a specific time zone using a time zone code. See Supported Time Zones for a list of Firmwater LMS supported time zones and associated codes.

String

String fields contain text and may have length restrictions. Ordinarily, Firmwater LMS will truncate strings that exceed the length restriction; however, if an object instance identifying field exceeds the restriction, an error is returned to the client application (refer to Identifying Fields under Firmwater LMS Objects).

Boolean

Boolean fields are true/false flags and have either of two values:

  • true (or 1)
  • false (or 0)

SelectList

A SelectList is a strongly-typed collection that allows adding and/or removing items. A SelectListOfString, for example, can be used to conveniently add and/or remove user names from a registration.

SelectLists are similar to arrays except each item in the list must contain an operation attribute. The following list describes the three possible values for the operation attribute:

OperationDescription
noneThe item will be neither added nor removed from the list. When querying Firmwater LMS through the Search interface, SelectList fields will typically contain a list of items all having an operation attribute of none.
addThe item is to be added to the list.
removeThe item is to be removed from the list.