Business Time command parameters

Following are the parameters for the Business Time commands. Each parameter must be set apart in double quotation marks.

• <businessTimeSegmentName> — Indicates which entry in the Business Time Segment form contains a definition for the activity to use for this calculation. You can specify multiple business activity names. Omitting this value specifies that no business activity is used for this calculation.
• <duration> — Specifies the size of the time segment in seconds. Specify 0 to return the next time segment.
• <earliestStartTime> — Working in conjunction with the <latestStartTime>, specifies the time range within which the free window should exist. The specified duration (<duration> parameter) must be less than this range. For example, if the earliest time is 4:00 P.M. and the latest end time is 10:00 P.M., a window is returned that is <duration> seconds long and starts after 4:00 P.M., even if a window exists before 4:00 P.M. If the duration is greater than the specified time range, no value is returned. If the <earliestStartTime> is not specified, the default of 0 hours (the beginning of the day) is used.
• <endTime> — Ending time of the interval of which to calculate the difference.
• <endTimeRange> — A date and time value that defines the end of a search for a time window.
• <entity> — Can be an asset, individual, group, company, location, or anything you want to link a schedule to.
• <holidayScheduleName> — For old Business Time commands, indicates which entry in the Business Time Holidays form contains a definition for the holiday schedule to use for this calculation. Omitting this value specifies no holidays.
• <latestEndTime> — Working in conjunction with the <earliestStartTime>, specifies the time range within which the free window should exist. The specified duration (<duration> parameter) must be less than this range. For example, if the earliest time is 4:00 P.M. and the latest end time is 10:00 P.M., a window is returned that is <duration> seconds long and starts after 4:00 P.M., even if a window exists before 4:00 P.M. If the duration is greater than the specified time range, no value is returned. If the <latestEndTime> is not specified, the default of 24 hours (midnight) is used.
• <level> — Indicates the level of the time segment to be scheduled. The value can be an integer from 1 through 1000.
• <amount> — Specifies an amount of time to offset the start time by. The amount> can be an integer value of 0 or greater. If not specified, <amount> defaults to 1. You can use 0 to indicate the next available time. For example, if your open hours are 8:00 A.M. to 5:00 P.M. and the Start Time in Application-Bus-Time2-Add, Application-Bus-Time2-Assoc-Add, and Application-Bus-Time-Add commands is 7:00 A.M., the return value is 8:00 A.M.
   In previous versions, <amount> was known as <offset>.
• <amountUnits> — The unit of time, which can be set to 1 for seconds, 2 for minutes, 3 for hours, or 4 for days. Any other setting reverts to hours (3).
• <startTime> — Starting time to which to add business time.
• <startTimeRange> — A date and time value that defines the start of a search for a time window.
• <windowFlag> — A bitmask value with:
  • Bit 0 — Indicates the beginning of an available or unavailable time segment. The values are 1 (available) and 0 (unavailable).
  • Bit 1 — Indicates whether to retrieve just one segment or all the segments between the start and end times. The values are 1 (retrieve all segments) and 0 (retrieve one segment). The value returned in this case is a semicolon-separated list of values.
• <workdayScheduleName> — For old Business Time commands, an identifier indicating which entry in the Business Time Workdays form contains a definition for the work schedule to use for this calculation. Omitting this value specifies open 7 days a week, 24 hours a day.