PC*MILER|Rail Web Services
Public Member Functions | List of all members
ISoapService Interface Reference

Public Member Functions

ReportResponse GetRouteReport (Station[] Stops, RouteOptions Options, ReportType Report)
 RouteReport API will generate a requested report. More...
 
GeocodeResponse GeocodeStation (Station Location, GeocodeOptions Options)
 GeocodeStation API for locating rail freight station(s). More...
 

Detailed Description

PC*MILER|Rail SOAP Service

Member Function Documentation

◆ GetRouteReport()

ReportResponse GetRouteReport ( Station []  Stops,
RouteOptions  Options,
ReportType  Report 
)

RouteReport API will generate a requested report.

Parameters
StopsList of Stations that make up the route.
Options(Optional) Route options to be applied to the route.
ReportReport to be generated. Default is Detailed.
Returns
ReportResponse containing a report report based on the Report parameter.
SOAP Body Example:
<pcm:GetRouteReport>
 <pcm:Stops>
   <pcm:Station>
     <pcm:Format>StationState</pcm:Format>
     <pcm:Name>Denver, CO</pcm:Name>
     <pcm:Railroad>BNSF</pcm:Railroad>
   </pcm:Station>
   <pcm:Station>
     <pcm:Format>StationState</pcm:Format>
     <pcm:Name>seattle wa</pcm:Name>
     <pcm:Railroad>BNSF</pcm:Railroad>
   </pcm:Station>
 </pcm:Stops>
   <pcm:Options>
     <pcm:TerminalSwitching>true</pcm:TerminalSwitching>
     <pcm:IntermodalOnlyStations>true</pcm:IntermodalOnlyStations>
     <pcm:RoutingPreference>Practical</pcm:RoutingPreference>
     <pcm:AmtrakRoutes>true</pcm:AmtrakRoutes>
     <pcm:DistUnit>Miles</pcm:DistUnit>
   </pcm:Options>
 <pcm:Report>KeyStation</pcm:Report>
</pcm:GetRouteReport>
<pcm:GetRouteReport>
<pcm:Stops>

◆ GeocodeStation()

GeocodeResponse GeocodeStation ( Station  Location,
GeocodeOptions  Options 
)

GeocodeStation API for locating rail freight station(s).

Parameters
LocationStation to geocode.
Options(Optional) Geocoding options.
Returns
GeocodeResponse containing a list of GeocodeInfo
SOAP Body Example:
<pcm:GeocodeStation>
  <pcm:Location>
     <pcm:Format>StationState</pcm:Format>
     <pcm:Name>D* CO</pcm:Name>
     <pcm:Railroad></pcm:Railroad>
   </pcm:Location>
   <pcm:Options>
   <pcm:TerminalSwitching>true</pcm:TerminalSwitching>
   <pcm:IntermodalOnlyStations>true</pcm:IntermodalOnlyStations>
  </pcm:Options>
</pcm:GeocodeStation>