GET api/v3/usergroups/{groupId}/polls/{id}/usage

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
groupId		integer	Required

Body Parameters

None.

Response Information

Resource Description

PollUsageModel

Name	Type	Additional information
PollId	integer	None.
Question	string	None.
PollImageUrl	string	None.
ForumThreadId	integer	None.
TotalUsers	integer	None.
PaticipatedUsers	integer	None.
DistributionId	integer	None.
UserGroupId	integer	None.
Open	boolean	None.
IsMissed	boolean	None.
EndedOn	string	None.
IsResponded	boolean	None.
OptionsList	Collection of string	None.
OptionImagesList	Collection of string	None.
StartDateOfPoll	date	None.
Options	Collection of OptionData	None.
OptionImages	Collection of OptionsImageData	None.
PollGroups	Collection of PollUserGroup	None.
TimeLeft	TimeLeft	None.
PollStartDate	date	None.
PollEndDate	date	None.
Videos	Collection of VideoLibrary	None.
Description	string	None.
DisplayPollResult	boolean	None.
PollTemplateId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "PollId": 1,
  "Question": "sample string 2",
  "PollImageUrl": "sample string 3",
  "ForumThreadId": 1,
  "TotalUsers": 4,
  "PaticipatedUsers": 5,
  "DistributionId": 6,
  "UserGroupId": 1,
  "Open": true,
  "IsMissed": true,
  "EndedOn": "sample string 9",
  "IsResponded": true,
  "OptionsList": [
    "sample string 1",
    "sample string 2"
  ],
  "OptionImagesList": [
    "sample string 1",
    "sample string 2"
  ],
  "StartDateOfPoll": "2024-09-06T09:48:59.6552847Z",
  "Options": [
    {
      "OptionNo": 1,
      "Name": "sample string 2",
      "Count": 3,
      "Percentage": 4.1,
      "IsAnswer": true
    },
    {
      "OptionNo": 1,
      "Name": "sample string 2",
      "Count": 3,
      "Percentage": 4.1,
      "IsAnswer": true
    }
  ],
  "OptionImages": [
    {
      "OptionNo": 1,
      "OptionImageUrl": "sample string 2",
      "IsAnswer": true
    },
    {
      "OptionNo": 1,
      "OptionImageUrl": "sample string 2",
      "IsAnswer": true
    }
  ],
  "PollGroups": [
    {
      "Id": 1,
      "PollId": 2,
      "Name": "sample string 3",
      "StartDate": "2024-09-06T09:48:59.6552847Z",
      "EndDate": "2024-09-06T09:48:59.6552847Z"
    },
    {
      "Id": 1,
      "PollId": 2,
      "Name": "sample string 3",
      "StartDate": "2024-09-06T09:48:59.6552847Z",
      "EndDate": "2024-09-06T09:48:59.6552847Z"
    }
  ],
  "TimeLeft": {
    "Type": "sample string 1",
    "Value": 2
  },
  "PollStartDate": "2024-09-06T09:48:59.6552847Z",
  "PollEndDate": "2024-09-06T09:48:59.6552847Z",
  "Videos": [
    {
      "VideoId": 1,
      "AssetId": "sample string 2",
      "MediaServiceId": "836969d2-6bb8-4e36-b108-453858d1a080",
      "Name": "sample string 4",
      "BlobVideoUrl": "sample string 5",
      "PublishedVideoUrl": "sample string 6",
      "ProgressiveDownloadUrl": "sample string 7",
      "VideoUploadStatus": "sample string 8",
      "VideoDuration": "00:00:00.1234567",
      "IsVideoEncrypted": true,
      "TenantId": 10,
      "CreatedDate": "2024-09-06T09:48:59.6552847Z",
      "CreatedBy": 12,
      "ModifiedDate": "2024-09-06T09:48:59.6552847Z",
      "ModifiedBy": 14,
      "VideoThumbnailBlobUrl": "sample string 15",
      "VideoCreator": "sample string 16"
    },
    {
      "VideoId": 1,
      "AssetId": "sample string 2",
      "MediaServiceId": "836969d2-6bb8-4e36-b108-453858d1a080",
      "Name": "sample string 4",
      "BlobVideoUrl": "sample string 5",
      "PublishedVideoUrl": "sample string 6",
      "ProgressiveDownloadUrl": "sample string 7",
      "VideoUploadStatus": "sample string 8",
      "VideoDuration": "00:00:00.1234567",
      "IsVideoEncrypted": true,
      "TenantId": 10,
      "CreatedDate": "2024-09-06T09:48:59.6552847Z",
      "CreatedBy": 12,
      "ModifiedDate": "2024-09-06T09:48:59.6552847Z",
      "ModifiedBy": 14,
      "VideoThumbnailBlobUrl": "sample string 15",
      "VideoCreator": "sample string 16"
    }
  ],
  "Description": "sample string 12",
  "DisplayPollResult": true,
  "PollTemplateId": 13
}

text/html

Sample:

{"PollId":1,"Question":"sample string 2","PollImageUrl":"sample string 3","ForumThreadId":1,"TotalUsers":4,"PaticipatedUsers":5,"DistributionId":6,"UserGroupId":1,"Open":true,"IsMissed":true,"EndedOn":"sample string 9","IsResponded":true,"OptionsList":["sample string 1","sample string 2"],"OptionImagesList":["sample string 1","sample string 2"],"StartDateOfPoll":"2024-09-06T09:48:59.6552847Z","Options":[{"OptionNo":1,"Name":"sample string 2","Count":3,"Percentage":4.1,"IsAnswer":true},{"OptionNo":1,"Name":"sample string 2","Count":3,"Percentage":4.1,"IsAnswer":true}],"OptionImages":[{"OptionNo":1,"OptionImageUrl":"sample string 2","IsAnswer":true},{"OptionNo":1,"OptionImageUrl":"sample string 2","IsAnswer":true}],"PollGroups":[{"Id":1,"PollId":2,"Name":"sample string 3","StartDate":"2024-09-06T09:48:59.6552847Z","EndDate":"2024-09-06T09:48:59.6552847Z"},{"Id":1,"PollId":2,"Name":"sample string 3","StartDate":"2024-09-06T09:48:59.6552847Z","EndDate":"2024-09-06T09:48:59.6552847Z"}],"TimeLeft":{"Type":"sample string 1","Value":2},"PollStartDate":"2024-09-06T09:48:59.6552847Z","PollEndDate":"2024-09-06T09:48:59.6552847Z","Videos":[{"VideoId":1,"AssetId":"sample string 2","MediaServiceId":"836969d2-6bb8-4e36-b108-453858d1a080","Name":"sample string 4","BlobVideoUrl":"sample string 5","PublishedVideoUrl":"sample string 6","ProgressiveDownloadUrl":"sample string 7","VideoUploadStatus":"sample string 8","VideoDuration":"00:00:00.1234567","IsVideoEncrypted":true,"TenantId":10,"CreatedDate":"2024-09-06T09:48:59.6552847Z","CreatedBy":12,"ModifiedDate":"2024-09-06T09:48:59.6552847Z","ModifiedBy":14,"VideoThumbnailBlobUrl":"sample string 15","VideoCreator":"sample string 16"},{"VideoId":1,"AssetId":"sample string 2","MediaServiceId":"836969d2-6bb8-4e36-b108-453858d1a080","Name":"sample string 4","BlobVideoUrl":"sample string 5","PublishedVideoUrl":"sample string 6","ProgressiveDownloadUrl":"sample string 7","VideoUploadStatus":"sample string 8","VideoDuration":"00:00:00.1234567","IsVideoEncrypted":true,"TenantId":10,"CreatedDate":"2024-09-06T09:48:59.6552847Z","CreatedBy":12,"ModifiedDate":"2024-09-06T09:48:59.6552847Z","ModifiedBy":14,"VideoThumbnailBlobUrl":"sample string 15","VideoCreator":"sample string 16"}],"Description":"sample string 12","DisplayPollResult":true,"PollTemplateId":13}

text/xml

Sample:

<PollUsageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <Description>sample string 12</Description>
  <DisplayPollResult>true</DisplayPollResult>
  <DistributionId>6</DistributionId>
  <EndedOn>sample string 9</EndedOn>
  <ForumThreadId>1</ForumThreadId>
  <IsMissed>true</IsMissed>
  <IsResponded>true</IsResponded>
  <Open>true</Open>
  <OptionImages>
    <OptionsImageData>
      <IsAnswer>true</IsAnswer>
      <OptionImageUrl>sample string 2</OptionImageUrl>
      <OptionNo>1</OptionNo>
    </OptionsImageData>
    <OptionsImageData>
      <IsAnswer>true</IsAnswer>
      <OptionImageUrl>sample string 2</OptionImageUrl>
      <OptionNo>1</OptionNo>
    </OptionsImageData>
  </OptionImages>
  <OptionImagesList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OptionImagesList>
  <Options>
    <OptionData>
      <Count>3</Count>
      <IsAnswer>true</IsAnswer>
      <Name>sample string 2</Name>
      <OptionNo>1</OptionNo>
      <Percentage>4.1</Percentage>
    </OptionData>
    <OptionData>
      <Count>3</Count>
      <IsAnswer>true</IsAnswer>
      <Name>sample string 2</Name>
      <OptionNo>1</OptionNo>
      <Percentage>4.1</Percentage>
    </OptionData>
  </Options>
  <OptionsList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OptionsList>
  <PaticipatedUsers>5</PaticipatedUsers>
  <PollEndDate>2024-09-06T09:48:59.6552847Z</PollEndDate>
  <PollGroups>
    <PollUserGroup>
      <EndDate>2024-09-06T09:48:59.6552847Z</EndDate>
      <Id>1</Id>
      <Name>sample string 3</Name>
      <PollId>2</PollId>
      <StartDate>2024-09-06T09:48:59.6552847Z</StartDate>
    </PollUserGroup>
    <PollUserGroup>
      <EndDate>2024-09-06T09:48:59.6552847Z</EndDate>
      <Id>1</Id>
      <Name>sample string 3</Name>
      <PollId>2</PollId>
      <StartDate>2024-09-06T09:48:59.6552847Z</StartDate>
    </PollUserGroup>
  </PollGroups>
  <PollId>1</PollId>
  <PollImageUrl>sample string 3</PollImageUrl>
  <PollStartDate>2024-09-06T09:48:59.6552847Z</PollStartDate>
  <PollTemplateId>13</PollTemplateId>
  <Question>sample string 2</Question>
  <StartDateOfPoll>2024-09-06T09:48:59.6552847Z</StartDateOfPoll>
  <TimeLeft>
    <Type>sample string 1</Type>
    <Value>2</Value>
  </TimeLeft>
  <TotalUsers>4</TotalUsers>
  <UserGroupId>1</UserGroupId>
  <Videos>
    <VideoLibrary>
      <AssetId>sample string 2</AssetId>
      <BlobVideoUrl>sample string 5</BlobVideoUrl>
      <CreatedBy>12</CreatedBy>
      <CreatedDate>2024-09-06T09:48:59.6552847Z</CreatedDate>
      <IsVideoEncrypted>true</IsVideoEncrypted>
      <MediaServiceId>836969d2-6bb8-4e36-b108-453858d1a080</MediaServiceId>
      <ModifiedBy>14</ModifiedBy>
      <ModifiedDate>2024-09-06T09:48:59.6552847Z</ModifiedDate>
      <Name>sample string 4</Name>
      <ProgressiveDownloadUrl>sample string 7</ProgressiveDownloadUrl>
      <PublishedVideoUrl>sample string 6</PublishedVideoUrl>
      <TenantId>10</TenantId>
      <VideoCreator>sample string 16</VideoCreator>
      <VideoDuration>PT0.1234567S</VideoDuration>
      <VideoId>1</VideoId>
      <VideoThumbnailBlobUrl>sample string 15</VideoThumbnailBlobUrl>
      <VideoUploadStatus>sample string 8</VideoUploadStatus>
    </VideoLibrary>
    <VideoLibrary>
      <AssetId>sample string 2</AssetId>
      <BlobVideoUrl>sample string 5</BlobVideoUrl>
      <CreatedBy>12</CreatedBy>
      <CreatedDate>2024-09-06T09:48:59.6552847Z</CreatedDate>
      <IsVideoEncrypted>true</IsVideoEncrypted>
      <MediaServiceId>836969d2-6bb8-4e36-b108-453858d1a080</MediaServiceId>
      <ModifiedBy>14</ModifiedBy>
      <ModifiedDate>2024-09-06T09:48:59.6552847Z</ModifiedDate>
      <Name>sample string 4</Name>
      <ProgressiveDownloadUrl>sample string 7</ProgressiveDownloadUrl>
      <PublishedVideoUrl>sample string 6</PublishedVideoUrl>
      <TenantId>10</TenantId>
      <VideoCreator>sample string 16</VideoCreator>
      <VideoDuration>PT0.1234567S</VideoDuration>
      <VideoId>1</VideoId>
      <VideoThumbnailBlobUrl>sample string 15</VideoThumbnailBlobUrl>
      <VideoUploadStatus>sample string 8</VideoUploadStatus>
    </VideoLibrary>
  </Videos>
</PollUsageModel>