XTourWSService Web Service

XTourWSService

Click here for a complete list of operations.

planSequence

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/planSequence"

<?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>
    <planSequence xmlns="http://soap.locatienet.com">
      <arrayOfSequencingTransportOrder>
        <SequencingTransportOrder />
        <SequencingTransportOrder />
      </arrayOfSequencingTransportOrder>
      <arrayOfDepot>
        <Depot />
        <Depot />
      </arrayOfDepot>
      <sequencingVehicle />
      <sequencingParams availableMachineTime="int" fixedEndTransportPoints="int" fixedStartTransportPoints="int" maximumNumberOfUnscheduledOrdersToBeAnalyzed="int" />
      <sequencingPlan>
        <result remainingPeriods="string" 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>
          <wrappedTourEvents>
            <TourEvent xsi:nil="true" />
            <TourEvent xsi:nil="true" />
          </wrappedTourEvents>
          <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>
        </result>
        <tour xmlns="http://xtour.xserver.ptvag.com">
          <result />
          <wrappedTourPoints>
            <SequencingTourPoint xsi:nil="true" />
            <SequencingTourPoint xsi:nil="true" />
          </wrappedTourPoints>
        </tour>
      </sequencingPlan>
      <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>
    </planSequence>
  </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>
    <planSequenceResponse xmlns="http://soap.locatienet.com">
      <planSequenceResult>
        <result remainingPeriods="string" 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>
          <wrappedTourEvents>
            <TourEvent xsi:nil="true" />
            <TourEvent xsi:nil="true" />
          </wrappedTourEvents>
          <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>
        </result>
        <tour xmlns="http://xtour.xserver.ptvag.com">
          <result />
          <wrappedTourPoints>
            <SequencingTourPoint xsi:nil="true" />
            <SequencingTourPoint xsi:nil="true" />
          </wrappedTourPoints>
        </tour>
      </planSequenceResult>
    </planSequenceResponse>
  </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>
    <planSequence xmlns="http://soap.locatienet.com">
      <arrayOfSequencingTransportOrder>
        <SequencingTransportOrder />
        <SequencingTransportOrder />
      </arrayOfSequencingTransportOrder>
      <arrayOfDepot>
        <Depot />
        <Depot />
      </arrayOfDepot>
      <sequencingVehicle />
      <sequencingParams availableMachineTime="int" fixedEndTransportPoints="int" fixedStartTransportPoints="int" maximumNumberOfUnscheduledOrdersToBeAnalyzed="int" />
      <sequencingPlan>
        <result remainingPeriods="string" 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>
          <wrappedTourEvents>
            <TourEvent xsi:nil="true" />
            <TourEvent xsi:nil="true" />
          </wrappedTourEvents>
          <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>
        </result>
        <tour xmlns="http://xtour.xserver.ptvag.com">
          <result />
          <wrappedTourPoints>
            <SequencingTourPoint xsi:nil="true" />
            <SequencingTourPoint xsi:nil="true" />
          </wrappedTourPoints>
        </tour>
      </sequencingPlan>
      <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>
    </planSequence>
  </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>
    <planSequenceResponse xmlns="http://soap.locatienet.com">
      <planSequenceResult>
        <result remainingPeriods="string" 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>
          <wrappedTourEvents>
            <TourEvent xsi:nil="true" />
            <TourEvent xsi:nil="true" />
          </wrappedTourEvents>
          <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>
        </result>
        <tour xmlns="http://xtour.xserver.ptvag.com">
          <result />
          <wrappedTourPoints>
            <SequencingTourPoint xsi:nil="true" />
            <SequencingTourPoint xsi:nil="true" />
          </wrappedTourPoints>
        </tour>
      </planSequenceResult>
    </planSequenceResponse>
  </soap12:Body>
</soap12:Envelope>