CM Web Service

Click here for a complete list of operations.

InsertPrivateHire

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

<?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>
    <InsertPrivateHire xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <PrivateHire>
        <PrivateHireID>int</PrivateHireID>
        <ClientID>string</ClientID>
        <BookingType>string</BookingType>
        <CompanyID>string</CompanyID>
        <BaseSerialNo>int</BaseSerialNo>
        <OperatorID>string</OperatorID>
        <PrivateHireStatus>Quotation or Provisional or Firm</PrivateHireStatus>
        <HoldInvoice>boolean</HoldInvoice>
        <DepositRequested>decimal</DepositRequested>
        <PrivateHirePrice>decimal</PrivateHirePrice>
        <PrivateHireVAT>decimal</PrivateHireVAT>
        <PrivateHireTotal>decimal</PrivateHireTotal>
        <QuotationID>int</QuotationID>
        <DateCreated>string</DateCreated>
        <InvoicedAmount>decimal</InvoicedAmount>
        <RecievedAmount>decimal</RecievedAmount>
        <OutstandingAmount>decimal</OutstandingAmount>
        <LastInvoiceNo>string</LastInvoiceNo>
        <LastInvoicedDate>string</LastInvoicedDate>
        <TermsOfTrade>string</TermsOfTrade>
        <LastConfirmationDate>string</LastConfirmationDate>
        <CombinedInvoice>boolean</CombinedInvoice>
        <Cancelled>boolean</Cancelled>
        <PrivateHireMovements>
          <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 xsi:nil="true" />
            <PrivateHirePickups xsi:nil="true" />
            <PrivateHireSetdowns xsi:nil="true" />
            <PrivateHireFacilities xsi:nil="true" />
            <PrivateHireIncludedItems xsi:nil="true" />
            <PrivateHireExtras xsi:nil="true" />
            <PrivateHireMovementData xsi:nil="true" />
          </PrivateHireMovement>
          <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 xsi:nil="true" />
            <PrivateHirePickups xsi:nil="true" />
            <PrivateHireSetdowns xsi:nil="true" />
            <PrivateHireFacilities xsi:nil="true" />
            <PrivateHireIncludedItems xsi:nil="true" />
            <PrivateHireExtras xsi:nil="true" />
            <PrivateHireMovementData xsi:nil="true" />
          </PrivateHireMovement>
        </PrivateHireMovements>
        <PrivateHireData>
          <PrivateHireData>
            <PrivateHireID>int</PrivateHireID>
            <PrivateHireDataTitleSerialNo>int</PrivateHireDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </PrivateHireData>
          <PrivateHireData>
            <PrivateHireID>int</PrivateHireID>
            <PrivateHireDataTitleSerialNo>int</PrivateHireDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </PrivateHireData>
        </PrivateHireData>
      </PrivateHire>
    </InsertPrivateHire>
  </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>
    <InsertPrivateHireResponse xmlns="http://coachmanager.com/">
      <InsertPrivateHireResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <PrivateHireID>int</PrivateHireID>
        <PrivateHireMovementIDs>
          <int>int</int>
          <int>int</int>
        </PrivateHireMovementIDs>
      </InsertPrivateHireResult>
    </InsertPrivateHireResponse>
  </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>
    <InsertPrivateHire xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <PrivateHire>
        <PrivateHireID>int</PrivateHireID>
        <ClientID>string</ClientID>
        <BookingType>string</BookingType>
        <CompanyID>string</CompanyID>
        <BaseSerialNo>int</BaseSerialNo>
        <OperatorID>string</OperatorID>
        <PrivateHireStatus>Quotation or Provisional or Firm</PrivateHireStatus>
        <HoldInvoice>boolean</HoldInvoice>
        <DepositRequested>decimal</DepositRequested>
        <PrivateHirePrice>decimal</PrivateHirePrice>
        <PrivateHireVAT>decimal</PrivateHireVAT>
        <PrivateHireTotal>decimal</PrivateHireTotal>
        <QuotationID>int</QuotationID>
        <DateCreated>string</DateCreated>
        <InvoicedAmount>decimal</InvoicedAmount>
        <RecievedAmount>decimal</RecievedAmount>
        <OutstandingAmount>decimal</OutstandingAmount>
        <LastInvoiceNo>string</LastInvoiceNo>
        <LastInvoicedDate>string</LastInvoicedDate>
        <TermsOfTrade>string</TermsOfTrade>
        <LastConfirmationDate>string</LastConfirmationDate>
        <CombinedInvoice>boolean</CombinedInvoice>
        <Cancelled>boolean</Cancelled>
        <PrivateHireMovements>
          <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 xsi:nil="true" />
            <PrivateHirePickups xsi:nil="true" />
            <PrivateHireSetdowns xsi:nil="true" />
            <PrivateHireFacilities xsi:nil="true" />
            <PrivateHireIncludedItems xsi:nil="true" />
            <PrivateHireExtras xsi:nil="true" />
            <PrivateHireMovementData xsi:nil="true" />
          </PrivateHireMovement>
          <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 xsi:nil="true" />
            <PrivateHirePickups xsi:nil="true" />
            <PrivateHireSetdowns xsi:nil="true" />
            <PrivateHireFacilities xsi:nil="true" />
            <PrivateHireIncludedItems xsi:nil="true" />
            <PrivateHireExtras xsi:nil="true" />
            <PrivateHireMovementData xsi:nil="true" />
          </PrivateHireMovement>
        </PrivateHireMovements>
        <PrivateHireData>
          <PrivateHireData>
            <PrivateHireID>int</PrivateHireID>
            <PrivateHireDataTitleSerialNo>int</PrivateHireDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </PrivateHireData>
          <PrivateHireData>
            <PrivateHireID>int</PrivateHireID>
            <PrivateHireDataTitleSerialNo>int</PrivateHireDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </PrivateHireData>
        </PrivateHireData>
      </PrivateHire>
    </InsertPrivateHire>
  </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>
    <InsertPrivateHireResponse xmlns="http://coachmanager.com/">
      <InsertPrivateHireResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <PrivateHireID>int</PrivateHireID>
        <PrivateHireMovementIDs>
          <int>int</int>
          <int>int</int>
        </PrivateHireMovementIDs>
      </InsertPrivateHireResult>
    </InsertPrivateHireResponse>
  </soap12:Body>
</soap12:Envelope>