Web Service Integration 31 - GetWatchedCarriers

Introduction
The GetWatchedCarriers web service allows you to get all the data on carriers you are watching.

GetWatchedCarriers will respond with a complete set of CarrierLookup data on all carriers in your watch list. Typically, this web service only need be called when a user is first setting up or if they are doing re-sync for some reason.

Depending on the size of your watch list, GetWatchedCarriers can result in a large response. As a result, this web service is designed for you to page through the results.

basic concept is as follows:

Your first GetWatchedCarriers request sends a page index of 'BEGIN': &pageIndex=BEGIN The response will include a list of CarrierLookups followed by a <PageIndex> tag. If this tag contains the value 'END', you are done. Otherwise, you will need to make an additional request with the new page index value. Continue this process until you reach a <PageIndex> value of END.

The Web Service Details

https://www.saferwatch.com/webservices/CarrierService31.php
?Action=GetWatchedCarriers
&ServiceKey=YourServiceKey
&CustomerKey=YourCustomerKey
&pageIndex=On first call send value of 'BEGIN'. On subsequent calls send value provided in <PageIndex> tag of response to prior request. If the response value is 'END', you have paged through all your watched carriers and are done.
&returnCount=250 Recommended. Can be any number from 1 to 500

Example GetWatchedCarriers call would get the first 5 carriers in your watch list:

https://www.saferwatch.com/webservices/CarrierService31.php?Action=GetWatchedCarriers&ServiceKey=DemoServiceKey&CustomerKey=DemoCustomerKey&pageIndex=BEGIN&returnCount=5
Click to see GetWatchedCarriers results

Response fields values:

<CarrierService31.GetWatchedCarriers>
<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.GetWatchedCarriers>