BrightofficeAPI

Click here for a complete list of operations.

GetCustomerDetailsJSON

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
Username:
Password:
CustomerCode:
CustomerName:
CustomerStatus:

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

<?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>
    <GetCustomerDetailsJSON xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
      <CustomerCode>string</CustomerCode>
      <CustomerName>string</CustomerName>
      <CustomerStatus>string</CustomerStatus>
    </GetCustomerDetailsJSON>
  </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>
    <GetCustomerDetailsJSONResponse xmlns="http://tempuri.org/">
      <GetCustomerDetailsJSONResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </GetCustomerDetailsJSONResult>
    </GetCustomerDetailsJSONResponse>
  </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>
    <GetCustomerDetailsJSON xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
      <CustomerCode>string</CustomerCode>
      <CustomerName>string</CustomerName>
      <CustomerStatus>string</CustomerStatus>
    </GetCustomerDetailsJSON>
  </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>
    <GetCustomerDetailsJSONResponse xmlns="http://tempuri.org/">
      <GetCustomerDetailsJSONResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </GetCustomerDetailsJSONResult>
    </GetCustomerDetailsJSONResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Webservices/BrightOfficeAPI.asmx/GetCustomerDetailsJSON?Username=string&Password=string&CustomerCode=string&CustomerName=string&CustomerStatus=string HTTP/1.1
Host: www.spdoffice.co.uk

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<EnquiryListResult xmlns="http://tempuri.org/">
  <EnquiryResult>
    <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
    <Message>string</Message>
    <ExceptionMessage>string</ExceptionMessage>
    <IsSystemError>boolean</IsSystemError>
  </EnquiryResult>
  <Records>
    <anyType />
    <anyType />
  </Records>
  <TotalRecordCount>int</TotalRecordCount>
</EnquiryListResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Webservices/BrightOfficeAPI.asmx/GetCustomerDetailsJSON HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&CustomerCode=string&CustomerName=string&CustomerStatus=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<EnquiryListResult xmlns="http://tempuri.org/">
  <EnquiryResult>
    <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
    <Message>string</Message>
    <ExceptionMessage>string</ExceptionMessage>
    <IsSystemError>boolean</IsSystemError>
  </EnquiryResult>
  <Records>
    <anyType />
    <anyType />
  </Records>
  <TotalRecordCount>int</TotalRecordCount>
</EnquiryListResult>