Available in: Enterprise edition.
The WorldLink application allows for considerable customization in how data is passed to or from WorldLink. These API's are provided as a means to use the WorldLink engine while providing a custom interface to process shipments. There are no API's to manage configuration of the WorldLink system.
The ASP pages provide a means to view the data constructs being used in retrieving and posting information in WorldLink. The Get ASP pages are used to retrieve the XML documents to be used in the transaction. In essence, to get templates used for their respective processes. The Put ASP pages are used to push the populated XML documents to the WorldLink database and the rating engine.
To summarize: Use a GET page to pull up a template, populate the necessary data fields, and then call the respective PUT page to process.
Some of the following ASP pages are provided more for their informational capacity then they are for their ability to manipulate the system. The information they provide is still necessary but it is not something that is sent back to the server in its entirety.
Currently, the ASP pages available are:
GetAddressVerification - This ASP page gets the XML object to perform address verification.
GetLogin - This ASP page gets the XML object necessary to perform log-ins to the system. This information is pulled before the log in screen appears and relies on a cookie setting.
GetOrgs - This ASP page returns an XML object populated with all the organizations defined in the WorldLink system.
GetShipment - This ASP page gets the XML template for processing shipments.
GetShipVias - This ASP page returns an XML object populated with all the ShipVias defined in the WorldLink system. ShipVias are also accounted for in GetShipment.
GetSpecialServices - This ASP page returns an XML object populated with all the special services defined in the WorldLink system.
GetStationConfig - This ASP page returns an XML object populated with the station configuration of the caller.
GetVoidPackage - This ASP page gets the XML template for voiding a package.
PutLogin - This ASP page initiates a log-in with the XML document retrieved from GetLogin.
PutShipment - This ASP page initiates a shipment with the XML document retrieved from GetShipment.
PutVoidPackage - This ASP page initiates a package void with the XML document retrieved from GetVoidPackage.
GetDepartments – This ASP page returns an XML object populated with all the existing departments in the system.
GetEmotionConfig – This ASP page returns an XML object populated with the current Emotion Configuration in the system.
GetHandlingUnits – This ASP page returns an XML object populated with all the handling units existing in the system.
GetManifestRecord – This ASP page gets the XML template for creating a manifest.
GetShipmentResults – This ASP page gets the XML template for the Shipment Results.
GetViewShipment – This ASP page gets the XML Template for Viewing Shipments.
GetSites – This ASP page returns an XML Object populated with all the sites existing in the system.
GetXRefGroups – This ASP page returns an XML object populated with all the XRefGroups existing in the system.
GetStopList – This ASP page returns an XML object populated with the all the Stop List data existing in the system.
GetSpecialInstruction – This ASP page returns an XML object populated with all the Special Instructions existing in the system.
GetStations – This ASP page returns an XML object populated with all the stations existing in the system.
GetUserGroups – This ASP page returns an XML object populated with all the user groups existing in the system.
GetCarrierAccounts – This ASP page returns an XML object populated with all the Carrier Accounts existing in the system.
GetBestWays – This ASP page returns an XML object populated with all the best ways existing in the system.
GetDeliveryAreas - This ASP page returns an XML object populated with all the delivery areas existing in the system.
GetSWOSGroups - This ASP page returns an XML object populated with all the SWOS groups existing in the system.
GetThirdParty - This ASP page returns an XML object populated with all the Third parties existing in the system.
GetUsers - This ASP page returns an XML object populated with all the Users existing in the system.
GetHolidays - This ASP page returns an XML object populated with all the Holidays for the carriers existing in the system.
GetBOLconfiguration - This ASP page returns an XML object populated with the existing BOL Configuration data in the system.
These pages can be viewed (possibly with data relevant to the environment) by pointing your browser to http://[WLSite]/API/[PageName].asp. As an example, to view the GetLogin ASP page on the machine where WorldLink is installed, go to http://localhost/wl30/API/GetLogin.asp.
When viewing the ASP pages, those fields that contain data reflect the station the user is browsing from and the default information associated to the user.
Every data field in the Process Shipments screen can be populated programmatically.