BrightofficeAPI

Click here for a complete list of operations.

SaveAppointmentDetailsMobile

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 /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/SaveAppointmentDetailsMobile"

<?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>
    <SaveAppointmentDetailsMobile xmlns="http://tempuri.org/">
      <appointment>
        <Code>int</Code>
        <AppOutcome>string</AppOutcome>
        <OnAppOutcomeCreate>string</OnAppOutcomeCreate>
        <ProductAssemblyCode>string</ProductAssemblyCode>
        <InvoiceCode>string</InvoiceCode>
        <NetAmount>double</NetAmount>
        <GrossAmount>double</GrossAmount>
        <DiscountNetAmount>double</DiscountNetAmount>
        <DiscountGrossAmount>double</DiscountGrossAmount>
        <VATRate>double</VATRate>
        <AppointmentOutcomeNote>string</AppointmentOutcomeNote>
        <AppointmentOutcomesMobileList>
          <SalesStageMobile>
            <Code>string</Code>
            <Description>string</Description>
            <OnAppOutcomeCreate>string</OnAppOutcomeCreate>
          </SalesStageMobile>
          <SalesStageMobile>
            <Code>string</Code>
            <Description>string</Description>
            <OnAppOutcomeCreate>string</OnAppOutcomeCreate>
          </SalesStageMobile>
        </AppointmentOutcomesMobileList>
        <ProductAssemblyMobileList>
          <ProductAssemblyMobile>
            <Code>string</Code>
            <Description>string</Description>
            <GrossAmount>double</GrossAmount>
            <NetAmount>double</NetAmount>
            <VatRate>double</VatRate>
            <TotalAmount>double</TotalAmount>
          </ProductAssemblyMobile>
          <ProductAssemblyMobile>
            <Code>string</Code>
            <Description>string</Description>
            <GrossAmount>double</GrossAmount>
            <NetAmount>double</NetAmount>
            <VatRate>double</VatRate>
            <TotalAmount>double</TotalAmount>
          </ProductAssemblyMobile>
        </ProductAssemblyMobileList>
      </appointment>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </SaveAppointmentDetailsMobile>
  </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>
    <SaveAppointmentDetailsMobileResponse xmlns="http://tempuri.org/">
      <SaveAppointmentDetailsMobileResult>
        <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
        <Message>string</Message>
        <ExceptionMessage>string</ExceptionMessage>
        <IsSystemError>boolean</IsSystemError>
      </SaveAppointmentDetailsMobileResult>
    </SaveAppointmentDetailsMobileResponse>
  </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 /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
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>
    <SaveAppointmentDetailsMobile xmlns="http://tempuri.org/">
      <appointment>
        <Code>int</Code>
        <AppOutcome>string</AppOutcome>
        <OnAppOutcomeCreate>string</OnAppOutcomeCreate>
        <ProductAssemblyCode>string</ProductAssemblyCode>
        <InvoiceCode>string</InvoiceCode>
        <NetAmount>double</NetAmount>
        <GrossAmount>double</GrossAmount>
        <DiscountNetAmount>double</DiscountNetAmount>
        <DiscountGrossAmount>double</DiscountGrossAmount>
        <VATRate>double</VATRate>
        <AppointmentOutcomeNote>string</AppointmentOutcomeNote>
        <AppointmentOutcomesMobileList>
          <SalesStageMobile>
            <Code>string</Code>
            <Description>string</Description>
            <OnAppOutcomeCreate>string</OnAppOutcomeCreate>
          </SalesStageMobile>
          <SalesStageMobile>
            <Code>string</Code>
            <Description>string</Description>
            <OnAppOutcomeCreate>string</OnAppOutcomeCreate>
          </SalesStageMobile>
        </AppointmentOutcomesMobileList>
        <ProductAssemblyMobileList>
          <ProductAssemblyMobile>
            <Code>string</Code>
            <Description>string</Description>
            <GrossAmount>double</GrossAmount>
            <NetAmount>double</NetAmount>
            <VatRate>double</VatRate>
            <TotalAmount>double</TotalAmount>
          </ProductAssemblyMobile>
          <ProductAssemblyMobile>
            <Code>string</Code>
            <Description>string</Description>
            <GrossAmount>double</GrossAmount>
            <NetAmount>double</NetAmount>
            <VatRate>double</VatRate>
            <TotalAmount>double</TotalAmount>
          </ProductAssemblyMobile>
        </ProductAssemblyMobileList>
      </appointment>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </SaveAppointmentDetailsMobile>
  </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>
    <SaveAppointmentDetailsMobileResponse xmlns="http://tempuri.org/">
      <SaveAppointmentDetailsMobileResult>
        <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
        <Message>string</Message>
        <ExceptionMessage>string</ExceptionMessage>
        <IsSystemError>boolean</IsSystemError>
      </SaveAppointmentDetailsMobileResult>
    </SaveAppointmentDetailsMobileResponse>
  </soap12:Body>
</soap12:Envelope>