/
timeBand
Document toolboxDocument toolbox

timeBand

Owned by Jason Andrew
Sept 20, 2023

Code Block

<band>
    <timeBandID>?</timeBandID>
    <start>?</start>
    <end>?</end>
</band>


Definition

The name given to a segment of time that can be supplied to further filter out certain appointments and to modify the start and/or end times of the offers returned

 timeBandID, start, and end  are used to generate a (notional) filter band, FilterStartTime to FilterEndTime. FilterStartTime is start, if supplied, or, if not, timeBandID.StartTime if timeBandID is supplied, or, if not, the start of the day. Similarly, FilterEndTime is end if supplied or, if not, timeBandID.EndTime, if supplied, or, if not, the end of the day.  Because jobs can span midnight, the FilterEndTime can appear to be before FilterStartTime, but this is interpreted as being on the next day.

If the filter band is totally outside the initially-generated offer (i.e. there’s no overlap between them), the offer isn’t returned at all. If FilterStartTime is within an offered appointment, i.e. is between the initially-generated values of PromStartTime and PromEndTime (see later in this section), then PromStartTime will be changed to FilterStartTime before returning that offer. Similarly, if FilterEndTime is within the appointment, then PromEndTime will be changed to FilterEndTime.

Note: An initially-generated offer can never be lengthened by application of the filter band, only shortened.


Fields


Field

Type

Description

timeBandIDtimeBandIDis the name of a time band that can be supplied to further filter out certain appointments and to modify the start and/or end times of the offers returned



start



spTime

Date and time formats for the Webservices follow the UTC standard:

Datatype

Web Service Format

Date

CCYY-MM-DD

Time

HH:mm

DateTime

CCYY-MM-DDTHH:mm

end

spTime

The day and time that the appointment returns will stop being applied to the select time band. The date and time format for the web services follows the UTC standards.

(See Start above).