CreateAssessmentResult3
This method creates a new result from the information supplied and returns the result ID of the new result. The new result is stored in the A_Result table of the repository database. The information supplied may include feedback, in which case:
- A new record will be created in the A_ScoreBand table of the repository database
- The new score band ID will be written to the A_Result record
The information that must be provided is:
- The name of the participant who achieved the result
- The outcome of the results
- The scoreband for the results achieved
- The LMS Details
New properties added to this method are:
- Base
- Language
A SOAP fault message will be returned if a database error occurs at any point during processing the list.
Parameters
Input name | Description | Data type | Optional field? | ||
---|---|---|---|---|---|
Result |
|
|
|
|
|
|
Result_ID |
|
This is ignored |
String |
Y |
|
Assessment_ID |
|
The unique assessment ID for the assessment to which the new result applies |
String |
Y |
|
Write_Anwer_Data |
|
This indicates whether there is any information in the AnswerList below (defaults to the FALSE if not set) |
Boolean |
Y |
|
Participant |
|
The participant name of the participant who achieved the new result |
String |
N |
|
Member_Group |
|
The group name of the group that the participant who achieved the new result is a member of (defaults to blank if not set) |
String |
Y |
|
Participant_Details |
|
The participant details for the participant who achieved the new result (defaults to blank if not set) |
String |
Y |
|
Hostname |
|
The hostname of the system on which the assessment to which the new result applies was taken (defaults to blank if not set) |
String |
Y |
|
IP_Address |
|
The IP address of system on which the assessment needs to be taken on |
String |
Y |
|
Still_Going |
|
This indicates whether or not the assessment to which the new result applies is still active (defaults to FALSE if not set) |
Boolean |
N |
|
Status |
|
The status of the assessment to which the new result applies: 0 - Started 1 - Running 2 - Finished 3 - Expired 4 - Timed out 5 - Quit (Defaults to 0 - Started if not set) |
Short |
N |
|
Feedback |
|
Indicates whether there is any feedback for the assessment to which the new result applies: 0 - No feedback given 1 - Some feedback given (defaults 0 - No feedback given) |
Short |
N |
|
Number_Sections |
|
The number of question blocks in the assessment to which the new result applies (defaults to 0 if not set) |
Short |
N |
|
Max_Score |
|
The maximum possible score for the assessment to which the new result applies |
Integer |
N |
|
Total_Score |
|
The actual score for the assessment to which the new result applies |
Integer |
N |
|
Special_1 to 10 |
|
These parameters contain information specific to the outcome of the questions in the assessment to which the new result applies (each one defaults to blank if not set) |
String |
Y |
|
Time_Taken |
|
The time taken, in seconds, between the start and end of the assessment to which the new result applies, should be set to 0 if the assessment is still active (defaults to 0 if not set) |
Integer |
N |
|
Score_Band_Title |
|
The title of the assessment outcome relevant to the assessment to which the new result applies (defaults to blank if not set) |
String |
Y |
|
Score_Band_Number |
|
The number of the assessment outcome relevant to the assessment to which the new result applies (defaults to 0 if not set) |
Integer |
N |
|
Percentage_Score |
|
The percentage score for the assessment to which the new result applies |
Short |
N |
|
Schedule_Name |
|
The name of the schedule related to the assessment to which the new result applies (defaults to blank if not set) |
String |
Y |
|
Monitored |
|
This indicates whether the assessment to which the new result applies is monitored (defaults to FALSE if not set) |
Boolean |
N |
|
Monitor_Name |
|
If the assessment to which the new result applies is monitored, this contains the name of the proctor or invigilator who performs the assessment monitoring (defaults to blank if not set) |
String |
Y |
|
TopicScoringList |
|
This parameter (if used) is in the form of sets of topic information, as detailed below |
|
Y |
|
|
Topic_ID |
The unique topic ID of the topic or subtopic that a question in the assessment to which the new result applies was selected from (required each time TopicScoringList is used, optional if TopicScoringList is not used) |
String |
Y |
|
|
Topic_Name |
The topic name of the topic or subtopic that a question in the assessment to which the new result applies was selected from (required each time TopicScoringList is used, optional if TopicScoringList is not used) |
String |
Y |
|
|
Description |
A description or comment for a topic or subtopic in the assessment to which the new result applies (defaults to blank if not set) |
String |
Y |
|
|
Percentage_Score |
The percentage score for a topic or subtopic in the assessment to which the new result applies (required each time TopicScoringList is used, optional if TopicScoringList is not used) |
Double |
N |
|
|
Actual_Score |
The actual score for a topic or subtopic in the assessment to which the new result applies (required each time TopicScoringList is used, optional if TopicScoringList is not used) |
Integer |
N |
|
|
Maximum_Score |
The greatest attainable score for a topic or subtopic in the assessment to which the new result applies (required each time TopicScoringList is used, optional if TopicScoringList is not used) |
Integer |
N |
|
|
Num_Questions |
The number of questions presented for a topic or subtopic in the assessment to which the new result applies (required each time TopicScoringList is used, optional if TopicScoringList is not used) |
Integer |
N |
|
When_Started |
The date on which the new result is created (defaults to the current date if not set) |
String |
Y |
|
|
Session_Last_Modified |
|
The date on which the assessment to which the new result applies was last modified (defaults to the current date if not set) |
String |
Y |
|
When_Finished |
|
The date on which the assessment to which the new result applies finished, or when it was last updated if it is still going (defaults to the current date if not set) |
String |
Y |
|
ParticipantList |
|
|
String |
Y |
|
FirstName |
The first name of the participant |
String |
Y |
|
|
LastName |
Last name of the participant |
String |
Y |
|
|
PrimaryEmailAddress |
Email address of the participant |
String |
Y |
|
|
SubgroupPath |
|
String |
Y |
|
CourseProperty |
|
String |
Y |
||
|
ScoreBandIDProperty |
|
Integer |
Y |
|
Base |
Identifies if the assessment result is the base language |
Boolean |
Y |
||
Language |
Identifies the language of the result |
String |
Y |
||
|
Feedback |
|
The feedback given by the assessment outcome relevant to the assessment to which the new result applies (defaults to blank if not set) |
String |
Y |
|
AnswerList |
|
|
|
|
|
|
Question_ID |
The question ID of a question in the assessment to which the new result applies (required each time AnswerList is used, optional if TopicScoringList is not used) |
String |
Y |
|
|
Revision |
The revision number of a question in the assessment to which the new result applies (defaults to 1 if not set) |
Integer |
N |
|
|
Occurence |
If the same question appears in the assessment to which the new result applies more than once, this is the questions Occurrence number (defaults to 1 if not set) |
Short |
Y |
|
|
Topic_Name |
The topic name of the topic or subtopic that a question in the assessment to which the new result applies was selected from (required each time AnswerList is used, optional if TopicScoringList is not used) |
String |
N |
|
|
Block_Number |
The number of the question block for a question in the assessment to which the new result applies (required each time AnswerList is used, optional if TopicScoringList is not used) |
Short |
N |
|
|
Question_Number |
The number the participant sees for a question in the assessment to which the new result applies (required each time AnswerList is used, optional if TopicScoringList is not used) |
Short |
N |
|
|
Status |
The status of a question in the assessment to which the new result applies: 0 - Normal 1 - Retired 2 - Incomplete (defaults to 0 Normal if not set) |
Short |
Y |
|
|
Times_Answered |
The number of times that a question in the assessment to which the new result applies was answered (defaults to 1 if not set) |
Short |
Y |
|
|
Max_Score |
The greatest attainable score for a question in the assessment to which the new result applies (required each time AnswerList is used, optional if TopicScoringList is not used) |
Integer |
N |
|
|
Actual_Score |
The actual score attained for a question in the assessment to which the new result applies (required each time AnswerList is used, optional if TopicScoringList is not used) |
Integer |
N |
|
|
Know_Time_Taken |
This indicates whether the Time_Taken to answer a question in the assessment to which the new result applies is known (defaults to FALSE if not set) |
Boolean |
Y |
|
|
Time_Taken |
The number of seconds that the participant took to answer a question in the assessment to which the new result applies (defaults to 0 if not set) |
Integer |
Y |
|
|
Number_Outcomes |
The number of distinct question outcomes available for a question in the assessment to which the new result applies (defaults to 0 if not set) |
Short |
Y |
|
|
Outcome_Number |
The number of the question outcome first selected for a question in the assessment to which the new result applies (defaults to 0 if not set) |
Short |
Y |
|
|
Outcome_Exponential |
For a question in the assessment to which the new result applies, this is calculated as follows:
This field is only calculated when there are not more than 32 outcomes (defaults to 0 if not set) |
Integer |
Y |
|
|
Answer_Truncated |
This is the first 50 characters of the answer to a question in the assessment to which the new result applies (defaults to blank if not set) |
String |
Y |
|
|
Answer_Full |
This is the complete answer to a question in the assessment to which the new result applies (defaults to blank if not set) |
String |
Y |
|
|
Comment |
This is the comment entered by a participant for a question in the assessment to which the new result applies (defaults to blank if not set) |
String |
Y |
|
|
Outcome_Exponential2Property |
For a question in the assessment to which the new result applies, this is calculated as follows:
This field is only calculated when there are more than 32 and less than 64 outcomes (defaults to 0 if not set) |
Integer |
Y |
|
LMSDetails |
|
|
|
|
|
|
SessionID |
The session identifier used by the LMS |
String |
Y |
|
|
LMSURL |
URL to use in HACP communication with the LMS |
String |
Y |
|
|
Password |
An optional LMS password |
String |
Y |
Response
Output name | Description | Data type |
---|---|---|
Result_ID |
The Result_ID for the information that was entered |
String |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.