CM Web Service

Click here for a complete list of operations.

InsertPrivateHireMovement

Insert a Private Hire 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/InsertPrivateHireMovement"

<?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>
    <InsertPrivateHireMovement xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <PrivateHireMovement>
        <PrivateHireMovementID>int</PrivateHireMovementID>
        <PrivateHireID>int</PrivateHireID>
        <MovementDescription>string</MovementDescription>
        <StartDateTime>string</StartDateTime>
        <StartBaseSerialNo>int</StartBaseSerialNo>
        <PositionDateTime>string</PositionDateTime>
        <PickupDateTime>string</PickupDateTime>
        <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>
        <ArrivalDateTime>string</ArrivalDateTime>
        <LeaveDateTime>string</LeaveDateTime>
        <BackDateTime>string</BackDateTime>
        <FinishDateTime>string</FinishDateTime>
        <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>
        <PrivateHireMovementPrice>decimal</PrivateHireMovementPrice>
        <PrivateHireMovementVAT>decimal</PrivateHireMovementVAT>
        <PrivateHireMovementTotal>decimal</PrivateHireMovementTotal>
        <DateCreated>string</DateCreated>
        <LastUpdated>string</LastUpdated>
        <Cancelled>boolean</Cancelled>
        <PrivateHireVehicles>
          <PrivateHireVehicle>
            <PrivateHireVehicleID>int</PrivateHireVehicleID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Seats>short</Seats>
            <VehicleType>string</VehicleType>
            <Price>decimal</Price>
            <VATCode>short</VATCode>
            <VATPercentage>decimal</VATPercentage>
            <VAT>decimal</VAT>
            <Total>decimal</Total>
            <NominalCode>string</NominalCode>
            <VehicleID>string</VehicleID>
            <PrivateHireDrivers xsi:nil="true" />
          </PrivateHireVehicle>
          <PrivateHireVehicle>
            <PrivateHireVehicleID>int</PrivateHireVehicleID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Seats>short</Seats>
            <VehicleType>string</VehicleType>
            <Price>decimal</Price>
            <VATCode>short</VATCode>
            <VATPercentage>decimal</VATPercentage>
            <VAT>decimal</VAT>
            <Total>decimal</Total>
            <NominalCode>string</NominalCode>
            <VehicleID>string</VehicleID>
            <PrivateHireDrivers xsi:nil="true" />
          </PrivateHireVehicle>
        </PrivateHireVehicles>
        <PrivateHirePickups>
          <PrivateHirePickup>
            <PrivateHirePickupID>int</PrivateHirePickupID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <PickupPoint>string</PickupPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <PickupDayNo>short</PickupDayNo>
            <PickupTime>string</PickupTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </PrivateHirePickup>
          <PrivateHirePickup>
            <PrivateHirePickupID>int</PrivateHirePickupID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <PickupPoint>string</PickupPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <PickupDayNo>short</PickupDayNo>
            <PickupTime>string</PickupTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </PrivateHirePickup>
        </PrivateHirePickups>
        <PrivateHireSetdowns>
          <PrivateHireSetdown>
            <PrivateHireSetdownID>int</PrivateHireSetdownID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <SetdownPoint>string</SetdownPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <SetdownDayNo>short</SetdownDayNo>
            <SetdownTime>string</SetdownTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </PrivateHireSetdown>
          <PrivateHireSetdown>
            <PrivateHireSetdownID>int</PrivateHireSetdownID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <SetdownPoint>string</SetdownPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <SetdownDayNo>short</SetdownDayNo>
            <SetdownTime>string</SetdownTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </PrivateHireSetdown>
        </PrivateHireSetdowns>
        <PrivateHireFacilities>
          <PrivateHireFacility>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Facility>string</Facility>
          </PrivateHireFacility>
          <PrivateHireFacility>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Facility>string</Facility>
          </PrivateHireFacility>
        </PrivateHireFacilities>
        <PrivateHireIncludedItems>
          <PrivateHireIncludedItem>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Item>string</Item>
            <Included>boolean</Included>
            <Excluded>boolean</Excluded>
          </PrivateHireIncludedItem>
          <PrivateHireIncludedItem>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Item>string</Item>
            <Included>boolean</Included>
            <Excluded>boolean</Excluded>
          </PrivateHireIncludedItem>
        </PrivateHireIncludedItems>
        <PrivateHireExtras>
          <PrivateHireExtra>
            <PrivateHireExtraID>int</PrivateHireExtraID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Quantity>decimal</Quantity>
            <Description>string</Description>
            <UnitPrice>decimal</UnitPrice>
            <Price>decimal</Price>
            <VATCode>short</VATCode>
            <VAT>decimal</VAT>
            <VATPercentage>decimal</VATPercentage>
            <Total>decimal</Total>
            <NominalCode>string</NominalCode>
            <Revenue>boolean</Revenue>
          </PrivateHireExtra>
          <PrivateHireExtra>
            <PrivateHireExtraID>int</PrivateHireExtraID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Quantity>decimal</Quantity>
            <Description>string</Description>
            <UnitPrice>decimal</UnitPrice>
            <Price>decimal</Price>
            <VATCode>short</VATCode>
            <VAT>decimal</VAT>
            <VATPercentage>decimal</VATPercentage>
            <Total>decimal</Total>
            <NominalCode>string</NominalCode>
            <Revenue>boolean</Revenue>
          </PrivateHireExtra>
        </PrivateHireExtras>
        <PrivateHireMovementData>
          <PrivateHireMovementData>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <PrivateHireMovementDataTitleSerialNo>int</PrivateHireMovementDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </PrivateHireMovementData>
          <PrivateHireMovementData>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <PrivateHireMovementDataTitleSerialNo>int</PrivateHireMovementDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </PrivateHireMovementData>
        </PrivateHireMovementData>
      </PrivateHireMovement>
      <OperatorID>string</OperatorID>
    </InsertPrivateHireMovement>
  </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>
    <InsertPrivateHireMovementResponse xmlns="http://coachmanager.com/">
      <InsertPrivateHireMovementResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <PrivateHireMovementID>int</PrivateHireMovementID>
      </InsertPrivateHireMovementResult>
    </InsertPrivateHireMovementResponse>
  </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>
    <InsertPrivateHireMovement xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <PrivateHireMovement>
        <PrivateHireMovementID>int</PrivateHireMovementID>
        <PrivateHireID>int</PrivateHireID>
        <MovementDescription>string</MovementDescription>
        <StartDateTime>string</StartDateTime>
        <StartBaseSerialNo>int</StartBaseSerialNo>
        <PositionDateTime>string</PositionDateTime>
        <PickupDateTime>string</PickupDateTime>
        <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>
        <ArrivalDateTime>string</ArrivalDateTime>
        <LeaveDateTime>string</LeaveDateTime>
        <BackDateTime>string</BackDateTime>
        <FinishDateTime>string</FinishDateTime>
        <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>
        <PrivateHireMovementPrice>decimal</PrivateHireMovementPrice>
        <PrivateHireMovementVAT>decimal</PrivateHireMovementVAT>
        <PrivateHireMovementTotal>decimal</PrivateHireMovementTotal>
        <DateCreated>string</DateCreated>
        <LastUpdated>string</LastUpdated>
        <Cancelled>boolean</Cancelled>
        <PrivateHireVehicles>
          <PrivateHireVehicle>
            <PrivateHireVehicleID>int</PrivateHireVehicleID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Seats>short</Seats>
            <VehicleType>string</VehicleType>
            <Price>decimal</Price>
            <VATCode>short</VATCode>
            <VATPercentage>decimal</VATPercentage>
            <VAT>decimal</VAT>
            <Total>decimal</Total>
            <NominalCode>string</NominalCode>
            <VehicleID>string</VehicleID>
            <PrivateHireDrivers xsi:nil="true" />
          </PrivateHireVehicle>
          <PrivateHireVehicle>
            <PrivateHireVehicleID>int</PrivateHireVehicleID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Seats>short</Seats>
            <VehicleType>string</VehicleType>
            <Price>decimal</Price>
            <VATCode>short</VATCode>
            <VATPercentage>decimal</VATPercentage>
            <VAT>decimal</VAT>
            <Total>decimal</Total>
            <NominalCode>string</NominalCode>
            <VehicleID>string</VehicleID>
            <PrivateHireDrivers xsi:nil="true" />
          </PrivateHireVehicle>
        </PrivateHireVehicles>
        <PrivateHirePickups>
          <PrivateHirePickup>
            <PrivateHirePickupID>int</PrivateHirePickupID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <PickupPoint>string</PickupPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <PickupDayNo>short</PickupDayNo>
            <PickupTime>string</PickupTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </PrivateHirePickup>
          <PrivateHirePickup>
            <PrivateHirePickupID>int</PrivateHirePickupID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <PickupPoint>string</PickupPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <PickupDayNo>short</PickupDayNo>
            <PickupTime>string</PickupTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </PrivateHirePickup>
        </PrivateHirePickups>
        <PrivateHireSetdowns>
          <PrivateHireSetdown>
            <PrivateHireSetdownID>int</PrivateHireSetdownID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <SetdownPoint>string</SetdownPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <SetdownDayNo>short</SetdownDayNo>
            <SetdownTime>string</SetdownTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </PrivateHireSetdown>
          <PrivateHireSetdown>
            <PrivateHireSetdownID>int</PrivateHireSetdownID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <SetdownPoint>string</SetdownPoint>
            <ArrivalDayNo>short</ArrivalDayNo>
            <ArrivalTime>string</ArrivalTime>
            <SetdownDayNo>short</SetdownDayNo>
            <SetdownTime>string</SetdownTime>
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Instructions>string</Instructions>
          </PrivateHireSetdown>
        </PrivateHireSetdowns>
        <PrivateHireFacilities>
          <PrivateHireFacility>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Facility>string</Facility>
          </PrivateHireFacility>
          <PrivateHireFacility>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Facility>string</Facility>
          </PrivateHireFacility>
        </PrivateHireFacilities>
        <PrivateHireIncludedItems>
          <PrivateHireIncludedItem>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Item>string</Item>
            <Included>boolean</Included>
            <Excluded>boolean</Excluded>
          </PrivateHireIncludedItem>
          <PrivateHireIncludedItem>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Item>string</Item>
            <Included>boolean</Included>
            <Excluded>boolean</Excluded>
          </PrivateHireIncludedItem>
        </PrivateHireIncludedItems>
        <PrivateHireExtras>
          <PrivateHireExtra>
            <PrivateHireExtraID>int</PrivateHireExtraID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Quantity>decimal</Quantity>
            <Description>string</Description>
            <UnitPrice>decimal</UnitPrice>
            <Price>decimal</Price>
            <VATCode>short</VATCode>
            <VAT>decimal</VAT>
            <VATPercentage>decimal</VATPercentage>
            <Total>decimal</Total>
            <NominalCode>string</NominalCode>
            <Revenue>boolean</Revenue>
          </PrivateHireExtra>
          <PrivateHireExtra>
            <PrivateHireExtraID>int</PrivateHireExtraID>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <Quantity>decimal</Quantity>
            <Description>string</Description>
            <UnitPrice>decimal</UnitPrice>
            <Price>decimal</Price>
            <VATCode>short</VATCode>
            <VAT>decimal</VAT>
            <VATPercentage>decimal</VATPercentage>
            <Total>decimal</Total>
            <NominalCode>string</NominalCode>
            <Revenue>boolean</Revenue>
          </PrivateHireExtra>
        </PrivateHireExtras>
        <PrivateHireMovementData>
          <PrivateHireMovementData>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <PrivateHireMovementDataTitleSerialNo>int</PrivateHireMovementDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </PrivateHireMovementData>
          <PrivateHireMovementData>
            <PrivateHireMovementID>int</PrivateHireMovementID>
            <PrivateHireMovementDataTitleSerialNo>int</PrivateHireMovementDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </PrivateHireMovementData>
        </PrivateHireMovementData>
      </PrivateHireMovement>
      <OperatorID>string</OperatorID>
    </InsertPrivateHireMovement>
  </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>
    <InsertPrivateHireMovementResponse xmlns="http://coachmanager.com/">
      <InsertPrivateHireMovementResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <PrivateHireMovementID>int</PrivateHireMovementID>
      </InsertPrivateHireMovementResult>
    </InsertPrivateHireMovementResponse>
  </soap12:Body>
</soap12:Envelope>