POST api/v1/LiveQuizEvent/ValidateLiveEventPasscode?canNotify={canNotify}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
canNotify

boolean

Default value is True

Body Parameters

EventPassCode
NameDescriptionTypeAdditional information
Passcode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Passcode": "sample string 1"
}

text/html

Sample:
{"Passcode":"sample string 1"}

text/xml

Sample:
<EventPassCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <Passcode>sample string 1</Passcode>
</EventPassCode>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LiveQuizEventValidateInfo
NameDescriptionTypeAdditional information
IsExpired

boolean

None.

ShotClassId

string

None.

UserRole

string

None.

ErrorMessage

string

None.

TotalQuestionAttempedBytheUser

integer

None.

Passcode

string

None.

TotalCorrectQuestion

integer

None.

TotalQuestion

integer

None.

LiveEventAnswerDuration

integer

None.

TotalWinner

integer

None.

TotalGP

integer

None.

TrainingMode

string

None.

QuestionStartDuration

integer

None.

IsInstructorLoggedIn

boolean

None.

TotalParticipantCount

integer

None.

IsInstructorStartedQuiz

boolean

None.

InstructorUserId

integer

None.

CurrentQuestionId

integer

None.

IsQuestionTerminated

boolean

None.

VirtualOrLiveQuizEventId

integer

None.

IsVirtualOrLiveQuizSubmitted

boolean

None.

NoOfUsersPlayedCurrentQuestion

integer

None.

SignalRNegotiateUrl

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsExpired": true,
  "ShotClassId": "sample string 2",
  "UserRole": "sample string 3",
  "ErrorMessage": "sample string 4",
  "TotalQuestionAttempedBytheUser": 5,
  "Passcode": "sample string 6",
  "TotalCorrectQuestion": 7,
  "TotalQuestion": 8,
  "LiveEventAnswerDuration": 9,
  "TotalWinner": 10,
  "TotalGP": 11,
  "TrainingMode": "sample string 12",
  "QuestionStartDuration": 13,
  "IsInstructorLoggedIn": true,
  "TotalParticipantCount": 15,
  "IsInstructorStartedQuiz": true,
  "InstructorUserId": 17,
  "CurrentQuestionId": 18,
  "IsQuestionTerminated": true,
  "VirtualOrLiveQuizEventId": 20,
  "IsVirtualOrLiveQuizSubmitted": true,
  "NoOfUsersPlayedCurrentQuestion": 22,
  "SignalRNegotiateUrl": "sample string 23"
}

text/html

Sample:
{"IsExpired":true,"ShotClassId":"sample string 2","UserRole":"sample string 3","ErrorMessage":"sample string 4","TotalQuestionAttempedBytheUser":5,"Passcode":"sample string 6","TotalCorrectQuestion":7,"TotalQuestion":8,"LiveEventAnswerDuration":9,"TotalWinner":10,"TotalGP":11,"TrainingMode":"sample string 12","QuestionStartDuration":13,"IsInstructorLoggedIn":true,"TotalParticipantCount":15,"IsInstructorStartedQuiz":true,"InstructorUserId":17,"CurrentQuestionId":18,"IsQuestionTerminated":true,"VirtualOrLiveQuizEventId":20,"IsVirtualOrLiveQuizSubmitted":true,"NoOfUsersPlayedCurrentQuestion":22,"SignalRNegotiateUrl":"sample string 23"}

text/xml

Sample:
<LiveQuizEventValidateInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <CurrentQuestionId>18</CurrentQuestionId>
  <ErrorMessage>sample string 4</ErrorMessage>
  <InstructorUserId>17</InstructorUserId>
  <IsExpired>true</IsExpired>
  <IsInstructorLoggedIn>true</IsInstructorLoggedIn>
  <IsInstructorStartedQuiz>true</IsInstructorStartedQuiz>
  <IsQuestionTerminated>true</IsQuestionTerminated>
  <IsVirtualOrLiveQuizSubmitted>true</IsVirtualOrLiveQuizSubmitted>
  <LiveEventAnswerDuration>9</LiveEventAnswerDuration>
  <NoOfUsersPlayedCurrentQuestion>22</NoOfUsersPlayedCurrentQuestion>
  <Passcode>sample string 6</Passcode>
  <QuestionStartDuration>13</QuestionStartDuration>
  <ShotClassId>sample string 2</ShotClassId>
  <SignalRNegotiateUrl>sample string 23</SignalRNegotiateUrl>
  <TotalCorrectQuestion>7</TotalCorrectQuestion>
  <TotalGP>11</TotalGP>
  <TotalParticipantCount>15</TotalParticipantCount>
  <TotalQuestion>8</TotalQuestion>
  <TotalQuestionAttempedBytheUser>5</TotalQuestionAttempedBytheUser>
  <TotalWinner>10</TotalWinner>
  <TrainingMode>sample string 12</TrainingMode>
  <UserRole>sample string 3</UserRole>
  <VirtualOrLiveQuizEventId>20</VirtualOrLiveQuizEventId>
</LiveQuizEventValidateInfo>