CM Web Service

Click here for a complete list of operations.

InsertContractMovement

Insert a Contract Movement into Coach Manager

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 /CM.asmx HTTP/1.1
Host: cmapi.pinnaclecoachlines.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://coachmanager.com/InsertContractMovement"

<?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>
    <InsertContractMovement xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <ContractMovement>
        <ContractMovementID>int</ContractMovementID>
        <ContractID>int</ContractID>
        <MovementDescription>string</MovementDescription>
        <StartBaseSerialNo>int</StartBaseSerialNo>
        <StartTime>string</StartTime>
        <PositionDay>short</PositionDay>
        <PositionTime>string</PositionTime>
        <PickupDay>short</PickupDay>
        <PickupTime>string</PickupTime>
        <Pickup>string</Pickup>
        <PickupLatitude>string</PickupLatitude>
        <PickupLongitude>string</PickupLongitude>
        <PickupInstructions>string</PickupInstructions>
        <SingleJourney>boolean</SingleJourney>
        <VehicleToStay>boolean</VehicleToStay>
        <Destination>string</Destination>
        <DestinationLatitude>string</DestinationLatitude>
        <DestinationLongitude>string</DestinationLongitude>
        <DestinationInstructions>string</DestinationInstructions>
        <ArrivalDay>short</ArrivalDay>
        <ArrivalTime>string</ArrivalTime>
        <LeaveDay>short</LeaveDay>
        <LeaveTime>string</LeaveTime>
        <BackDay>short</BackDay>
        <BackTime>string</BackTime>
        <FinishDay>short</FinishDay>
        <FinishTime>string</FinishTime>
        <FinishBaseSerialNo>int</FinishBaseSerialNo>
        <Passengers>short</Passengers>
        <Distance>string</Distance>
        <EmptyDistance>string</EmptyDistance>
        <ClientReference1>string</ClientReference1>
        <ClientReference2>string</ClientReference2>
        <Route>string</Route>
        <FurtherRequirements>string</FurtherRequirements>
        <Notes>string</Notes>
        <LastUpdated>string</LastUpdated>
        <Cancelled>boolean</Cancelled>
        <ContractDates>
          <ContractDate>
            <StartDate>string</StartDate>
            <ContractMovementID>int</ContractMovementID>
          </ContractDate>
          <ContractDate>
            <StartDate>string</StartDate>
            <ContractMovementID>int</ContractMovementID>
          </ContractDate>
        </ContractDates>
        <ContractVehicles>
          <ContractVehicle>
            <ContractVehicleID>int</ContractVehicleID>
            <ContractMovementID>int</ContractMovementID>
            <Seats>short</Seats>
            <VehicleType>string</VehicleType>
            <Revenue>decimal</Revenue>
            <DefaultVehicleID>string</DefaultVehicleID>
            <ContractDrivers xsi:nil="true" />
          </ContractVehicle>
          <ContractVehicle>
            <ContractVehicleID>int</ContractVehicleID>
            <ContractMovementID>int</ContractMovementID>
            <Seats>short</Seats>
            <VehicleType>string</VehicleType>
            <Revenue>decimal</Revenue>
            <DefaultVehicleID>string</DefaultVehicleID>
            <ContractDrivers xsi:nil="true" />
          </ContractVehicle>
        </ContractVehicles>
        <ContractPickups>
          <ContractPickup>
            <ContractPickupID>int</ContractPickupID>
            <ContractMovementID>int</ContractMovementID>
            <PickupPoint>string</PickupPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <PickupDayNo>short</PickupDayNo>
            <PickupTime>string</PickupTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </ContractPickup>
          <ContractPickup>
            <ContractPickupID>int</ContractPickupID>
            <ContractMovementID>int</ContractMovementID>
            <PickupPoint>string</PickupPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <PickupDayNo>short</PickupDayNo>
            <PickupTime>string</PickupTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </ContractPickup>
        </ContractPickups>
        <ContractSetdowns>
          <ContractSetdown>
            <ContractSetdownID>int</ContractSetdownID>
            <ContractMovementID>int</ContractMovementID>
            <SetdownPoint>string</SetdownPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <SetdownDayNo>short</SetdownDayNo>
            <SetdownTime>string</SetdownTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </ContractSetdown>
          <ContractSetdown>
            <ContractSetdownID>int</ContractSetdownID>
            <ContractMovementID>int</ContractMovementID>
            <SetdownPoint>string</SetdownPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <SetdownDayNo>short</SetdownDayNo>
            <SetdownTime>string</SetdownTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </ContractSetdown>
        </ContractSetdowns>
        <ContractFacilities>
          <ContractFacility>
            <ContractMovementID>int</ContractMovementID>
            <Facility>string</Facility>
          </ContractFacility>
          <ContractFacility>
            <ContractMovementID>int</ContractMovementID>
            <Facility>string</Facility>
          </ContractFacility>
        </ContractFacilities>
        <ContractIncludedItems>
          <ContractIncludedItem>
            <ContractMovementID>int</ContractMovementID>
            <Item>string</Item>
            <Included>boolean</Included>
            <Excluded>boolean</Excluded>
          </ContractIncludedItem>
          <ContractIncludedItem>
            <ContractMovementID>int</ContractMovementID>
            <Item>string</Item>
            <Included>boolean</Included>
            <Excluded>boolean</Excluded>
          </ContractIncludedItem>
        </ContractIncludedItems>
        <ContractMovementData>
          <ContractMovementData>
            <ContractMovementID>int</ContractMovementID>
            <ContractMovementDataTitleSerialNo>int</ContractMovementDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </ContractMovementData>
          <ContractMovementData>
            <ContractMovementID>int</ContractMovementID>
            <ContractMovementDataTitleSerialNo>int</ContractMovementDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </ContractMovementData>
        </ContractMovementData>
      </ContractMovement>
      <OperatorID>string</OperatorID>
    </InsertContractMovement>
  </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>
    <InsertContractMovementResponse xmlns="http://coachmanager.com/">
      <InsertContractMovementResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <ContractMovementID>int</ContractMovementID>
      </InsertContractMovementResult>
    </InsertContractMovementResponse>
  </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 /CM.asmx HTTP/1.1
Host: cmapi.pinnaclecoachlines.com.au
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>
    <InsertContractMovement xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <ContractMovement>
        <ContractMovementID>int</ContractMovementID>
        <ContractID>int</ContractID>
        <MovementDescription>string</MovementDescription>
        <StartBaseSerialNo>int</StartBaseSerialNo>
        <StartTime>string</StartTime>
        <PositionDay>short</PositionDay>
        <PositionTime>string</PositionTime>
        <PickupDay>short</PickupDay>
        <PickupTime>string</PickupTime>
        <Pickup>string</Pickup>
        <PickupLatitude>string</PickupLatitude>
        <PickupLongitude>string</PickupLongitude>
        <PickupInstructions>string</PickupInstructions>
        <SingleJourney>boolean</SingleJourney>
        <VehicleToStay>boolean</VehicleToStay>
        <Destination>string</Destination>
        <DestinationLatitude>string</DestinationLatitude>
        <DestinationLongitude>string</DestinationLongitude>
        <DestinationInstructions>string</DestinationInstructions>
        <ArrivalDay>short</ArrivalDay>
        <ArrivalTime>string</ArrivalTime>
        <LeaveDay>short</LeaveDay>
        <LeaveTime>string</LeaveTime>
        <BackDay>short</BackDay>
        <BackTime>string</BackTime>
        <FinishDay>short</FinishDay>
        <FinishTime>string</FinishTime>
        <FinishBaseSerialNo>int</FinishBaseSerialNo>
        <Passengers>short</Passengers>
        <Distance>string</Distance>
        <EmptyDistance>string</EmptyDistance>
        <ClientReference1>string</ClientReference1>
        <ClientReference2>string</ClientReference2>
        <Route>string</Route>
        <FurtherRequirements>string</FurtherRequirements>
        <Notes>string</Notes>
        <LastUpdated>string</LastUpdated>
        <Cancelled>boolean</Cancelled>
        <ContractDates>
          <ContractDate>
            <StartDate>string</StartDate>
            <ContractMovementID>int</ContractMovementID>
          </ContractDate>
          <ContractDate>
            <StartDate>string</StartDate>
            <ContractMovementID>int</ContractMovementID>
          </ContractDate>
        </ContractDates>
        <ContractVehicles>
          <ContractVehicle>
            <ContractVehicleID>int</ContractVehicleID>
            <ContractMovementID>int</ContractMovementID>
            <Seats>short</Seats>
            <VehicleType>string</VehicleType>
            <Revenue>decimal</Revenue>
            <DefaultVehicleID>string</DefaultVehicleID>
            <ContractDrivers xsi:nil="true" />
          </ContractVehicle>
          <ContractVehicle>
            <ContractVehicleID>int</ContractVehicleID>
            <ContractMovementID>int</ContractMovementID>
            <Seats>short</Seats>
            <VehicleType>string</VehicleType>
            <Revenue>decimal</Revenue>
            <DefaultVehicleID>string</DefaultVehicleID>
            <ContractDrivers xsi:nil="true" />
          </ContractVehicle>
        </ContractVehicles>
        <ContractPickups>
          <ContractPickup>
            <ContractPickupID>int</ContractPickupID>
            <ContractMovementID>int</ContractMovementID>
            <PickupPoint>string</PickupPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <PickupDayNo>short</PickupDayNo>
            <PickupTime>string</PickupTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </ContractPickup>
          <ContractPickup>
            <ContractPickupID>int</ContractPickupID>
            <ContractMovementID>int</ContractMovementID>
            <PickupPoint>string</PickupPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <PickupDayNo>short</PickupDayNo>
            <PickupTime>string</PickupTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </ContractPickup>
        </ContractPickups>
        <ContractSetdowns>
          <ContractSetdown>
            <ContractSetdownID>int</ContractSetdownID>
            <ContractMovementID>int</ContractMovementID>
            <SetdownPoint>string</SetdownPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <SetdownDayNo>short</SetdownDayNo>
            <SetdownTime>string</SetdownTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </ContractSetdown>
          <ContractSetdown>
            <ContractSetdownID>int</ContractSetdownID>
            <ContractMovementID>int</ContractMovementID>
            <SetdownPoint>string</SetdownPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <SetdownDayNo>short</SetdownDayNo>
            <SetdownTime>string</SetdownTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </ContractSetdown>
        </ContractSetdowns>
        <ContractFacilities>
          <ContractFacility>
            <ContractMovementID>int</ContractMovementID>
            <Facility>string</Facility>
          </ContractFacility>
          <ContractFacility>
            <ContractMovementID>int</ContractMovementID>
            <Facility>string</Facility>
          </ContractFacility>
        </ContractFacilities>
        <ContractIncludedItems>
          <ContractIncludedItem>
            <ContractMovementID>int</ContractMovementID>
            <Item>string</Item>
            <Included>boolean</Included>
            <Excluded>boolean</Excluded>
          </ContractIncludedItem>
          <ContractIncludedItem>
            <ContractMovementID>int</ContractMovementID>
            <Item>string</Item>
            <Included>boolean</Included>
            <Excluded>boolean</Excluded>
          </ContractIncludedItem>
        </ContractIncludedItems>
        <ContractMovementData>
          <ContractMovementData>
            <ContractMovementID>int</ContractMovementID>
            <ContractMovementDataTitleSerialNo>int</ContractMovementDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </ContractMovementData>
          <ContractMovementData>
            <ContractMovementID>int</ContractMovementID>
            <ContractMovementDataTitleSerialNo>int</ContractMovementDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </ContractMovementData>
        </ContractMovementData>
      </ContractMovement>
      <OperatorID>string</OperatorID>
    </InsertContractMovement>
  </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>
    <InsertContractMovementResponse xmlns="http://coachmanager.com/">
      <InsertContractMovementResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <ContractMovementID>int</ContractMovementID>
      </InsertContractMovementResult>
    </InsertContractMovementResponse>
  </soap12:Body>
</soap12:Envelope>