BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

GetSalesWalkOrder

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

<?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>
    <GetSalesWalkOrder xmlns="http://tempuri.org/">
      <pRequest>
        <user_id>int</user_id>
        <agent_id>string</agent_id>
        <from_date>string</from_date>
        <end_date>string</end_date>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </GetSalesWalkOrder>
  </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>
    <GetSalesWalkOrderResponse xmlns="http://tempuri.org/">
      <GetSalesWalkOrderResult>
        <SalesWalkOrder>
          <SalesWalkOrderDetail>
            <id>string</id>
            <ApplicantId>string</ApplicantId>
            <CustomerName>string</CustomerName>
            <Telephone>string</Telephone>
            <Mobile>string</Mobile>
            <CustomerAddress xsi:nil="true" />
            <agent_id>string</agent_id>
            <agent_name>string</agent_name>
            <DueAmount>double</DueAmount>
            <DueDate>dateTime</DueDate>
            <WalkDate>dateTime</WalkDate>
            <WalkOrder>int</WalkOrder>
            <WalkOrderStatus>string</WalkOrderStatus>
          </SalesWalkOrderDetail>
          <SalesWalkOrderDetail>
            <id>string</id>
            <ApplicantId>string</ApplicantId>
            <CustomerName>string</CustomerName>
            <Telephone>string</Telephone>
            <Mobile>string</Mobile>
            <CustomerAddress xsi:nil="true" />
            <agent_id>string</agent_id>
            <agent_name>string</agent_name>
            <DueAmount>double</DueAmount>
            <DueDate>dateTime</DueDate>
            <WalkDate>dateTime</WalkDate>
            <WalkOrder>int</WalkOrder>
            <WalkOrderStatus>string</WalkOrderStatus>
          </SalesWalkOrderDetail>
        </SalesWalkOrder>
        <SalesWalkOrderStatus>
          <SalesWalkOrderStatusDetail>
            <id>string</id>
            <name>string</name>
            <isDefault>boolean</isDefault>
          </SalesWalkOrderStatusDetail>
          <SalesWalkOrderStatusDetail>
            <id>string</id>
            <name>string</name>
            <isDefault>boolean</isDefault>
          </SalesWalkOrderStatusDetail>
        </SalesWalkOrderStatus>
        <Result>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </Result>
      </GetSalesWalkOrderResult>
    </GetSalesWalkOrderResponse>
  </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>
    <GetSalesWalkOrder xmlns="http://tempuri.org/">
      <pRequest>
        <user_id>int</user_id>
        <agent_id>string</agent_id>
        <from_date>string</from_date>
        <end_date>string</end_date>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </GetSalesWalkOrder>
  </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>
    <GetSalesWalkOrderResponse xmlns="http://tempuri.org/">
      <GetSalesWalkOrderResult>
        <SalesWalkOrder>
          <SalesWalkOrderDetail>
            <id>string</id>
            <ApplicantId>string</ApplicantId>
            <CustomerName>string</CustomerName>
            <Telephone>string</Telephone>
            <Mobile>string</Mobile>
            <CustomerAddress xsi:nil="true" />
            <agent_id>string</agent_id>
            <agent_name>string</agent_name>
            <DueAmount>double</DueAmount>
            <DueDate>dateTime</DueDate>
            <WalkDate>dateTime</WalkDate>
            <WalkOrder>int</WalkOrder>
            <WalkOrderStatus>string</WalkOrderStatus>
          </SalesWalkOrderDetail>
          <SalesWalkOrderDetail>
            <id>string</id>
            <ApplicantId>string</ApplicantId>
            <CustomerName>string</CustomerName>
            <Telephone>string</Telephone>
            <Mobile>string</Mobile>
            <CustomerAddress xsi:nil="true" />
            <agent_id>string</agent_id>
            <agent_name>string</agent_name>
            <DueAmount>double</DueAmount>
            <DueDate>dateTime</DueDate>
            <WalkDate>dateTime</WalkDate>
            <WalkOrder>int</WalkOrder>
            <WalkOrderStatus>string</WalkOrderStatus>
          </SalesWalkOrderDetail>
        </SalesWalkOrder>
        <SalesWalkOrderStatus>
          <SalesWalkOrderStatusDetail>
            <id>string</id>
            <name>string</name>
            <isDefault>boolean</isDefault>
          </SalesWalkOrderStatusDetail>
          <SalesWalkOrderStatusDetail>
            <id>string</id>
            <name>string</name>
            <isDefault>boolean</isDefault>
          </SalesWalkOrderStatusDetail>
        </SalesWalkOrderStatus>
        <Result>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </Result>
      </GetSalesWalkOrderResult>
    </GetSalesWalkOrderResponse>
  </soap12:Body>
</soap12:Envelope>