Freight Tracking Web Service Implementation Guide

Size: px

Start display at page:

Download "Freight Tracking Web Service Implementation Guide"

Godwin Adams
10 years ago
Views:

1 P.O. Box 587 ( ) 1010 S 336 th, Suite 202 Federal Way, Washington Office (253) Fax (253) Toll Free (800) Freight Tracking Web Service Implementation Guide Dated: July 15, 2009

Washington 98003 Office (253) 929-2000 Fax (253) 929-2041

2 Peninsula Truck Lines, Inc. Freight Tracking Web Service Implementation Guide Table of Contents SECTION 1 GENERAL... 1 SECTION 2 CALLING THE FREIGHT TRACKING WEB SERVICE... 1 Calling parameters... 1 Calling methods... 1 SOAP 1.1 request and response... 1 SOAP 1.2 request and response... 3 HTTP GET request and response... 4 HTTP POST request and response... 6 SECTION 3 XML ATTRIBUTES... 7 i

.. 1 SECTION 2 CALLING THE FREIGHT TRACKING WEB SERVICE... 1 Calling parameters.

3 Peninsula Truck Lines, Inc. Freight Tracking Web Service Implementation Guide SECTION 1 GENERAL The freight tracking web service system provides customers with the ability to retrieve freight status information directly from Peninsula s computer system. An HTTP call is made by the customer s application and processed by the freight tracking system. Freight status is returned in XML format. CALLING PARAMETERS SECTION 2 CALLING THE FREIGHT TRACKING WEB SERVICE Input Parameter Table Parameter Name userid password pronumber Description Web user Id Web password Freight bill number CALLING METHODS The freight tracking web service can be requested with one of four methods: SOAP 1.1, SOAP 1.2, HTTP GET, and HTTP POST. The request and response for each type follow. It should be noted that the response will include either the XML status or errors attribute depending upon whether a runtime error occurred when the service was called. An error message will be returned if a runtime error occurs. SOAP 1.1 The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values. POST /WebServices/WebTools.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 SOAPAction: " <soap:envelope xmlns:xsi=" xmlns:soap=" <soap:body> <GetShipmentStatus xmlns=" <userid>string</userid> <password>string</password> </GetShipmentStatus> </soap:body> </soap:envelope> Page 1

Peninsula s computer system. An HTTP call is made by the customer s application and processed by the freight tracking system. Freight status is returned in XML format.

4 Content-Type: text/xml; charset=utf-8 <soap:envelope xmlns:xsi=" xmlns:soap=" <soap:body> <GetShipmentStatusResponse xmlns=" <GetShipmentStatusResult> <freightparties> </GetShipmentStatusResult> </GetShipmentStatusResponse> </soap:body> </soap:envelope> Content-Type: text/xml; charset=utf-8 <soap:envelope xmlns:xsi=" xmlns:soap=" <soap:body> <GetShipmentStatusResponse xmlns=" <GetShipmentStatusResult> Page 2

com/webservices"> <GetShipmentStatusResult> <freightparties> </GetShipmentStatusResult> </GetShipmentStatusResponse> </soap:body> </soap:envelope> com/webservices">

5 <freightparties> </GetShipmentStatusResult> </GetShipmentStatusResponse> </soap:body> </soap:envelope> SOAP 1.2 The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /WebServices/WebTools.asmx HTTP/1.1 Host: Content-Type: application/soap+xml; charset=utf-8 <soap12:envelope xmlns:xsi=" xmlns:soap12=" <soap12:body> <GetShipmentStatus xmlns=" <userid>string</userid> <password>string</password> </GetShipmentStatus> </soap12:body> </soap12:envelope> Content-Type: application/soap+xml; charset=utf-8 <soap12:envelope xmlns:xsi=" xmlns:soap12=" Page 3

com Content-Type: application/soap+xml; charset=utf-8 <soap12:envelope xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:body> <GetShipmentStatus xmlns="http://peninsulatruck.

6 <soap12:body> <GetShipmentStatusResponse xmlns=" <GetShipmentStatusResult> <freightparties> </GetShipmentStatusResult> </GetShipmentStatusResponse> </soap12:body> </soap12:envelope> HTTP GET The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values. GET /WebServices/WebTools.asmx/GetShipmentStatus?userId=string&password=string&pr onumber=string HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 <freightstatus xmlns=" <freightparties> <freightparty> <partytype>string</partytype> <partyname>string</partyname> Page 4

following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values. GET /WebServices/WebTools.asmx/GetShipmentStatus?

7 <partyaddress1>string</partyaddress1> <partyaddress2>string</partyaddress2> <partycity>string</partycity> <partystate>string</partystate> <partyzipcode>string</partyzipcode> </freightparty> <freightparty> <partytype>string</partytype> <partyname>string</partyname> <partyaddress1>string</partyaddress1> <partyaddress2>string</partyaddress2> <partycity>string</partycity> <partystate>string</partystate> <partyzipcode>string</partyzipcode> </freightparty> <freightterminal> <terminaltype>string</terminaltype> <terminalcode>string</terminalcode> <terminalname>string</terminalname> </freightterminal> <freightterminal> <terminaltype>string</terminaltype> <terminalcode>string</terminalcode> <terminalname>string</terminalname> </freightterminal> <freightactivity> <activitydate>string</activitydate> <activitytime>string</activitytime> <activitydescription>string</activitydescription> <activitylocation>string</activitylocation> </freightactivity> <freightactivity> <activitydate>string</activitydate> <activitytime>string</activitytime> <activitydescription>string</activitydescription> <activitylocation>string</activitylocation> </freightactivity> </freightstatus> HTTP POST The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values. Page 5

<terminalname>string</terminalname> </freightterminal> <freightterminal> <terminaltype>string</terminaltype> <terminalcode>string</terminalcode> <terminalname>string</terminalname> </freightterminal>

8 POST /WebServices/WebTools.asmx/GetShipmentStatus HTTP/1.1 Host: Content-Type: application/x-www-form-urlencoded userid=string&password=string&pronumber=string Content-Type: text/xml; charset=utf-8 <freightstatus xmlns=" <freightparties> <freightparty> <partytype>string</partytype> <partyname>string</partyname> <partyaddress1>string</partyaddress1> <partyaddress2>string</partyaddress2> <partycity>string</partycity> <partystate>string</partystate> <partyzipcode>string</partyzipcode> </freightparty> <freightparty> <partytype>string</partytype> <partyname>string</partyname> <partyaddress1>string</partyaddress1> <partyaddress2>string</partyaddress2> <partycity>string</partycity> <partystate>string</partystate> <partyzipcode>string</partyzipcode> </freightparty> <freightterminal> <terminaltype>string</terminaltype> <terminalcode>string</terminalcode> <terminalname>string</terminalname> </freightterminal> <freightterminal> <terminaltype>string</terminaltype> <terminalcode>string</terminalcode> <terminalname>string</terminalname> </freightterminal> <freightactivity> <activitydate>string</activitydate> <activitytime>string</activitytime> <activitydescription>string</activitydescription> Page 6

com/webservices"> <freightparties> <freightparty> <partytype>string</partytype> <partyname>string</partyname> <partyaddress1>string</partyaddress1> <partyaddress2>string</partyaddress2>

9 <activitylocation>string</activitylocation> </freightactivity> <freightactivity> <activitydate>string</activitydate> <activitytime>string</activitytime> <activitydescription>string</activitydescription> <activitylocation>string</activitylocation> </freightactivity> </freightstatus> SECTION 3 XML ATTRIBUTES Attribute status pronumber prodate interlinepro shippernumber ponumber freightparty freightterminal prostatus freightactivity errors number message Description Freight bill number Freight bill date Interline pro number (if interline carrier) Shipper bill of lading number Purchase order number Shipper or consignee Terminal service origin or destination Freight bill status string Detail freight status tracking Runtime error number Runtime error message Page 7

interlinepro shippernumber ponumber freightparty freightterminal prostatus freightactivity errors number message Description Freight bill number Freight bill date Interline pro number (if

Using ilove SharePoint Web Services Workflow Action

Using ilove SharePoint Web Services Workflow Action This guide describes the steps to create a workflow that will add some information to Contacts in CRM. As an example, we will use demonstration site