14.1 API Time Zone Conversions
The following system parameters determine the local time used in ServiceScheduling APIs:
| Book Job API local time type |
| Change Job Status local time type |
| Dispatch API local time type |
| Get Activity API local time type |
| Get Changed Job API local time type |
| Get Job (resourced) API local time type |
| Jeopardy API local time type |
| 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. |
7 | GMT0BST (i.e. GMT with daylight saving) |
a | Which is in |
a | Which is in |
Important Notes
- For
tz_GAAPI
,tz_GJAPI
,tz_GJAPIUnres
andtz_opts
value 0 is illegal and will halt the start up of the system. - For
tz_BJAPIIn
andtz_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. Fortz_disp_api
andtz_jeop_api
this will cause the API to returnSP_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 parametertz_Default
.