CM Web Service

Click here for a complete list of operations.

PrivateHireSearch

Find Private Hires from 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/PrivateHireSearch"

<?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>
    <PrivateHireSearch xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <PrivateHireSearchDetails>
        <PrivateHireID>int</PrivateHireID>
        <PrivateHireMovementID>int</PrivateHireMovementID>
        <PickupDate>string</PickupDate>
        <PickupDateOperator>GreaterThan or EqualTo or LessThan</PickupDateOperator>
        <Pickup>string</Pickup>
        <Destination>string</Destination>
        <ClientReference1>string</ClientReference1>
        <ClientReference2>string</ClientReference2>
        <ClientID>string</ClientID>
        <Surname>string</Surname>
        <Initials>string</Initials>
        <Company>string</Company>
        <PostCode>string</PostCode>
        <DateCreated>string</DateCreated>
        <DateCreatedOperator>GreaterThan or EqualTo or LessThan</DateCreatedOperator>
        <LastUpdated>string</LastUpdated>
        <LastUpdatedOperator>GreaterThan or EqualTo or LessThan</LastUpdatedOperator>
      </PrivateHireSearchDetails>
    </PrivateHireSearch>
  </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>
    <PrivateHireSearchResponse xmlns="http://coachmanager.com/">
      <PrivateHireSearchResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <PrivateHires>
          <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 xsi:nil="true" />
            <PrivateHireData xsi:nil="true" />
          </PrivateHire>
          <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 xsi:nil="true" />
            <PrivateHireData xsi:nil="true" />
          </PrivateHire>
        </PrivateHires>
      </PrivateHireSearchResult>
    </PrivateHireSearchResponse>
  </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>
    <PrivateHireSearch xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <PrivateHireSearchDetails>
        <PrivateHireID>int</PrivateHireID>
        <PrivateHireMovementID>int</PrivateHireMovementID>
        <PickupDate>string</PickupDate>
        <PickupDateOperator>GreaterThan or EqualTo or LessThan</PickupDateOperator>
        <Pickup>string</Pickup>
        <Destination>string</Destination>
        <ClientReference1>string</ClientReference1>
        <ClientReference2>string</ClientReference2>
        <ClientID>string</ClientID>
        <Surname>string</Surname>
        <Initials>string</Initials>
        <Company>string</Company>
        <PostCode>string</PostCode>
        <DateCreated>string</DateCreated>
        <DateCreatedOperator>GreaterThan or EqualTo or LessThan</DateCreatedOperator>
        <LastUpdated>string</LastUpdated>
        <LastUpdatedOperator>GreaterThan or EqualTo or LessThan</LastUpdatedOperator>
      </PrivateHireSearchDetails>
    </PrivateHireSearch>
  </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>
    <PrivateHireSearchResponse xmlns="http://coachmanager.com/">
      <PrivateHireSearchResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <PrivateHires>
          <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 xsi:nil="true" />
            <PrivateHireData xsi:nil="true" />
          </PrivateHire>
          <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 xsi:nil="true" />
            <PrivateHireData xsi:nil="true" />
          </PrivateHire>
        </PrivateHires>
      </PrivateHireSearchResult>
    </PrivateHireSearchResponse>
  </soap12:Body>
</soap12:Envelope>