static data API Time Zone Conversions
- Paul Hindle
- Andrew Hill (Deactivated)
- Matthew Wren (Unlicensed)
The following system parameters determine the local time used in ServiceScheduling APIs:
tz_BJAPIIn | Book Job API local time type |
tz_CJS | Change Job Status local time type |
tz_disp_api | Dispatch API local time type |
tz_GAAPI | Get Activity API local time type |
tz_GCJAPI | Get Changed Job API local time type |
tz_GJAPI | Get Job (resourced) API local time type |
tz_jeop_api | Jeopardy API local time type |
tz_opts | Set Employee Travel Status API local time type |
The values that the parameters can take have the following meaning:
0 | Customer local time, i.e. the D&Ts are local to the TZ of the region where the job is located. |
1 | reserved |
2 | RU local time. |
3 | Employee Local time i.e. the D&Ts are local to the TZ of the Employee |
4 | reserved |
5 | reserved |
6 | GMT0 (i.e. time_t expressed as a character string) |
7 | GMT0BST (i.e. GMT with daylight saving) |
a tz_tz_value | which is in sp056_time_zones, e.g. “EST5EDT,M4.1.0,M10.5.0” |
a tz_ref | Which is in sp056_time_zones, e.g. “Eastern” |
Important Notes
- For tz_GAAPI, tz_GJAPI, tz_GJAPIUnres and tz_opts value 0 is illegal and will halt the start up of the system.
- For tz_BJAPIIn and tz_GJAPIUnres value 3 is illegal and will halt the start up of the system.
- For all parameters values 1, 4, 5 or any unknown tz_tz_value are invalid. For tz_disp_api and tz_jeop_api this will cause the API to return SP_INVALID_TIME_ZONE_LOCATION. For other parameters it will halt the start up of the system.
- If tz_GJAPIUnres is not in the database or is present but has no value, tz_GJAPI will be used.
All other parameters default to the value of system parameter tz_Default.