BrightofficeAPI

Click here for a complete list of operations.

CreateNewAppointment

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

<?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>
    <CreateNewAppointment xmlns="http://tempuri.org/">
      <App>
        <Code>int</Code>
        <CustomerCode>string</CustomerCode>
        <CustomerName>string</CustomerName>
        <IsB2B>boolean</IsB2B>
        <CustomerHouseNo>string</CustomerHouseNo>
        <CustomerHouseName>string</CustomerHouseName>
        <CustomerAddr1>string</CustomerAddr1>
        <CustomerAddr2>string</CustomerAddr2>
        <CustomerAddr3>string</CustomerAddr3>
        <CustomerAddr4>string</CustomerAddr4>
        <CustomerPostCode>string</CustomerPostCode>
        <CustomerTelephone>string</CustomerTelephone>
        <CustomerMobile>string</CustomerMobile>
        <CustomerEmail>string</CustomerEmail>
        <EntryDate>dateTime</EntryDate>
        <AppointmentDate>dateTime</AppointmentDate>
        <AppointmentEndDate>dateTime</AppointmentEndDate>
        <SupervisorConfirmer>string</SupervisorConfirmer>
        <StaffCode>string</StaffCode>
        <UserCreated>string</UserCreated>
        <Representative>string</Representative>
        <RepresentativeEmail>string</RepresentativeEmail>
        <RepresentativeTelephone>string</RepresentativeTelephone>
        <SalesStage>string</SalesStage>
        <Status>string</Status>
        <AppOutcome>string</AppOutcome>
        <GrossAmount>double</GrossAmount>
        <ProductAssembly>string</ProductAssembly>
        <Notes>string</Notes>
        <CustomerStatus>string</CustomerStatus>
        <IsTelesalesProspect>boolean</IsTelesalesProspect>
        <AllowAppointmentOutcomeUpdateMobile>boolean</AllowAppointmentOutcomeUpdateMobile>
      </App>
      <userInfo>
        <Username>string</Username>
        <Password>string</Password>
      </userInfo>
    </CreateNewAppointment>
  </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>
    <CreateNewAppointmentResponse xmlns="http://tempuri.org/">
      <CreateNewAppointmentResult>
        <UpdateResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </UpdateResult>
        <intUniqueId>int</intUniqueId>
      </CreateNewAppointmentResult>
    </CreateNewAppointmentResponse>
  </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>
    <CreateNewAppointment xmlns="http://tempuri.org/">
      <App>
        <Code>int</Code>
        <CustomerCode>string</CustomerCode>
        <CustomerName>string</CustomerName>
        <IsB2B>boolean</IsB2B>
        <CustomerHouseNo>string</CustomerHouseNo>
        <CustomerHouseName>string</CustomerHouseName>
        <CustomerAddr1>string</CustomerAddr1>
        <CustomerAddr2>string</CustomerAddr2>
        <CustomerAddr3>string</CustomerAddr3>
        <CustomerAddr4>string</CustomerAddr4>
        <CustomerPostCode>string</CustomerPostCode>
        <CustomerTelephone>string</CustomerTelephone>
        <CustomerMobile>string</CustomerMobile>
        <CustomerEmail>string</CustomerEmail>
        <EntryDate>dateTime</EntryDate>
        <AppointmentDate>dateTime</AppointmentDate>
        <AppointmentEndDate>dateTime</AppointmentEndDate>
        <SupervisorConfirmer>string</SupervisorConfirmer>
        <StaffCode>string</StaffCode>
        <UserCreated>string</UserCreated>
        <Representative>string</Representative>
        <RepresentativeEmail>string</RepresentativeEmail>
        <RepresentativeTelephone>string</RepresentativeTelephone>
        <SalesStage>string</SalesStage>
        <Status>string</Status>
        <AppOutcome>string</AppOutcome>
        <GrossAmount>double</GrossAmount>
        <ProductAssembly>string</ProductAssembly>
        <Notes>string</Notes>
        <CustomerStatus>string</CustomerStatus>
        <IsTelesalesProspect>boolean</IsTelesalesProspect>
        <AllowAppointmentOutcomeUpdateMobile>boolean</AllowAppointmentOutcomeUpdateMobile>
      </App>
      <userInfo>
        <Username>string</Username>
        <Password>string</Password>
      </userInfo>
    </CreateNewAppointment>
  </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>
    <CreateNewAppointmentResponse xmlns="http://tempuri.org/">
      <CreateNewAppointmentResult>
        <UpdateResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </UpdateResult>
        <intUniqueId>int</intUniqueId>
      </CreateNewAppointmentResult>
    </CreateNewAppointmentResponse>
  </soap12:Body>
</soap12:Envelope>