Web Service Integration 31 - GetChangedCarriers

Introduction
The GetChangedCarriers web service allows you to get data changes on carriers you are watching.

GetChangedCarriers will respond with a complete set of CarrierLookup data on any carrier in your watch list that has had a change. PLEASE NOTE EXCEPTION BELOW. The data is the latest, most up-to-date information on the carrier. This web service call does not tell you specifically what changed, rather, it says something changed and here is a full set of the most recent data to update your side. If you need to know specifically what changed, you could compare the new record to what you currently have, or contact us for further options.

EXCEPTION: GetChangedCarriers will return <carrierType>Interstate, Broker, Other</carrierType>. CarrierLookup will return <carrierType>Interstate, Interstate/Broker, Broker, Intrastate, or Other</carrierType>. <carrierType> is an internal profile label associated with how our system applies Risk Assessment. <carrierType> is not meant to be used as an indicator of what type of business the entity may be licensed for.

At times, specifically when large data changes are received from the DOT, GetChangedCarriers can result in a large response. As a result, it is important to setup this web service for multiple requests allowing the process to "page" through the results.

The first call to get GetChangedCarriers you send a pageIndex of "BEGIN". After processing the results in the CarrierList, check the value of the returned <PageIndex>. If the value is "END", you are done. Otherwise, get the next set of changes be making another request passing the new pageIndex. Continue this process until you receive a <PageIndex> of "END".

The Web Service Details

https://www.saferwatch.com/webservices/CarrierService31.php
?Action=GetChangedCarriers
&ServiceKey=YourServiceKey
&CustomerKey=YourCustomerKey
&pageIndex=BEGIN on first call. On subsequent calls send value in <PageIndex> tag or prior call
&returnCount=250 Recommended. Can be any number from 1 to 500
&fromDate=Format YYYY-MM-DD
&fromTime=Format HM::MM:SS where HM is military hour
&toDate=Format YYYY-MM-DD
&toTime=Format HM::MM:SS where HM is military hour


The date and time parameters represent central time zone date time of the carrier change. You need to establish when and how often you would like to get changes. We recommend that you get changes at least daily. Also, it is a good idea that your first request for changes is after 5am central time

Example of getting daily changes:
July 7th 10:00:00 to July 8th 10:00:00 (this request must occur after 10:00:00 central time)

Example of getting daily changes multiple times per day:

Change From - To     Request time
     6pm - 7am             7:10am
     7am - 1pm             1:10pm
     1pm - 6pm             6:10pm

Make sure your scheduled covers the full 24 hour period

Note that you can reduce your need to be exactly update to date on changes if you allow the user to invoke a CarrierLookup call prior to assigning a carrier.

Example GetChangedCarriers call to get the first 5 changes for yesterday:

https://www.saferwatch.com
Click to see GetChangedCarriers results

Note if you do not get results, see below to watch carriers that have recent changes.

Implementation/Testing Tools:

It can be tricky to get results back on this web service call as you need to be watching carriers that have changes. To assist, the following call will add 15 carriers to your current watch list that have recent changes. Just swap in your service and customer key to perform for your account.

Add 15 carriers to watchlist that have changes from yesterday:

https://www.saferwatch.com/webservices/CarrierService31.php?Action=AddChangedCarriers&ServiceKey=DemoServiceKey&CustomerKey=DemoCustomerKey
Click to Add test carriers

Response fields values:

<CarrierService31.GetChangedCarriers>
<CarrierList>
     <CarrierDetails>see CarrierLookup for details</CarrierDetails>
     <CarrierDetails>see CarrierLookup for details</CarrierDetails>
     <CarrierDetails etc... returning number of carriers specified by returnCount unless reached page index of END
</CarrierList>
<PageIndex>Value of END for completed or value that should be passed as pageIndex in next call</PageIndex>
<ResponseDO> NOTE: See Standard Response
     <status>APPROVED</status>
     <action>OK</action>
     <code>SFW00389</code>
     <displayMsg></displayMsg>
     <techMsg></techMsg>
</ResponseDO>
</CarrierService.GetChangedCarriers>