DeviceTimeframeParameter data structure

Element

Description

Type

Occurrences

name

Name of the Device Timeframe

string

1

startTime

Time at which the Timeframe begins, in the format hh:mm

string

1

durationHours

How many hours the Timeframe is active

integer

1

durationMinutes

How many minutes the Timeframe is active (in addition to the durationHours)

integer

1

sunday

Indicates whether the Timeframe is active on Sundays

Boolean

1

monday

Indicates whether the Timeframe is active on Mondays

Boolean

1

tuesday

Indicates whether the Timeframe is active on Tuesdays

Boolean

1

wednesday

Indicates whether the Timeframe is active on Wednesdays

Boolean

1

thursday

Indicates whether the Timeframe is active on Thursdays

Boolean

1

friday

Indicates whether the Timeframe is active on Fridays

Boolean

1

saturday

Indicates whether the Timeframe is active on Saturdays

Boolean

1

excludeHolidays

Indicates whether holidays should be excluded from the Device Timeframe

Boolean

1

Specification:

<xs:complexType name="DeviceNamesSearchParameters">

  <xs:sequence>

    <xs:element name="name" nillable="true" type="xs:string"/>

    <xs:element name="startTime" nillable="true" type="xs:string"/>

    <xs:element name="durationHours" nillable="true" type="xs:int"/>

    <xs:element name="durationMinutes" nillable="true" type="xs:int"/>

    <xs:element name="sunday" nillable="true" type="xs:boolean"/>

    <xs:element name="monday" nillable="true" type="xs:boolean"/>

    <xs:element name="tuesday" nillable="true" type="xs:boolean"/>

    <xs:element name="wednesday" nillable="true" type="xs:boolean"/>

    <xs:element name="thursday" nillable="true" type="xs:boolean"/>

    <xs:element name="friday" nillable="true" type="xs:boolean"/>

    <xs:element name="saturday" nillable="true" type="xs:boolean"/>

    <xs:element name="excludeHolidays" nillable="true" type="xs:boolean"/>

  </xs:sequence>

</xs:complexType>

Example