BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

SaveVLEQuestionsAnswer

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

<?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>
    <SaveVLEQuestionsAnswer xmlns="http://tempuri.org/">
      <pRequest>
        <TrainingCourseCode>string</TrainingCourseCode>
        <DelegateCode>string</DelegateCode>
        <QuestionaireCode>string</QuestionaireCode>
        <CompletionPercent>string</CompletionPercent>
        <AnswerOutcome>string</AnswerOutcome>
        <NoOfAttemptsDone>int</NoOfAttemptsDone>
        <PassesAllowed>string</PassesAllowed>
        <DisplayResultsOnCompletion>string</DisplayResultsOnCompletion>
        <ShowCorrectAnswers>string</ShowCorrectAnswers>
        <ExpiryDate>dateTime</ExpiryDate>
        <IsFinalSubmitClick>boolean</IsFinalSubmitClick>
        <QuesitonDetails>
          <VLEQuesitonDetails>
            <QCode>string</QCode>
            <ItemType>string</ItemType>
            <HeaderText>string</HeaderText>
            <QuestionText>string</QuestionText>
            <HiddenAnswer>string</HiddenAnswer>
            <Answer>string</Answer>
            <CorrectAnswerCount>string</CorrectAnswerCount>
            <OrderNo>string</OrderNo>
            <AnswerType>string</AnswerType>
            <QuestionType>string</QuestionType>
            <MaximumOutCome>double</MaximumOutCome>
            <CorrectOutCome>double</CorrectOutCome>
            <AnswerDetails xsi:nil="true" />
            <AdditionalLinkDetail xsi:nil="true" />
          </VLEQuesitonDetails>
          <VLEQuesitonDetails>
            <QCode>string</QCode>
            <ItemType>string</ItemType>
            <HeaderText>string</HeaderText>
            <QuestionText>string</QuestionText>
            <HiddenAnswer>string</HiddenAnswer>
            <Answer>string</Answer>
            <CorrectAnswerCount>string</CorrectAnswerCount>
            <OrderNo>string</OrderNo>
            <AnswerType>string</AnswerType>
            <QuestionType>string</QuestionType>
            <MaximumOutCome>double</MaximumOutCome>
            <CorrectOutCome>double</CorrectOutCome>
            <AnswerDetails xsi:nil="true" />
            <AdditionalLinkDetail xsi:nil="true" />
          </VLEQuesitonDetails>
        </QuesitonDetails>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </SaveVLEQuestionsAnswer>
  </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>
    <SaveVLEQuestionsAnswerResponse xmlns="http://tempuri.org/">
      <SaveVLEQuestionsAnswerResult>
        <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>
      </SaveVLEQuestionsAnswerResult>
    </SaveVLEQuestionsAnswerResponse>
  </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>
    <SaveVLEQuestionsAnswer xmlns="http://tempuri.org/">
      <pRequest>
        <TrainingCourseCode>string</TrainingCourseCode>
        <DelegateCode>string</DelegateCode>
        <QuestionaireCode>string</QuestionaireCode>
        <CompletionPercent>string</CompletionPercent>
        <AnswerOutcome>string</AnswerOutcome>
        <NoOfAttemptsDone>int</NoOfAttemptsDone>
        <PassesAllowed>string</PassesAllowed>
        <DisplayResultsOnCompletion>string</DisplayResultsOnCompletion>
        <ShowCorrectAnswers>string</ShowCorrectAnswers>
        <ExpiryDate>dateTime</ExpiryDate>
        <IsFinalSubmitClick>boolean</IsFinalSubmitClick>
        <QuesitonDetails>
          <VLEQuesitonDetails>
            <QCode>string</QCode>
            <ItemType>string</ItemType>
            <HeaderText>string</HeaderText>
            <QuestionText>string</QuestionText>
            <HiddenAnswer>string</HiddenAnswer>
            <Answer>string</Answer>
            <CorrectAnswerCount>string</CorrectAnswerCount>
            <OrderNo>string</OrderNo>
            <AnswerType>string</AnswerType>
            <QuestionType>string</QuestionType>
            <MaximumOutCome>double</MaximumOutCome>
            <CorrectOutCome>double</CorrectOutCome>
            <AnswerDetails xsi:nil="true" />
            <AdditionalLinkDetail xsi:nil="true" />
          </VLEQuesitonDetails>
          <VLEQuesitonDetails>
            <QCode>string</QCode>
            <ItemType>string</ItemType>
            <HeaderText>string</HeaderText>
            <QuestionText>string</QuestionText>
            <HiddenAnswer>string</HiddenAnswer>
            <Answer>string</Answer>
            <CorrectAnswerCount>string</CorrectAnswerCount>
            <OrderNo>string</OrderNo>
            <AnswerType>string</AnswerType>
            <QuestionType>string</QuestionType>
            <MaximumOutCome>double</MaximumOutCome>
            <CorrectOutCome>double</CorrectOutCome>
            <AnswerDetails xsi:nil="true" />
            <AdditionalLinkDetail xsi:nil="true" />
          </VLEQuesitonDetails>
        </QuesitonDetails>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </SaveVLEQuestionsAnswer>
  </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>
    <SaveVLEQuestionsAnswerResponse xmlns="http://tempuri.org/">
      <SaveVLEQuestionsAnswerResult>
        <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>
      </SaveVLEQuestionsAnswerResult>
    </SaveVLEQuestionsAnswerResponse>
  </soap12:Body>
</soap12:Envelope>