Set Scheduled Reefer Monitoring

Last updated
Save as PDF

setScheduledReeferMonitoring

The setScheduledReeferMonitoring web service sets the temperature monitoring parameters for a given trailer.

void setScheduledReeferMonitoring(AssetIdentifier trailer, ReeferMonitoring reeferMonitoring) throws WSException

trailer: An AssetIdentifier object that contains the identifier of the trailer to set the scheduled temperature monitoring for.
reeferMonitoring: A ReeferMonitoring object containing the temperature monitoring information.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use Trailer Tracks
- Can assign monitoring plans OR can maintain trailers

Customer integrators are authorized to their own company's data only.

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Trailer SCAC is invalid.
006 Trailer ID is invalid.
007 A reefer trailer with the specified SCAC/ID does not exist.
008 Monitoring end time must be greater than start time.
009 Invalid monitoring start time.
010 Invalid monitoring end time.
011 Temperature out of range notification time is invalid.
012 Sensor to monitor is invalid.
013 Target temperature is invalid.
014 Temperature tolerance is invalid.
015 Email address is invalid.

Sample setScheduledReeferMonitoring Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, view the Web Service Security page.

<soapenv:Body>

<setScheduledReeferMonitoring>

<trailer xmlns="">

<id>REEFER</id>

<scac>CSDI</scac>

</trailer>

<ReeferMonitoring>

<active>true</active>

<startDate>2007-12-25T12:00:00Z</startDate>

<stopDate>2008-01-10T12:00:00Z</stopDate>

<ongoing>false</ongoing>

<tempNotifyTime>15</tempNotifyTime>

<tempSensor>1</tempSensor>

<useDriverSetpoint>false</useDriverSetpoint>

<targetTemp>30.0</targetTemp>

<tempTolerance>3.5</tempTolerance>

<notification>

<Email>

<address>romanowski@volpico.com</address>

</Email>

<Email>

<address>spalmer@volpico.com</address>

</Email>

</notification>

</ReeferMonitoring>

</setScheduledReeferMonitoring>

</soapenv:Body>

Sample setScheduledReeferMonitoring Response

An empty response conveys success. If there was an error, an exception would have been thrown.

<soapenv:Body>

<setScheduledReeferMonitoringResponse/>

</soapenv:Body>