BrightofficeAPI


Click here for a complete list of operations.

GetActiveTrainingCoursesListByCustomer_Paginated

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

<?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>
    <GetActiveTrainingCoursesListByCustomer_Paginated xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
      <PrimaryGroup>string</PrimaryGroup>
      <CourseCode>string</CourseCode>
      <StartDate>string</StartDate>
      <EndDate>string</EndDate>
      <PageSize>int</PageSize>
      <PageNumber>int</PageNumber>
      <MatterType>string</MatterType>
      <CourseStatus>string</CourseStatus>
      <CourseVenue>string</CourseVenue>
      <CustomerCode>string</CustomerCode>
    </GetActiveTrainingCoursesListByCustomer_Paginated>
  </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>
    <GetActiveTrainingCoursesListByCustomer_PaginatedResponse xmlns="http://tempuri.org/">
      <GetActiveTrainingCoursesListByCustomer_PaginatedResult>
        <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>
      </GetActiveTrainingCoursesListByCustomer_PaginatedResult>
    </GetActiveTrainingCoursesListByCustomer_PaginatedResponse>
  </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>
    <GetActiveTrainingCoursesListByCustomer_Paginated xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
      <PrimaryGroup>string</PrimaryGroup>
      <CourseCode>string</CourseCode>
      <StartDate>string</StartDate>
      <EndDate>string</EndDate>
      <PageSize>int</PageSize>
      <PageNumber>int</PageNumber>
      <MatterType>string</MatterType>
      <CourseStatus>string</CourseStatus>
      <CourseVenue>string</CourseVenue>
      <CustomerCode>string</CustomerCode>
    </GetActiveTrainingCoursesListByCustomer_Paginated>
  </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>
    <GetActiveTrainingCoursesListByCustomer_PaginatedResponse xmlns="http://tempuri.org/">
      <GetActiveTrainingCoursesListByCustomer_PaginatedResult>
        <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>
      </GetActiveTrainingCoursesListByCustomer_PaginatedResult>
    </GetActiveTrainingCoursesListByCustomer_PaginatedResponse>
  </soap12:Body>
</soap12:Envelope>