POST api/docQuizInstance/submit
Submit a QuizInstance for scoring and recording
Request Information
URI Parameters
None.
Body Parameters
docQuizInstanceEx| Name | Description | Type | Additional information |
|---|---|---|---|
| Questions | Collection of docQuizQuestionEx |
None. |
|
| InstanceID | integer |
None. |
|
| QuizID | integer |
Required |
|
| AssignmentID | integer |
Required |
|
| PersonID | integer |
Required |
|
| WarehouseID | integer |
Required |
|
| VersionID | integer |
Required |
|
| InstanceStartDate | date |
None. |
|
| InstanceEndDate | date |
None. |
|
| ResultPercent | decimal number |
None. |
|
| RequiredScore | decimal number |
None. |
|
| Detail | string |
None. |
|
| results | Collection of ValidationResult |
None. |
Request Formats
application/json, text/json
Sample:
{
"results": null,
"Questions": [
{
"results": null,
"Responses": [
{
"results": null,
"ResponseID": 1,
"QuestionID": 2,
"Sequence": 3,
"Text": "sample string 4",
"IsCorrect": true,
"IsSelected": true,
"Notes": "sample string 6",
"CreatedBy": 7,
"CreatedDate": "2025-12-06T23:39:30.3664136+00:00",
"UpdatedBy": 9,
"UpdatedDate": "2025-12-06T23:39:30.3664136+00:00"
},
{
"results": null,
"ResponseID": 1,
"QuestionID": 2,
"Sequence": 3,
"Text": "sample string 4",
"IsCorrect": true,
"IsSelected": true,
"Notes": "sample string 6",
"CreatedBy": 7,
"CreatedDate": "2025-12-06T23:39:30.3664136+00:00",
"UpdatedBy": 9,
"UpdatedDate": "2025-12-06T23:39:30.3664136+00:00"
}
],
"QuestionID": 1,
"QuizID": 2,
"Sequence": 3,
"Text": "sample string 4",
"Notes": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "2025-12-06T23:39:30.3664136+00:00",
"UpdatedBy": 8,
"UpdatedDate": "2025-12-06T23:39:30.3664136+00:00"
},
{
"results": null,
"Responses": [
{
"results": null,
"ResponseID": 1,
"QuestionID": 2,
"Sequence": 3,
"Text": "sample string 4",
"IsCorrect": true,
"IsSelected": true,
"Notes": "sample string 6",
"CreatedBy": 7,
"CreatedDate": "2025-12-06T23:39:30.3664136+00:00",
"UpdatedBy": 9,
"UpdatedDate": "2025-12-06T23:39:30.3664136+00:00"
},
{
"results": null,
"ResponseID": 1,
"QuestionID": 2,
"Sequence": 3,
"Text": "sample string 4",
"IsCorrect": true,
"IsSelected": true,
"Notes": "sample string 6",
"CreatedBy": 7,
"CreatedDate": "2025-12-06T23:39:30.3664136+00:00",
"UpdatedBy": 9,
"UpdatedDate": "2025-12-06T23:39:30.3664136+00:00"
}
],
"QuestionID": 1,
"QuizID": 2,
"Sequence": 3,
"Text": "sample string 4",
"Notes": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "2025-12-06T23:39:30.3664136+00:00",
"UpdatedBy": 8,
"UpdatedDate": "2025-12-06T23:39:30.3664136+00:00"
}
],
"InstanceID": 1,
"QuizID": 2,
"AssignmentID": 3,
"PersonID": 4,
"WarehouseID": 5,
"VersionID": 6,
"InstanceStartDate": "2025-12-06T23:39:30.3664136+00:00",
"InstanceEndDate": "2025-12-06T23:39:30.3664136+00:00",
"ResultPercent": 1.0,
"RequiredScore": 7.0,
"Detail": "sample string 8"
}
application/xml, text/xml
Sample:
<docQuizInstanceEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
<results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<AssignmentID>3</AssignmentID>
<Detail>sample string 8</Detail>
<InstanceEndDate>2025-12-06T23:39:30.3664136+00:00</InstanceEndDate>
<InstanceID>1</InstanceID>
<InstanceStartDate>2025-12-06T23:39:30.3664136+00:00</InstanceStartDate>
<PersonID>4</PersonID>
<QuizID>2</QuizID>
<RequiredScore>7</RequiredScore>
<ResultPercent>1</ResultPercent>
<VersionID>6</VersionID>
<WarehouseID>5</WarehouseID>
<Questions>
<docQuizQuestionEx>
<results xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<CreatedBy>6</CreatedBy>
<CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2025-12-06T23:39:30.3664136Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</CreatedDate>
<Notes>sample string 5</Notes>
<QuestionID>1</QuestionID>
<QuizID>2</QuizID>
<Sequence>3</Sequence>
<Text>sample string 4</Text>
<UpdatedBy>8</UpdatedBy>
<UpdatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2025-12-06T23:39:30.3664136Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</UpdatedDate>
<Responses>
<docQuizResponseDb>
<results xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<CreatedBy>7</CreatedBy>
<CreatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>2025-12-06T23:39:30.3664136Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</CreatedDate>
<IsCorrect>true</IsCorrect>
<IsSelected>true</IsSelected>
<Notes>sample string 6</Notes>
<QuestionID>2</QuestionID>
<ResponseID>1</ResponseID>
<Sequence>3</Sequence>
<Text>sample string 4</Text>
<UpdatedBy>9</UpdatedBy>
<UpdatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>2025-12-06T23:39:30.3664136Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</UpdatedDate>
</docQuizResponseDb>
<docQuizResponseDb>
<results xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<CreatedBy>7</CreatedBy>
<CreatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>2025-12-06T23:39:30.3664136Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</CreatedDate>
<IsCorrect>true</IsCorrect>
<IsSelected>true</IsSelected>
<Notes>sample string 6</Notes>
<QuestionID>2</QuestionID>
<ResponseID>1</ResponseID>
<Sequence>3</Sequence>
<Text>sample string 4</Text>
<UpdatedBy>9</UpdatedBy>
<UpdatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>2025-12-06T23:39:30.3664136Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</UpdatedDate>
</docQuizResponseDb>
</Responses>
</docQuizQuestionEx>
<docQuizQuestionEx>
<results xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<CreatedBy>6</CreatedBy>
<CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2025-12-06T23:39:30.3664136Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</CreatedDate>
<Notes>sample string 5</Notes>
<QuestionID>1</QuestionID>
<QuizID>2</QuizID>
<Sequence>3</Sequence>
<Text>sample string 4</Text>
<UpdatedBy>8</UpdatedBy>
<UpdatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2025-12-06T23:39:30.3664136Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</UpdatedDate>
<Responses>
<docQuizResponseDb>
<results xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<CreatedBy>7</CreatedBy>
<CreatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>2025-12-06T23:39:30.3664136Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</CreatedDate>
<IsCorrect>true</IsCorrect>
<IsSelected>true</IsSelected>
<Notes>sample string 6</Notes>
<QuestionID>2</QuestionID>
<ResponseID>1</ResponseID>
<Sequence>3</Sequence>
<Text>sample string 4</Text>
<UpdatedBy>9</UpdatedBy>
<UpdatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>2025-12-06T23:39:30.3664136Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</UpdatedDate>
</docQuizResponseDb>
<docQuizResponseDb>
<results xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<CreatedBy>7</CreatedBy>
<CreatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>2025-12-06T23:39:30.3664136Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</CreatedDate>
<IsCorrect>true</IsCorrect>
<IsSelected>true</IsSelected>
<Notes>sample string 6</Notes>
<QuestionID>2</QuestionID>
<ResponseID>1</ResponseID>
<Sequence>3</Sequence>
<Text>sample string 4</Text>
<UpdatedBy>9</UpdatedBy>
<UpdatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>2025-12-06T23:39:30.3664136Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</UpdatedDate>
</docQuizResponseDb>
</Responses>
</docQuizQuestionEx>
</Questions>
</docQuizInstanceEx>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
UpsertRetOfdocQuizInstanceDb| Name | Description | Type | Additional information |
|---|---|---|---|
| returnID | integer |
None. |
|
| results | Collection of ValidationResult |
None. |
|
| returnItem | docQuizInstanceDb |
None. |
|
| displayMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"returnID": 1,
"results": null,
"returnItem": {
"results": null,
"InstanceID": 1,
"QuizID": 2,
"AssignmentID": 3,
"PersonID": 4,
"WarehouseID": 5,
"VersionID": 6,
"InstanceStartDate": "2025-12-06T23:39:30.41085+00:00",
"InstanceEndDate": "2025-12-06T23:39:30.41085+00:00",
"ResultPercent": 1.0,
"RequiredScore": 7.0,
"Detail": "sample string 8"
},
"displayMessage": "sample string 1"
}
application/xml, text/xml
Sample:
<UpsertRetOfdocQuizInstanceDb66KPc_SrH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
<displayMessage>sample string 1</displayMessage>
<results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
<returnID>1</returnID>
<returnItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
<results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
<d2p1:AssignmentID>3</d2p1:AssignmentID>
<d2p1:Detail>sample string 8</d2p1:Detail>
<d2p1:InstanceEndDate>2025-12-06T23:39:30.41085+00:00</d2p1:InstanceEndDate>
<d2p1:InstanceID>1</d2p1:InstanceID>
<d2p1:InstanceStartDate>2025-12-06T23:39:30.41085+00:00</d2p1:InstanceStartDate>
<d2p1:PersonID>4</d2p1:PersonID>
<d2p1:QuizID>2</d2p1:QuizID>
<d2p1:RequiredScore>7</d2p1:RequiredScore>
<d2p1:ResultPercent>1</d2p1:ResultPercent>
<d2p1:VersionID>6</d2p1:VersionID>
<d2p1:WarehouseID>5</d2p1:WarehouseID>
</returnItem>
</UpsertRetOfdocQuizInstanceDb66KPc_SrH>