BlueLMSWS Web Service

BlueLMSWS

Click here for a complete list of operations.

GetAssessment

Returns the assessment with the given id for the given user. It also checks whether the user has reached or not the allowed maximum numbers of attempts. If the user reached the max number of attempts than the method returns the appropriate error message.

Test

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

Parameter	Value
userID:
assessmentID:
contPrevSession:
type:
lessonID:
assessmentSectionID:

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 /IsophBlueWS/IsophBlueWS.asmx HTTP/1.1
Host: blue.isoph.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://blue.isoph.com/GetAssessment"

<?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>
    <GetAssessment xmlns="http://blue.isoph.com">
      <userID>int</userID>
      <assessmentID>int</assessmentID>
      <contPrevSession>boolean</contPrevSession>
      <type>Test or PreTest or PostTest</type>
      <lessonID>int</lessonID>
      <assessmentSectionID>int</assessmentSectionID>
    </GetAssessment>
  </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>
    <GetAssessmentResponse xmlns="http://blue.isoph.com">
      <GetAssessmentResult>
        <ID>int</ID>
        <Name>string</Name>
        <ShowCompletionMessage>boolean</ShowCompletionMessage>
        <ShowFeedback>boolean</ShowFeedback>
        <ShowFinalResults>boolean</ShowFinalResults>
        <PassingScore>double</PassingScore>
        <AllowedAttempts>int</AllowedAttempts>
        <Score>double</Score>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <QuestionsCount>int</QuestionsCount>
        <Questions>
          <Question>
            <ID>int</ID>
            <Name>string</Name>
            <QuestionText>string</QuestionText>
            <Type>int</Type>
            <Status>int</Status>
            <ResponseRequired>boolean</ResponseRequired>
            <Rows>int</Rows>
            <Columns>int</Columns>
            <MaxLength>int</MaxLength>
            <RegionStart>string</RegionStart>
            <RegionEnd>string</RegionEnd>
            <RegionIntervals>int</RegionIntervals>
            <AnswerCount>int</AnswerCount>
            <AnswerList xsi:nil="true" />
            <MatchItemsCount>int</MatchItemsCount>
            <MatchItems xsi:nil="true" />
            <CorrectAnswerFeedback>string</CorrectAnswerFeedback>
            <IncorrectAnswerFeedback>string</IncorrectAnswerFeedback>
            <UnAnsweredQuestionFeedback>string</UnAnsweredQuestionFeedback>
            <ResponseCount>int</ResponseCount>
            <Response xsi:nil="true" />
            <Weight>double</Weight>
            <Score>double</Score>
          </Question>
          <Question>
            <ID>int</ID>
            <Name>string</Name>
            <QuestionText>string</QuestionText>
            <Type>int</Type>
            <Status>int</Status>
            <ResponseRequired>boolean</ResponseRequired>
            <Rows>int</Rows>
            <Columns>int</Columns>
            <MaxLength>int</MaxLength>
            <RegionStart>string</RegionStart>
            <RegionEnd>string</RegionEnd>
            <RegionIntervals>int</RegionIntervals>
            <AnswerCount>int</AnswerCount>
            <AnswerList xsi:nil="true" />
            <MatchItemsCount>int</MatchItemsCount>
            <MatchItems xsi:nil="true" />
            <CorrectAnswerFeedback>string</CorrectAnswerFeedback>
            <IncorrectAnswerFeedback>string</IncorrectAnswerFeedback>
            <UnAnsweredQuestionFeedback>string</UnAnsweredQuestionFeedback>
            <ResponseCount>int</ResponseCount>
            <Response xsi:nil="true" />
            <Weight>double</Weight>
            <Score>double</Score>
          </Question>
        </Questions>
        <SubmitText>string</SubmitText>
      </GetAssessmentResult>
    </GetAssessmentResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

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

GET /IsophBlueWS/IsophBlueWS.asmx/GetAssessment?userID=string&assessmentID=string&contPrevSession=string&type=string&lessonID=string&assessmentSectionID=string HTTP/1.1
Host: blue.isoph.com

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

<?xml version="1.0" encoding="utf-8"?>
<Assessment xmlns="http://blue.isoph.com">
  <ID>int</ID>
  <Name>string</Name>
  <ShowCompletionMessage>boolean</ShowCompletionMessage>
  <ShowFeedback>boolean</ShowFeedback>
  <ShowFinalResults>boolean</ShowFinalResults>
  <PassingScore>double</PassingScore>
  <AllowedAttempts>int</AllowedAttempts>
  <Score>double</Score>
  <ErrorCode>int</ErrorCode>
  <ErrorMessage>string</ErrorMessage>
  <QuestionsCount>int</QuestionsCount>
  <Questions>
    <Question>
      <ID>int</ID>
      <Name>string</Name>
      <QuestionText>string</QuestionText>
      <Type>int</Type>
      <Status>int</Status>
      <ResponseRequired>boolean</ResponseRequired>
      <Rows>int</Rows>
      <Columns>int</Columns>
      <MaxLength>int</MaxLength>
      <RegionStart>string</RegionStart>
      <RegionEnd>string</RegionEnd>
      <RegionIntervals>int</RegionIntervals>
      <AnswerCount>int</AnswerCount>
      <AnswerList>
        <string>string</string>
        <string>string</string>
      </AnswerList>
      <MatchItemsCount>int</MatchItemsCount>
      <MatchItems>
        <string>string</string>
        <string>string</string>
      </MatchItems>
      <CorrectAnswerFeedback>string</CorrectAnswerFeedback>
      <IncorrectAnswerFeedback>string</IncorrectAnswerFeedback>
      <UnAnsweredQuestionFeedback>string</UnAnsweredQuestionFeedback>
      <ResponseCount>int</ResponseCount>
      <Response>
        <string>string</string>
        <string>string</string>
      </Response>
      <Weight>double</Weight>
      <Score>double</Score>
    </Question>
    <Question>
      <ID>int</ID>
      <Name>string</Name>
      <QuestionText>string</QuestionText>
      <Type>int</Type>
      <Status>int</Status>
      <ResponseRequired>boolean</ResponseRequired>
      <Rows>int</Rows>
      <Columns>int</Columns>
      <MaxLength>int</MaxLength>
      <RegionStart>string</RegionStart>
      <RegionEnd>string</RegionEnd>
      <RegionIntervals>int</RegionIntervals>
      <AnswerCount>int</AnswerCount>
      <AnswerList>
        <string>string</string>
        <string>string</string>
      </AnswerList>
      <MatchItemsCount>int</MatchItemsCount>
      <MatchItems>
        <string>string</string>
        <string>string</string>
      </MatchItems>
      <CorrectAnswerFeedback>string</CorrectAnswerFeedback>
      <IncorrectAnswerFeedback>string</IncorrectAnswerFeedback>
      <UnAnsweredQuestionFeedback>string</UnAnsweredQuestionFeedback>
      <ResponseCount>int</ResponseCount>
      <Response>
        <string>string</string>
        <string>string</string>
      </Response>
      <Weight>double</Weight>
      <Score>double</Score>
    </Question>
  </Questions>
  <SubmitText>string</SubmitText>
</Assessment>