CM Web Service

Click here for a complete list of operations.

AllocationSearch

Retrieve a list of allocations in 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/AllocationSearch"

<?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 />
</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 />
</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 />
</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>
    <AllocationSearchResponse xmlns="http://coachmanager.com/">
      <AllocationSearchResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <Allocations>
          <Allocation />
          <Allocation>
            <StartDateTime>string</StartDateTime>
            <StartBase>string</StartBase>
            <StartPoint>string</StartPoint>
            <PositionDateTime>string</PositionDateTime>
            <PickupDateTime>string</PickupDateTime>
            <PickupPoint>string</PickupPoint>
            <PickupPointLatitude>string</PickupPointLatitude>
            <PickupPointLongitude>string</PickupPointLongitude>
            <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>
            <FinishBase>string</FinishBase>
            <FinishPoint>string</FinishPoint>
            <Description>string</Description>
            <ServiceID>string</ServiceID>
            <Passengers>string</Passengers>
            <Distance>string</Distance>
            <EmptyDistance>string</EmptyDistance>
            <ClientReference1>string</ClientReference1>
            <ClientReference2>string</ClientReference2>
            <Route>string</Route>
            <FurtherRequirements>string</FurtherRequirements>
            <PHCVehicleID>int</PHCVehicleID>
            <Seats>int</Seats>
            <VehicleType>string</VehicleType>
            <VehicleTypeDescription>string</VehicleTypeDescription>
            <VehicleID>string</VehicleID>
            <ActualSeats>int</ActualSeats>
            <ActualVehicleType>string</ActualVehicleType>
            <ActualVehicleTypeDescription>string</ActualVehicleTypeDescription>
            <RegistrationMark>string</RegistrationMark>
            <FleetNo>string</FleetNo>
            <MobileTelNo>string</MobileTelNo>
            <VehicleBase>string</VehicleBase>
            <VehicleCompanyID>string</VehicleCompanyID>
            <PHCDriverID>int</PHCDriverID>
            <DriverType>string</DriverType>
            <DriverTypeDescription>string</DriverTypeDescription>
            <DriverID>string</DriverID>
            <ActualDriverType>string</ActualDriverType>
            <ActualDriverTypeDescription>string</ActualDriverTypeDescription>
            <DriverName>string</DriverName>
            <DriverTelNo1>string</DriverTelNo1>
            <DriverTelNo2>string</DriverTelNo2>
            <DriverTelNo3>string</DriverTelNo3>
            <DriverBase>string</DriverBase>
            <DriverCompanyID>string</DriverCompanyID>
            <WorkTicketNote>string</WorkTicketNote>
            <DriverNotified>boolean</DriverNotified>
            <BookingType>string</BookingType>
            <BookingID>string</BookingID>
            <PrivateHireID>string</PrivateHireID>
            <PrivateHireMovementID>string</PrivateHireMovementID>
            <ContractID>string</ContractID>
            <ContractMovementID>string</ContractMovementID>
            <CompanyID>string</CompanyID>
            <BookingBase>string</BookingBase>
            <BookingBaseCompanyID>string</BookingBaseCompanyID>
            <Notes>string</Notes>
            <Contact>string</Contact>
            <ContactIncClientID>string</ContactIncClientID>
            <ClientID>string</ClientID>
            <Title>string</Title>
            <Initials>string</Initials>
            <Surname>string</Surname>
            <Salutation>string</Salutation>
            <Department>string</Department>
            <Company>string</Company>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <TelNo1>string</TelNo1>
            <TelNo1Comment>string</TelNo1Comment>
            <TelNo2>string</TelNo2>
            <TelNo2Comment>string</TelNo2Comment>
            <TelNo3>string</TelNo3>
            <TelNo3Comment>string</TelNo3Comment>
            <FaxNo>string</FaxNo>
            <FaxNoComment>string</FaxNoComment>
            <EMail>string</EMail>
            <Livery>string</Livery>
          </Allocation>
        </Allocations>
      </AllocationSearchResult>
    </AllocationSearchResponse>
  </soap12:Body>
</soap12:Envelope>