Schedules

Table Name: GXT_SCHEDULES_TBL

List

Request a list of schedules.

Request:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_SCHEDULES_TBL

Response:

Copy

0=Work Hours&1=After Hours&2=Break Hours

Detail

Request the details of a specific schedule.

Request:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_SCHEDULES_TBL&RecId=<RecId>

Response:

Copy

ScheduleId=0&Name=Work Hours&StartTime=1-1-2226T8:30:0&EndTime=1-1-2226T17:30:0&Sunday=false&Monday=true&Tuesday=true&Wednesday=true&Thursday=true&Friday=true&Saturday=false&HolidayMode1=0&StartTime1=1-1-2226T0:0:0&EndTime1=1-1-2226T0:0:0&Sunday1=false&Monday1=false&Tuesday1=false&Wednesday1=false&Thursday1=false&Friday1=false&Saturday1=false&HolidayMode2=0&StartTime2=1-1-2226T0:0:0&EndTime2=1-1-2226T0:0:0&Sunday2=false&Monday2=false&Tuesday2=false&Wednesday2=false&Thursday2=false&Friday2=false&Saturday2=false&HolidayMode3=0&StartTime3=1-1-2226T0:0:0&EndTime3=1-1-2226T0:0:0&Sunday3=false&Monday3=false&Tuesday3=false&Wednesday3=false&Thursday3=false&Friday3=false&Saturday3=false&HolidayMode4=0&StartTime4=1-1-2226T0:0:0&EndTime4=1-1-2226T0:0:0&Sunday4=false&Monday4=false&Tuesday4=false&Wednesday4=false&Thursday4=false&Friday4=false&Saturday4=false&HolidayMode5=0&StartTime5=1-1-2226T0:0:0&EndTime5=1-1-2226T0:0:0&Sunday5=false&Monday5=false&Tuesday5=false&Wednesday5=false&Thursday5=false&Friday5=false&Saturday5=false&HolidayMode6=0&StartTime6=1-1-2226T0:0:0&EndTime6=1-1-2226T0:0:0&Sunday6=false&Monday6=false&Tuesday6=false&Wednesday6=false&Thursday6=false&Friday6=false&Saturday6=false&HolidayMode7=0&StartTime7=1-1-2226T0:0:0&EndTime7=1-1-2226T0:0:0&Sunday7=false&Monday7=false&Tuesday7=false&Wednesday7=false&Thursday7=false&Friday7=false&Saturday7=false&HolidayMode8=0&InvalidateScheduleIfQualifyPGMOn=false&InvalidateScheduleIfQualifyPGMOff=false&QualifyPGM=2147483647

Update

Update a specific schedule.

Request:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_SCHEDULES_TBL&ScheduleId=0&Name=Office Hours

Response:
Copy
```
OK
```

Create

Create a schedule. To create a schedule, use the same parameters as update but leave the ScheduleId empty.

Request:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_SCHEDULES_TBL&ScheduleId=&Name=Work Hours&StartTime=1-1-2226T8:30:0&EndTime=1-1-2226T17:30:0&Sunday=false&Monday=true&Tuesday=true&Wednesday=true&Thursday=true&Friday=true&Saturday=false&HolidayMode1=0&StartTime1=1-1-2226T0:0:0&EndTime1=1-1-2226T0:0:0&Sunday1=false&Monday1=false&Tuesday1=false&Wednesday1=false&Thursday1=false&Friday1=false&Saturday1=false&HolidayMode2=0&StartTime2=1-1-2226T0:0:0&EndTime2=1-1-2226T0:0:0&Sunday2=false&Monday2=false&Tuesday2=false&Wednesday2=false&Thursday2=false&Friday2=false&Saturday2=false&HolidayMode3=0&StartTime3=1-1-2226T0:0:0&EndTime3=1-1-2226T0:0:0&Sunday3=false&Monday3=false&Tuesday3=false&Wednesday3=false&Thursday3=false&Friday3=false&Saturday3=false&HolidayMode4=0&StartTime4=1-1-2226T0:0:0&EndTime4=1-1-2226T0:0:0&Sunday4=false&Monday4=false&Tuesday4=false&Wednesday4=false&Thursday4=false&Friday4=false&Saturday4=false&HolidayMode5=0&StartTime5=1-1-2226T0:0:0&EndTime5=1-1-2226T0:0:0&Sunday5=false&Monday5=false&Tuesday5=false&Wednesday5=false&Thursday5=false&Friday5=false&Saturday5=false&HolidayMode6=0&StartTime6=1-1-2226T0:0:0&EndTime6=1-1-2226T0:0:0&Sunday6=false&Monday6=false&Tuesday6=false&Wednesday6=false&Thursday6=false&Friday6=false&Saturday6=false&HolidayMode7=0&StartTime7=1-1-2226T0:0:0&EndTime7=1-1-2226T0:0:0&Sunday7=false&Monday7=false&Tuesday7=false&Wednesday7=false&Thursday7=false&Friday7=false&Saturday7=false&HolidayMode8=0&InvalidateScheduleIfQualifyPGMOn=false&InvalidateScheduleIfQualifyPGMOff=false&QualifyPGM=2147483647

Response:
Copy
```
OK
```

Delete

Delete a specific schedule.

Request:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_SCHEDULES_TBL&RecId=<RecId>

Response:
Copy
```
OK
```

Parameters

Parameter

Display Name

Default Value

Note

ScheduleId

Database ID

The Detail, Control and Delete APIs use this value as the RecId.

Name

Work Hours

HolidayGroup*

Holiday Groups

StartTime

Start Time (Period 1)

1-1-2226T8:30:0

EndTime

End Time (Period 1)

1-1-2226T17:30:0

Sunday

Sunday (Period 1)

false

Monday

Monday (Period 1)

true

Tuesday

Tuesday (Period 1)

true

Wednesday

Wednesday (Period 1)

true

Thursday

Thursday (Period 1)

true

Friday

Friday (Period 1)

true

Saturday

Saturday (Period 1)

false

HolidayMode1

Holiday Mode (Period 1)

The settings are:

Value	Setting
0	Disabled On Holiday
1	Enabled On Holiday
2	Ignore Holiday

StartTime1

Start Time (Period 2)

1-1-2226T0:0:0

EndTime1

End Time (Period 2)

1-1-2226T0:0:0

Sunday1

Sunday (Period 1)

false

Monday1

Monday (Period 2)

false

Tuesday1

Tuesday (Period 2)

false

Wednesday1

Wednesday (Period 2)

false

Thursday1

Thursday (Period 2)

false

Friday1

Friday (Period 2)

false

Saturday1

Saturday (Period 2)

false

HolidayMode2

Holiday Mode (Period 2)

The settings are:

Value	Setting
0	Disabled On Holiday
1	Enabled On Holiday
2	Ignore Holiday

StartTime2

Start Time (Period 3)

1-1-2226T0:0:0

EndTime2

End Time (Period 3)

1-1-2226T0:0:0

Sunday2

Sunday (Period 3)

false

Monday2

Monday (Period 3)

false

Tuesday2

Tuesday (Period 3)

false

Wednesday2

Wednesday (Period 3)

false

Thursday2

Thursday (Period 3)

false

Friday2

Friday (Period 3)

false

Saturday2

Saturday (Period 3)

false

HolidayMode3

Holiday Mode (Period 3)

The settings are:

Value	Setting
0	Disabled On Holiday
1	Enabled On Holiday
2	Ignore Holiday

StartTime3

Start Time (Period 4)

1-1-2226T0:0:0

EndTime3

End Time (Period 4)

1-1-2226T0:0:0

Sunday3

Sunday (Period 4)

false

Monday3

Monday (Period 4)

false

Tuesday3

Tuesday (Period 4)

false

Wednesday3

Wednesday (Period 4)

false

Thursday3

Thursday (Period 4)

false

Friday3

Friday (Period 4)

false

Saturday3

Saturday (Period 4)

false

HolidayMode4

Holiday Mode (Period 4)

The settings are:

Value	Setting
0	Disabled On Holiday
1	Enabled On Holiday
2	Ignore Holiday

StartTime4

Start Time (Period 5)

1-1-2226T0:0:0

EndTime4

End Time (Period 5)

1-1-2226T0:0:0

Sunday4

Sunday (Period 5)

false

Monday4

Monday (Period 5)

false

Tuesday4

Tuesday (Period 5)

false

Wednesday4

Wednesday (Period 5)

false

Thursday4

Thursday (Period 5)

false

Friday4

Friday (Period 5)

false

Saturday4

Saturday (Period 5)

false

HolidayMode5

Holiday Mode (Period 5)

The settings are:

Value	Setting
0	Disabled On Holiday
1	Enabled On Holiday
2	Ignore Holiday

StartTime5

Start Time (Period 6)

1-1-2226T0:0:0

EndTime5

End Time (Period 6)

1-1-2226T0:0:0

Sunday5

Sunday (Period 6)

false

Monday5

Monday (Period 6)

false

Tuesday5

Tuesday (Period 6)

false

Wednesday5

Wednesday (Period 6)

false

Thursday5

Thursday (Period 6)

false

Friday5

Friday (Period 6)

false

Saturday5

Saturday (Period 6)

false

HolidayMode6

Holiday Mode (Period 6)

The settings are:

Value	Setting
0	Disabled On Holiday
1	Enabled On Holiday
2	Ignore Holiday

StartTime6

Start Time (Period 7)

1-1-2226T0:0:0

EndTime6

End Time (Period 7)

1-1-2226T0:0:0

Sunday6

Sunday (Period 7)

false

Monday6

Monday (Period 7)

false

Tuesday6

Tuesday (Period 7)

false

Wednesday6

Wednesday (Period 7)

false

Thursday6

Thursday (Period 7)

false

Friday6

Friday (Period 7)

false

Saturday6

Saturday (Period 7)

false

HolidayMode7

Holiday Mode (Period 7)

The settings are:

Value	Setting
0	Disabled On Holiday
1	Enabled On Holiday
2	Ignore Holiday

StartTime7

Start Time (Period 8)

1-1-2226T0:0:0

EndTime7

End Time (Period 8)

1-1-2226T0:0:0

Sunday7

Sunday (Period 8)

false

Monday7

Monday (Period 8)

false

Tuesday7

Tuesday (Period 8)

false

Wednesday7

Wednesday (Period 8)

false

Thursday7

Thursday (Period 8)

false

Friday7

Friday (Period 8)

false

Saturday7

Saturday (Period 8)

false

HolidayMode8

Holiday Mode (Period 8)

The settings are:

Value	Setting
0	Disabled On Holiday
1	Enabled On Holiday
2	Ignore Holiday

InvalidateScheduleIfQualifyPGMOn

Validate Schedule If Qualify Output On

false

InvalidateScheduleIfQualifyPGMOff

Validate Schedule If Qualify Output Off

false

QualifyPGM

Qualify Output

2147483647

Parameters that contain multiple values are documented as <Parameter Name>*, where * is the index of the value. See Programming.