XTourWSService
Click here for a complete list of operations.
planBasicTours
Test
The test form is only available for requests from the local machine.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 /0.1/xtour/ws/xtour.asmx HTTP/1.1 Host: soap.locatienet.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://soap.locatienet.com/planBasicTours" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ServiceAuthenticateInformation xmlns="http://soap.locatienet.com"> <UserName>string</UserName> <Password>string</Password> <ConfigFilePath>string</ConfigFilePath> <OverrideLinkType>boolean</OverrideLinkType> <ClientId>int</ClientId> </ServiceAuthenticateInformation> </soap:Header> <soap:Body> <planBasicTours xmlns="http://soap.locatienet.com"> <arrayOfTransportOrder> <TransportOrder areaNumber="int" trailerLoadingForbidden="boolean" vehicleId="int"> <maxLoadingArea height="int" length="int" weight="int" width="int" xmlns="http://xtour.xserver.ptvag.com" /> <minLoadingArea height="int" length="int" weight="int" width="int" xmlns="http://xtour.xserver.ptvag.com" /> <wrappedVehicleCategories xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleCategories> <wrappedVehicleExclusions xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleExclusions> <wrappedVehicleRequirements xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleRequirements> </TransportOrder> <TransportOrder areaNumber="int" trailerLoadingForbidden="boolean" vehicleId="int"> <maxLoadingArea height="int" length="int" weight="int" width="int" xmlns="http://xtour.xserver.ptvag.com" /> <minLoadingArea height="int" length="int" weight="int" width="int" xmlns="http://xtour.xserver.ptvag.com" /> <wrappedVehicleCategories xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleCategories> <wrappedVehicleExclusions xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleExclusions> <wrappedVehicleRequirements xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleRequirements> </TransportOrder> </arrayOfTransportOrder> <arrayOfDepot> <Depot /> <Depot /> </arrayOfDepot> <fleet> <wrappedTrailers xmlns="http://xtour.xserver.ptvag.com"> <Trailer description="string" id="int" /> <Trailer description="string" id="int" /> </wrappedTrailers> <wrappedTrains xmlns="http://xtour.xserver.ptvag.com"> <Train category="int" description="string" dimaId="int" drivingPeriodFactor="double" id="int" maxTransportPointCountPerTour="int"> <capacities xsi:nil="true" /> <costs xsi:nil="true" /> <maxLoadingArea xsi:nil="true" /> <minLoadingArea xsi:nil="true" /> <wrappedTrailerIds xsi:nil="true" /> <wrappedTransportEquipments xsi:nil="true" /> <wrappedVehicleIds xsi:nil="true" /> </Train> <Train category="int" description="string" dimaId="int" drivingPeriodFactor="double" id="int" maxTransportPointCountPerTour="int"> <capacities xsi:nil="true" /> <costs xsi:nil="true" /> <maxLoadingArea xsi:nil="true" /> <minLoadingArea xsi:nil="true" /> <wrappedTrailerIds xsi:nil="true" /> <wrappedTransportEquipments xsi:nil="true" /> <wrappedVehicleIds xsi:nil="true" /> </Train> </wrappedTrains> <wrappedVehicles xmlns="http://xtour.xserver.ptvag.com"> <Vehicle category="int" description="string" id="int" ignoreIntermediatePeriodBeforeFirstTour="boolean" intermediatePeriod="int"> <wrappedAreaNumbers xsi:nil="true" /> <endLocation xsi:nil="true" /> <maxLoadingArea xsi:nil="true" /> <minLoadingArea xsi:nil="true" /> <restrictions xsi:nil="true" /> <startLocation xsi:nil="true" /> <wrappedTransportEquipments xsi:nil="true" /> </Vehicle> <Vehicle category="int" description="string" id="int" ignoreIntermediatePeriodBeforeFirstTour="boolean" intermediatePeriod="int"> <wrappedAreaNumbers xsi:nil="true" /> <endLocation xsi:nil="true" /> <maxLoadingArea xsi:nil="true" /> <minLoadingArea xsi:nil="true" /> <restrictions xsi:nil="true" /> <startLocation xsi:nil="true" /> <wrappedTransportEquipments xsi:nil="true" /> </Vehicle> </wrappedVehicles> </fleet> <planningParams coDriverTransportPointLoadingFactor="double" coDriverTransportPointsInSeparateTours="boolean" directDistanceFactor="double" directVelocity="int" useDirectDistanceFallback="boolean"> <wrappedDistanceMatrixCalculation xmlns="http://xtour.xserver.ptvag.com"> <DistanceMatrixCalculation dimaId="int" /> <DistanceMatrixCalculation dimaId="int" /> </wrappedDistanceMatrixCalculation> <wrappedLoadingFunctions xmlns="http://xtour.xserver.ptvag.com"> <LoadingFunction exponent="int" fixedPeriod="int" fixedSitePeriod="int" id="int" maxPeriod="int"> <quantityDependentPeriods xsi:nil="true" /> </LoadingFunction> <LoadingFunction exponent="int" fixedPeriod="int" fixedSitePeriod="int" id="int" maxPeriod="int"> <quantityDependentPeriods xsi:nil="true" /> </LoadingFunction> </wrappedLoadingFunctions> <wrappedProductIncompatibilities xmlns="http://xtour.xserver.ptvag.com"> <ProductIncompatibility incompatibilityType="NOT_ON_SAME_TOUR or NOT_AT_SAME_TIME" productId1="int" productId2="int" /> <ProductIncompatibility incompatibilityType="NOT_ON_SAME_TOUR or NOT_AT_SAME_TIME" productId1="int" productId2="int" /> </wrappedProductIncompatibilities> <wrappedRegulations xmlns="http://xtour.xserver.ptvag.com"> <RegulationsBase id="int" /> <RegulationsBase id="int" /> </wrappedRegulations> <restrictions maxTourCount="int" maxTransportPointCountPerTour="int" xmlns="http://xtour.xserver.ptvag.com"> <tourRestrictions maxDistance="int" maxDistanceBetweenTransportPoints="int" maxDistanceFromFirstToLastTransportPoint="int" maxDrivingPeriod="int" maxPeriod="int" /> </restrictions> </planningParams> <plan> <wrappedChains xmlns="http://xtour.xserver.ptvag.com"> <Chain vehicleId="int"> <result xsi:nil="true" /> <wrappedTours xsi:nil="true" /> </Chain> <Chain vehicleId="int"> <result xsi:nil="true" /> <wrappedTours xsi:nil="true" /> </Chain> </wrappedChains> <result totalChainCosts="double" totalTourCosts="double" totalTourCount="int" totalTourDistance="int" totalTourDrivingPeriod="int" totalTourPeriod="int" xmlns="http://xtour.xserver.ptvag.com"> <wrappedScheduledOrderIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedScheduledOrderIds> <wrappedScheduledVehicleIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedScheduledVehicleIds> <wrappedUnscheduledOrderAnalysisResults> <UnscheduledOrderAnalysisResult xsi:nil="true" /> <UnscheduledOrderAnalysisResult xsi:nil="true" /> </wrappedUnscheduledOrderAnalysisResults> <wrappedUnscheduledOrderIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedUnscheduledOrderIds> <wrappedUnscheduledVehicleIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedUnscheduledVehicleIds> </result> </plan> <callerContext log1="string" log2="string" log3="string"> <wrappedProperties xmlns="http://baseservices.service.jabba.ptvag.com"> <CallerContextProperty key="string" value="string" /> <CallerContextProperty key="string" value="string" /> </wrappedProperties> </callerContext> </planBasicTours> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <planBasicToursResponse xmlns="http://soap.locatienet.com"> <planBasicToursResult> <wrappedChains xmlns="http://xtour.xserver.ptvag.com"> <Chain vehicleId="int"> <result xsi:nil="true" /> <wrappedTours xsi:nil="true" /> </Chain> <Chain vehicleId="int"> <result xsi:nil="true" /> <wrappedTours xsi:nil="true" /> </Chain> </wrappedChains> <result totalChainCosts="double" totalTourCosts="double" totalTourCount="int" totalTourDistance="int" totalTourDrivingPeriod="int" totalTourPeriod="int" xmlns="http://xtour.xserver.ptvag.com"> <wrappedScheduledOrderIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedScheduledOrderIds> <wrappedScheduledVehicleIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedScheduledVehicleIds> <wrappedUnscheduledOrderAnalysisResults> <UnscheduledOrderAnalysisResult xsi:nil="true" /> <UnscheduledOrderAnalysisResult xsi:nil="true" /> </wrappedUnscheduledOrderAnalysisResults> <wrappedUnscheduledOrderIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedUnscheduledOrderIds> <wrappedUnscheduledVehicleIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedUnscheduledVehicleIds> </result> </planBasicToursResult> </planBasicToursResponse> </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 /0.1/xtour/ws/xtour.asmx HTTP/1.1 Host: soap.locatienet.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Header> <ServiceAuthenticateInformation xmlns="http://soap.locatienet.com"> <UserName>string</UserName> <Password>string</Password> <ConfigFilePath>string</ConfigFilePath> <OverrideLinkType>boolean</OverrideLinkType> <ClientId>int</ClientId> </ServiceAuthenticateInformation> </soap12:Header> <soap12:Body> <planBasicTours xmlns="http://soap.locatienet.com"> <arrayOfTransportOrder> <TransportOrder areaNumber="int" trailerLoadingForbidden="boolean" vehicleId="int"> <maxLoadingArea height="int" length="int" weight="int" width="int" xmlns="http://xtour.xserver.ptvag.com" /> <minLoadingArea height="int" length="int" weight="int" width="int" xmlns="http://xtour.xserver.ptvag.com" /> <wrappedVehicleCategories xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleCategories> <wrappedVehicleExclusions xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleExclusions> <wrappedVehicleRequirements xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleRequirements> </TransportOrder> <TransportOrder areaNumber="int" trailerLoadingForbidden="boolean" vehicleId="int"> <maxLoadingArea height="int" length="int" weight="int" width="int" xmlns="http://xtour.xserver.ptvag.com" /> <minLoadingArea height="int" length="int" weight="int" width="int" xmlns="http://xtour.xserver.ptvag.com" /> <wrappedVehicleCategories xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleCategories> <wrappedVehicleExclusions xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleExclusions> <wrappedVehicleRequirements xmlns="http://xtour.xserver.ptvag.com"> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedVehicleRequirements> </TransportOrder> </arrayOfTransportOrder> <arrayOfDepot> <Depot /> <Depot /> </arrayOfDepot> <fleet> <wrappedTrailers xmlns="http://xtour.xserver.ptvag.com"> <Trailer description="string" id="int" /> <Trailer description="string" id="int" /> </wrappedTrailers> <wrappedTrains xmlns="http://xtour.xserver.ptvag.com"> <Train category="int" description="string" dimaId="int" drivingPeriodFactor="double" id="int" maxTransportPointCountPerTour="int"> <capacities xsi:nil="true" /> <costs xsi:nil="true" /> <maxLoadingArea xsi:nil="true" /> <minLoadingArea xsi:nil="true" /> <wrappedTrailerIds xsi:nil="true" /> <wrappedTransportEquipments xsi:nil="true" /> <wrappedVehicleIds xsi:nil="true" /> </Train> <Train category="int" description="string" dimaId="int" drivingPeriodFactor="double" id="int" maxTransportPointCountPerTour="int"> <capacities xsi:nil="true" /> <costs xsi:nil="true" /> <maxLoadingArea xsi:nil="true" /> <minLoadingArea xsi:nil="true" /> <wrappedTrailerIds xsi:nil="true" /> <wrappedTransportEquipments xsi:nil="true" /> <wrappedVehicleIds xsi:nil="true" /> </Train> </wrappedTrains> <wrappedVehicles xmlns="http://xtour.xserver.ptvag.com"> <Vehicle category="int" description="string" id="int" ignoreIntermediatePeriodBeforeFirstTour="boolean" intermediatePeriod="int"> <wrappedAreaNumbers xsi:nil="true" /> <endLocation xsi:nil="true" /> <maxLoadingArea xsi:nil="true" /> <minLoadingArea xsi:nil="true" /> <restrictions xsi:nil="true" /> <startLocation xsi:nil="true" /> <wrappedTransportEquipments xsi:nil="true" /> </Vehicle> <Vehicle category="int" description="string" id="int" ignoreIntermediatePeriodBeforeFirstTour="boolean" intermediatePeriod="int"> <wrappedAreaNumbers xsi:nil="true" /> <endLocation xsi:nil="true" /> <maxLoadingArea xsi:nil="true" /> <minLoadingArea xsi:nil="true" /> <restrictions xsi:nil="true" /> <startLocation xsi:nil="true" /> <wrappedTransportEquipments xsi:nil="true" /> </Vehicle> </wrappedVehicles> </fleet> <planningParams coDriverTransportPointLoadingFactor="double" coDriverTransportPointsInSeparateTours="boolean" directDistanceFactor="double" directVelocity="int" useDirectDistanceFallback="boolean"> <wrappedDistanceMatrixCalculation xmlns="http://xtour.xserver.ptvag.com"> <DistanceMatrixCalculation dimaId="int" /> <DistanceMatrixCalculation dimaId="int" /> </wrappedDistanceMatrixCalculation> <wrappedLoadingFunctions xmlns="http://xtour.xserver.ptvag.com"> <LoadingFunction exponent="int" fixedPeriod="int" fixedSitePeriod="int" id="int" maxPeriod="int"> <quantityDependentPeriods xsi:nil="true" /> </LoadingFunction> <LoadingFunction exponent="int" fixedPeriod="int" fixedSitePeriod="int" id="int" maxPeriod="int"> <quantityDependentPeriods xsi:nil="true" /> </LoadingFunction> </wrappedLoadingFunctions> <wrappedProductIncompatibilities xmlns="http://xtour.xserver.ptvag.com"> <ProductIncompatibility incompatibilityType="NOT_ON_SAME_TOUR or NOT_AT_SAME_TIME" productId1="int" productId2="int" /> <ProductIncompatibility incompatibilityType="NOT_ON_SAME_TOUR or NOT_AT_SAME_TIME" productId1="int" productId2="int" /> </wrappedProductIncompatibilities> <wrappedRegulations xmlns="http://xtour.xserver.ptvag.com"> <RegulationsBase id="int" /> <RegulationsBase id="int" /> </wrappedRegulations> <restrictions maxTourCount="int" maxTransportPointCountPerTour="int" xmlns="http://xtour.xserver.ptvag.com"> <tourRestrictions maxDistance="int" maxDistanceBetweenTransportPoints="int" maxDistanceFromFirstToLastTransportPoint="int" maxDrivingPeriod="int" maxPeriod="int" /> </restrictions> </planningParams> <plan> <wrappedChains xmlns="http://xtour.xserver.ptvag.com"> <Chain vehicleId="int"> <result xsi:nil="true" /> <wrappedTours xsi:nil="true" /> </Chain> <Chain vehicleId="int"> <result xsi:nil="true" /> <wrappedTours xsi:nil="true" /> </Chain> </wrappedChains> <result totalChainCosts="double" totalTourCosts="double" totalTourCount="int" totalTourDistance="int" totalTourDrivingPeriod="int" totalTourPeriod="int" xmlns="http://xtour.xserver.ptvag.com"> <wrappedScheduledOrderIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedScheduledOrderIds> <wrappedScheduledVehicleIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedScheduledVehicleIds> <wrappedUnscheduledOrderAnalysisResults> <UnscheduledOrderAnalysisResult xsi:nil="true" /> <UnscheduledOrderAnalysisResult xsi:nil="true" /> </wrappedUnscheduledOrderAnalysisResults> <wrappedUnscheduledOrderIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedUnscheduledOrderIds> <wrappedUnscheduledVehicleIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedUnscheduledVehicleIds> </result> </plan> <callerContext log1="string" log2="string" log3="string"> <wrappedProperties xmlns="http://baseservices.service.jabba.ptvag.com"> <CallerContextProperty key="string" value="string" /> <CallerContextProperty key="string" value="string" /> </wrappedProperties> </callerContext> </planBasicTours> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <planBasicToursResponse xmlns="http://soap.locatienet.com"> <planBasicToursResult> <wrappedChains xmlns="http://xtour.xserver.ptvag.com"> <Chain vehicleId="int"> <result xsi:nil="true" /> <wrappedTours xsi:nil="true" /> </Chain> <Chain vehicleId="int"> <result xsi:nil="true" /> <wrappedTours xsi:nil="true" /> </Chain> </wrappedChains> <result totalChainCosts="double" totalTourCosts="double" totalTourCount="int" totalTourDistance="int" totalTourDrivingPeriod="int" totalTourPeriod="int" xmlns="http://xtour.xserver.ptvag.com"> <wrappedScheduledOrderIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedScheduledOrderIds> <wrappedScheduledVehicleIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedScheduledVehicleIds> <wrappedUnscheduledOrderAnalysisResults> <UnscheduledOrderAnalysisResult xsi:nil="true" /> <UnscheduledOrderAnalysisResult xsi:nil="true" /> </wrappedUnscheduledOrderAnalysisResults> <wrappedUnscheduledOrderIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedUnscheduledOrderIds> <wrappedUnscheduledVehicleIds> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> <Int xmlns="http://wrappertypes.service.jabba.ptvag.com">int</Int> </wrappedUnscheduledVehicleIds> </result> </planBasicToursResult> </planBasicToursResponse> </soap12:Body> </soap12:Envelope>