_setTemperatureAlarms

WDS_TemperatureAlarmsReturnItem _setTemperatureAlarms ( string kodf , string username , string pass , int carid , WDS_TemperatureAlarmsItem temperatures , WDS_TemperatureAlarmsTimeItem days , string phoneList , string emailList , string alarmText , int toWDFleet )

Description

The function sets temperature alarms

Parameters

string kodf

Company code

string username

Login username

string pass

Login password

int carid

ID of vehicle

WDS_TemperatureAlarmsItem temperatures

• WDS_TemperatureAlarmItem
  • int alarmEnabled1
  • float minTemp1
  • float maxTemp1
  • int interval1
  • int alarmEnabled2
  • float minTemp2
  • float maxTemp2
  • int interval2
• WDS_TemperatureAlarmItem
  • int alarmEnabled1
  • float minTemp1
  • float maxTemp1
  • int interval1
  • int alarmEnabled2
  • float minTemp2
  • float maxTemp2
  • int interval2
• WDS_TemperatureAlarmItem
  • int alarmEnabled1
  • float minTemp1
  • float maxTemp1
  • int interval1
  • int alarmEnabled2
  • float minTemp2
  • float maxTemp2
  • int interval2
• WDS_TemperatureAlarmItem
  • int alarmEnabled1
  • float minTemp1
  • float maxTemp1
  • int interval1
  • int alarmEnabled2
  • float minTemp2
  • float maxTemp2
  • int interval2
• WDS_TemperatureAlarmItem
  • int alarmEnabled1
  • float minTemp1
  • float maxTemp1
  • int interval1
  • int alarmEnabled2
  • float minTemp2
  • float maxTemp2
  • int interval2
• WDS_TemperatureAlarmItem
  • int alarmEnabled1
  • float minTemp1
  • float maxTemp1
  • int interval1
  • int alarmEnabled2
  • float minTemp2
  • float maxTemp2
  • int interval2
• WDS_TemperatureAlarmItem
  • int alarmEnabled1
  • float minTemp1
  • float maxTemp1
  • int interval1
  • int alarmEnabled2
  • float minTemp2
  • float maxTemp2
  • int interval2
• WDS_TemperatureAlarmItem
  • int alarmEnabled1
  • float minTemp1
  • float maxTemp1
  • int interval1
  • int alarmEnabled2
  • float minTemp2
  • float maxTemp2
  • int interval2

temperatures - setting specific temperatures and intervals for individual sensors
can be sent <temperature1> - <temperature8> - set only for active sensors (see note)
description of parameters e.g. for <temperature1>:
alarmEnabled1 - input is 0.1 - to turn on/off temperature monitoring on the vehicle
minTemp1 - lower value of the temperature of the monitored interval
maxTemp1 - upper value of the temperature of the monitored interval
interval1 - number of minutes for which the monitored temperature is outside the interval, i.e. if the temperature is outside the interval for longer than XXX minutes, then the system will send an alarm notification to the selected recipient. (See vehicle settings Temperatures)
alarmEnabled2 - see alarmEnabled1
minTemp2 - see minTemp1
maxTemp2 - see maxTemp1
interval2 - see interval1

WDS_TemperatureAlarmsTimeItem days

• int mondayEnabled
• string mondayFromTime
• string mondayToTime
• int tuesdayEnabled
• string tuesdayFromTime
• string tuesdayToTime
• int wednesdayEnabled
• string wednesdayFromTime
• string wednesdayToTime
• int thursdayEnabled
• string thursdayFromTime
• string thursdayToTime
• int fridayEnabled
• string fridayFromTime
• string fridayToTime
• int saturdayEnabled
• string saturdayFromTime
• string saturdayToTime
• int sundayEnabled
• string sundayFromTime
• string sundayToTime

set alarms for days and times
if a day is not sent, it is set to off and the default time i.e. the value is reset
for Monday it has this rule:
mondayEnabled - enable alarms for this day
mondayFromTime - time from, HH:mm
mondayToTime - time to, HH:mm
for the remaining days it continues the same way, just the day is changed, which is in EN. i.e. Tuesday, Wednesday...Sunday

string phoneList

list of phone numbers - alarm recipients

string emailList

list of emails - alarm recipients

string alarmText

Text of Alarm

int toWDFleet

Send alarm to WD fleet. 0 - no, 1 - yes

Return value

Information about alarm settings for a given sensor. Possible states:
Not send in request. - Temperature X is not send in request. The status is fine if you don't want to set this alarm.
Ok - Temperature alarm has been set
Alarm cannot be set: sensor not installed - Alarm was sent in the request, but it could not be set, because the vehicle does not have the required sensor.

Error Codes/Messages:
-5: Semi-trailers and temperature sensors package not activated
Message: The "Semi-trailers and temperature sensors package" is not activated. Service is not allowed
- 6: no alarm recipient specified, i.e. phoneList and emailList parameters are both empty (at least one must be filled in)
Message: It is necessary to fill in the mobile number or email of the recipient for the temperature alarm notification
-7: alarm text is empty
Message: The text of the email alerting the temperature alarm is mandatory
-8: the entire interval for the active temperature sensor has not been specified
Message: When the temperature alarm is on, you need to fill in all values ​​(lower and upper temperature values ​​and the time of the monitored interval)
-9: the specified time format is not correct, i.e. must be in HH:mm format
message: Check all times from and to if they are in the correct format HH:mm
-10: time to on a day must be greater than time from (i.e., for example, mondayFromTime < mondayToTime)
message: The time to must be greater than the time from

Examples

API version 2.0

$client = new SoapClient('https://api.webdispecink.cz/code/WebDispecinkServiceNet.php?wsdl');
$return = $client->_setTemperatureAlarms($kodf, $username, $pass, $carid, $temperatures, $days, $phoneList, $emailList, $alarmText, $toWDFleet);

Test

To test the function, enter parameters in form below and press Try it out button.