CM Web Service

Click here for a complete list of operations.

InsertContract

Insert a Contract 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/InsertContract"

<?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>
    <InsertContract xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <Contract>
        <ContractID>int</ContractID>
        <ClientID>string</ClientID>
        <BookingType>string</BookingType>
        <CompanyID>string</CompanyID>
        <BaseSerialNo>int</BaseSerialNo>
        <OperatorID>string</OperatorID>
        <DateCreated>string</DateCreated>
        <Cancelled>boolean</Cancelled>
        <ContractMovements>
          <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 xsi:nil="true" />
            <ContractVehicles xsi:nil="true" />
            <ContractPickups xsi:nil="true" />
            <ContractSetdowns xsi:nil="true" />
            <ContractFacilities xsi:nil="true" />
            <ContractIncludedItems xsi:nil="true" />
            <ContractMovementData xsi:nil="true" />
          </ContractMovement>
          <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 xsi:nil="true" />
            <ContractVehicles xsi:nil="true" />
            <ContractPickups xsi:nil="true" />
            <ContractSetdowns xsi:nil="true" />
            <ContractFacilities xsi:nil="true" />
            <ContractIncludedItems xsi:nil="true" />
            <ContractMovementData xsi:nil="true" />
          </ContractMovement>
        </ContractMovements>
        <ContractData>
          <ContractData>
            <ContractID>int</ContractID>
            <ContractDataTitleSerialNo>int</ContractDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </ContractData>
          <ContractData>
            <ContractID>int</ContractID>
            <ContractDataTitleSerialNo>int</ContractDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </ContractData>
        </ContractData>
      </Contract>
    </InsertContract>
  </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>
    <InsertContractResponse xmlns="http://coachmanager.com/">
      <InsertContractResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <ContractID>int</ContractID>
        <ContractMovementIDs>
          <int>int</int>
          <int>int</int>
        </ContractMovementIDs>
      </InsertContractResult>
    </InsertContractResponse>
  </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>
    <InsertContract xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <Contract>
        <ContractID>int</ContractID>
        <ClientID>string</ClientID>
        <BookingType>string</BookingType>
        <CompanyID>string</CompanyID>
        <BaseSerialNo>int</BaseSerialNo>
        <OperatorID>string</OperatorID>
        <DateCreated>string</DateCreated>
        <Cancelled>boolean</Cancelled>
        <ContractMovements>
          <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 xsi:nil="true" />
            <ContractVehicles xsi:nil="true" />
            <ContractPickups xsi:nil="true" />
            <ContractSetdowns xsi:nil="true" />
            <ContractFacilities xsi:nil="true" />
            <ContractIncludedItems xsi:nil="true" />
            <ContractMovementData xsi:nil="true" />
          </ContractMovement>
          <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 xsi:nil="true" />
            <ContractVehicles xsi:nil="true" />
            <ContractPickups xsi:nil="true" />
            <ContractSetdowns xsi:nil="true" />
            <ContractFacilities xsi:nil="true" />
            <ContractIncludedItems xsi:nil="true" />
            <ContractMovementData xsi:nil="true" />
          </ContractMovement>
        </ContractMovements>
        <ContractData>
          <ContractData>
            <ContractID>int</ContractID>
            <ContractDataTitleSerialNo>int</ContractDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </ContractData>
          <ContractData>
            <ContractID>int</ContractID>
            <ContractDataTitleSerialNo>int</ContractDataTitleSerialNo>
            <TextValue>string</TextValue>
            <NumberValue>decimal</NumberValue>
            <MoneyValue>decimal</MoneyValue>
            <DateValue>string</DateValue>
            <YesNoValue>boolean</YesNoValue>
          </ContractData>
        </ContractData>
      </Contract>
    </InsertContract>
  </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>
    <InsertContractResponse xmlns="http://coachmanager.com/">
      <InsertContractResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
        <ContractID>int</ContractID>
        <ContractMovementIDs>
          <int>int</int>
          <int>int</int>
        </ContractMovementIDs>
      </InsertContractResult>
    </InsertContractResponse>
  </soap12:Body>
</soap12:Envelope>