CM Web Service

Click here for a complete list of operations.

UpdateClient

Updates a client

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

<?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>
    <UpdateClient xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <Client>
        <ClientID>string</ClientID>
        <AcceptBookings>boolean</AcceptBookings>
        <Title>string</Title>
        <Initials>string</Initials>
        <Surname>string</Surname>
        <FirstName>string</FirstName>
        <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>
        <TemplateQuote>string</TemplateQuote>
        <TemplateProvisional>string</TemplateProvisional>
        <TemplateFirm>string</TemplateFirm>
        <SendLettersVia>Post or Email or Fax</SendLettersVia>
        <SendFollowUpEmail>boolean</SendFollowUpEmail>
        <ClientDiscountPercentage>decimal</ClientDiscountPercentage>
        <BookingType>string</BookingType>
        <Livery>string</Livery>
        <ApplyVehicleTypeSurcharges>boolean</ApplyVehicleTypeSurcharges>
        <DepositRequired>boolean</DepositRequired>
        <VATNo>string</VATNo>
        <CreditLimit>int</CreditLimit>
        <OverdueDays>int</OverdueDays>
        <OverdueFrom>DateOfInvoice or EndOfMonth</OverdueFrom>
        <TermsOfTrade>string</TermsOfTrade>
        <InvoiceMethod>Daily or Weekly or Monthly or ClientID or Immediate</InvoiceMethod>
        <InvoiceType>Individual or Combined</InvoiceType>
        <SendInvoiceVia>Post or Email or Fax</SendInvoiceVia>
        <Code1>string</Code1>
        <Code2>string</Code2>
        <Code3>string</Code3>
        <Code4>string</Code4>
        <Code5>string</Code5>
        <Notes>string</Notes>
        <Suspend>boolean</Suspend>
        <Deleted>boolean</Deleted>
        <ClientContactConsents>
          <ClientContactConsent>
            <ClientContactConsentSerialNo>int</ClientContactConsentSerialNo>
            <CompanySerialNo>int</CompanySerialNo>
            <CompanyID>string</CompanyID>
            <ClientID>string</ClientID>
            <ClientSerialNo>int</ClientSerialNo>
            <Contact>boolean</Contact>
            <ContactPost>boolean</ContactPost>
            <ContactEMail>boolean</ContactEMail>
            <ContactTelephone>boolean</ContactTelephone>
            <ContactSMS>boolean</ContactSMS>
            <Contact3rdParty>boolean</Contact3rdParty>
            <Contact3rdPartyPost>boolean</Contact3rdPartyPost>
            <Contact3rdPartyEMail>boolean</Contact3rdPartyEMail>
            <Contact3rdPartyTelephone>boolean</Contact3rdPartyTelephone>
            <Contact3rdPartySMS>boolean</Contact3rdPartySMS>
            <ClientContactConsentStatementSerialNo>int</ClientContactConsentStatementSerialNo>
            <ConsentMethod>Web or Internal or Automatic</ConsentMethod>
            <LatestConsent>boolean</LatestConsent>
            <DateCreated>string</DateCreated>
          </ClientContactConsent>
          <ClientContactConsent>
            <ClientContactConsentSerialNo>int</ClientContactConsentSerialNo>
            <CompanySerialNo>int</CompanySerialNo>
            <CompanyID>string</CompanyID>
            <ClientID>string</ClientID>
            <ClientSerialNo>int</ClientSerialNo>
            <Contact>boolean</Contact>
            <ContactPost>boolean</ContactPost>
            <ContactEMail>boolean</ContactEMail>
            <ContactTelephone>boolean</ContactTelephone>
            <ContactSMS>boolean</ContactSMS>
            <Contact3rdParty>boolean</Contact3rdParty>
            <Contact3rdPartyPost>boolean</Contact3rdPartyPost>
            <Contact3rdPartyEMail>boolean</Contact3rdPartyEMail>
            <Contact3rdPartyTelephone>boolean</Contact3rdPartyTelephone>
            <Contact3rdPartySMS>boolean</Contact3rdPartySMS>
            <ClientContactConsentStatementSerialNo>int</ClientContactConsentStatementSerialNo>
            <ConsentMethod>Web or Internal or Automatic</ConsentMethod>
            <LatestConsent>boolean</LatestConsent>
            <DateCreated>string</DateCreated>
          </ClientContactConsent>
        </ClientContactConsents>
        <DateCreated>string</DateCreated>
        <LastUpdated>string</LastUpdated>
      </Client>
    </UpdateClient>
  </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>
    <UpdateClientResponse xmlns="http://coachmanager.com/">
      <UpdateClientResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
      </UpdateClientResult>
    </UpdateClientResponse>
  </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>
    <UpdateClient xmlns="http://coachmanager.com/">
      <SessionKey>string</SessionKey>
      <Client>
        <ClientID>string</ClientID>
        <AcceptBookings>boolean</AcceptBookings>
        <Title>string</Title>
        <Initials>string</Initials>
        <Surname>string</Surname>
        <FirstName>string</FirstName>
        <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>
        <TemplateQuote>string</TemplateQuote>
        <TemplateProvisional>string</TemplateProvisional>
        <TemplateFirm>string</TemplateFirm>
        <SendLettersVia>Post or Email or Fax</SendLettersVia>
        <SendFollowUpEmail>boolean</SendFollowUpEmail>
        <ClientDiscountPercentage>decimal</ClientDiscountPercentage>
        <BookingType>string</BookingType>
        <Livery>string</Livery>
        <ApplyVehicleTypeSurcharges>boolean</ApplyVehicleTypeSurcharges>
        <DepositRequired>boolean</DepositRequired>
        <VATNo>string</VATNo>
        <CreditLimit>int</CreditLimit>
        <OverdueDays>int</OverdueDays>
        <OverdueFrom>DateOfInvoice or EndOfMonth</OverdueFrom>
        <TermsOfTrade>string</TermsOfTrade>
        <InvoiceMethod>Daily or Weekly or Monthly or ClientID or Immediate</InvoiceMethod>
        <InvoiceType>Individual or Combined</InvoiceType>
        <SendInvoiceVia>Post or Email or Fax</SendInvoiceVia>
        <Code1>string</Code1>
        <Code2>string</Code2>
        <Code3>string</Code3>
        <Code4>string</Code4>
        <Code5>string</Code5>
        <Notes>string</Notes>
        <Suspend>boolean</Suspend>
        <Deleted>boolean</Deleted>
        <ClientContactConsents>
          <ClientContactConsent>
            <ClientContactConsentSerialNo>int</ClientContactConsentSerialNo>
            <CompanySerialNo>int</CompanySerialNo>
            <CompanyID>string</CompanyID>
            <ClientID>string</ClientID>
            <ClientSerialNo>int</ClientSerialNo>
            <Contact>boolean</Contact>
            <ContactPost>boolean</ContactPost>
            <ContactEMail>boolean</ContactEMail>
            <ContactTelephone>boolean</ContactTelephone>
            <ContactSMS>boolean</ContactSMS>
            <Contact3rdParty>boolean</Contact3rdParty>
            <Contact3rdPartyPost>boolean</Contact3rdPartyPost>
            <Contact3rdPartyEMail>boolean</Contact3rdPartyEMail>
            <Contact3rdPartyTelephone>boolean</Contact3rdPartyTelephone>
            <Contact3rdPartySMS>boolean</Contact3rdPartySMS>
            <ClientContactConsentStatementSerialNo>int</ClientContactConsentStatementSerialNo>
            <ConsentMethod>Web or Internal or Automatic</ConsentMethod>
            <LatestConsent>boolean</LatestConsent>
            <DateCreated>string</DateCreated>
          </ClientContactConsent>
          <ClientContactConsent>
            <ClientContactConsentSerialNo>int</ClientContactConsentSerialNo>
            <CompanySerialNo>int</CompanySerialNo>
            <CompanyID>string</CompanyID>
            <ClientID>string</ClientID>
            <ClientSerialNo>int</ClientSerialNo>
            <Contact>boolean</Contact>
            <ContactPost>boolean</ContactPost>
            <ContactEMail>boolean</ContactEMail>
            <ContactTelephone>boolean</ContactTelephone>
            <ContactSMS>boolean</ContactSMS>
            <Contact3rdParty>boolean</Contact3rdParty>
            <Contact3rdPartyPost>boolean</Contact3rdPartyPost>
            <Contact3rdPartyEMail>boolean</Contact3rdPartyEMail>
            <Contact3rdPartyTelephone>boolean</Contact3rdPartyTelephone>
            <Contact3rdPartySMS>boolean</Contact3rdPartySMS>
            <ClientContactConsentStatementSerialNo>int</ClientContactConsentStatementSerialNo>
            <ConsentMethod>Web or Internal or Automatic</ConsentMethod>
            <LatestConsent>boolean</LatestConsent>
            <DateCreated>string</DateCreated>
          </ClientContactConsent>
        </ClientContactConsents>
        <DateCreated>string</DateCreated>
        <LastUpdated>string</LastUpdated>
      </Client>
    </UpdateClient>
  </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>
    <UpdateClientResponse xmlns="http://coachmanager.com/">
      <UpdateClientResult>
        <Result>Success or Fail</Result>
        <ResultDescription>string</ResultDescription>
      </UpdateClientResult>
    </UpdateClientResponse>
  </soap12:Body>
</soap12:Envelope>