GET api/FrequencyReport/Get/{id}?withLimit={withLimit}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

withLimit

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

FrequencyReportViewModel
NameDescriptionTypeAdditional information
Items

Collection of FrequencyBaseItem

None.

CombinedAnswers

Collection of CombinesModelView

None.

ReportHeader

ReportHeader

None.

ExtraSettings

ExtraSettingsForFrequency

None.

ID

integer

None.

Version

integer

None.

ProjectID

integer

None.

ProjectNr

string

None.

Name

string

None.

GUID

string

None.

Filters

Collection of Filter

None.

ApplyWeighting

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "ItemType": "OperationalData",
      "_reportITemType": "Frequency",
      "IsOperationalData": true,
      "GridsterModel": {
        "Row": 1,
        "Column": 2,
        "SizeX": 3,
        "SizeY": 4
      },
      "ReportITemType": "Frequency",
      "MaxAxis": 2,
      "GUID": "sample string 3",
      "Title": "sample string 4",
      "Order": 5,
      "SubTitle": "sample string 6"
    },
    {
      "ItemType": "OperationalData",
      "_reportITemType": "Frequency",
      "IsOperationalData": true,
      "GridsterModel": {
        "Row": 1,
        "Column": 2,
        "SizeX": 3,
        "SizeY": 4
      },
      "ReportITemType": "Frequency",
      "MaxAxis": 2,
      "GUID": "sample string 3",
      "Title": "sample string 4",
      "Order": 5,
      "SubTitle": "sample string 6"
    }
  ],
  "CombinedAnswers": [
    {
      "ID": 1,
      "ReportID": 2,
      "QuestionID": 3,
      "CombinedAnswerIDs": [
        1,
        2
      ],
      "Text": "sample string 4",
      "CustomText": "sample string 5",
      "DisplaySetting": "sample string 6",
      "LabelSetting": "sample string 7",
      "Position": "sample string 8",
      "StartPosition": 1,
      "Type": "sample string 9",
      "Rollup": true,
      "ItemGUID": "sample string 11",
      "QuestionType": "sample string 12"
    },
    {
      "ID": 1,
      "ReportID": 2,
      "QuestionID": 3,
      "CombinedAnswerIDs": [
        1,
        2
      ],
      "Text": "sample string 4",
      "CustomText": "sample string 5",
      "DisplaySetting": "sample string 6",
      "LabelSetting": "sample string 7",
      "Position": "sample string 8",
      "StartPosition": 1,
      "Type": "sample string 9",
      "Rollup": true,
      "ItemGUID": "sample string 11",
      "QuestionType": "sample string 12"
    }
  ],
  "ReportHeader": {
    "Title": "sample string 1",
    "SubTitle": "sample string 2",
    "Image": "sample string 3"
  },
  "ExtraSettings": {
    "LayoutMode": true,
    "Rights": "Private",
    "MeanScore": true,
    "Respondents": "RespondentsThatAnsweredQuestion"
  },
  "ID": 1,
  "Version": 2,
  "ProjectID": 3,
  "ProjectNr": "sample string 4",
  "Name": "sample string 5",
  "GUID": "sample string 6",
  "Filters": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "Text": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "Text": "sample string 3"
    }
  ],
  "ApplyWeighting": true
}

text/plain

Sample:
{"Items":[{"ItemType":"OperationalData","_reportITemType":"Frequency","IsOperationalData":true,"GridsterModel":{"Row":1,"Column":2,"SizeX":3,"SizeY":4},"ReportITemType":"Frequency","MaxAxis":2,"GUID":"sample string 3","Title":"sample string 4","Order":5,"SubTitle":"sample string 6"},{"ItemType":"OperationalData","_reportITemType":"Frequency","IsOperationalData":true,"GridsterModel":{"Row":1,"Column":2,"SizeX":3,"SizeY":4},"ReportITemType":"Frequency","MaxAxis":2,"GUID":"sample string 3","Title":"sample string 4","Order":5,"SubTitle":"sample string 6"}],"CombinedAnswers":[{"ID":1,"ReportID":2,"QuestionID":3,"CombinedAnswerIDs":[1,2],"Text":"sample string 4","CustomText":"sample string 5","DisplaySetting":"sample string 6","LabelSetting":"sample string 7","Position":"sample string 8","StartPosition":1,"Type":"sample string 9","Rollup":true,"ItemGUID":"sample string 11","QuestionType":"sample string 12"},{"ID":1,"ReportID":2,"QuestionID":3,"CombinedAnswerIDs":[1,2],"Text":"sample string 4","CustomText":"sample string 5","DisplaySetting":"sample string 6","LabelSetting":"sample string 7","Position":"sample string 8","StartPosition":1,"Type":"sample string 9","Rollup":true,"ItemGUID":"sample string 11","QuestionType":"sample string 12"}],"ReportHeader":{"Title":"sample string 1","SubTitle":"sample string 2","Image":"sample string 3"},"ExtraSettings":{"LayoutMode":true,"Rights":"Private","MeanScore":true,"Respondents":"RespondentsThatAnsweredQuestion"},"ID":1,"Version":2,"ProjectID":3,"ProjectNr":"sample string 4","Name":"sample string 5","GUID":"sample string 6","Filters":[{"Name":"sample string 1","Value":"sample string 2","Text":"sample string 3"},{"Name":"sample string 1","Value":"sample string 2","Text":"sample string 3"}],"ApplyWeighting":true}

application/xml, text/xml

Sample:
<FrequencyReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model.Frequency">
  <ApplyWeighting xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">true</ApplyWeighting>
  <Filters xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">
    <Filter>
      <Name>sample string 1</Name>
      <Text>sample string 3</Text>
      <Value>sample string 2</Value>
    </Filter>
    <Filter>
      <Name>sample string 1</Name>
      <Text>sample string 3</Text>
      <Value>sample string 2</Value>
    </Filter>
  </Filters>
  <GUID xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 6</GUID>
  <ID xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">1</ID>
  <Name xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 5</Name>
  <ProjectID xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">3</ProjectID>
  <ProjectNr xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 4</ProjectNr>
  <Version xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">2</Version>
  <CombinedAnswers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">
    <d2p1:CombinesModelView>
      <d2p1:CombinedAnswerIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:CombinedAnswerIDs>
      <d2p1:CustomText>sample string 5</d2p1:CustomText>
      <d2p1:DisplaySetting>sample string 6</d2p1:DisplaySetting>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:ItemGUID>sample string 11</d2p1:ItemGUID>
      <d2p1:LabelSetting>sample string 7</d2p1:LabelSetting>
      <d2p1:Position>sample string 8</d2p1:Position>
      <d2p1:QuestionID>3</d2p1:QuestionID>
      <d2p1:QuestionType>sample string 12</d2p1:QuestionType>
      <d2p1:ReportID>2</d2p1:ReportID>
      <d2p1:Rollup>true</d2p1:Rollup>
      <d2p1:StartPosition>1</d2p1:StartPosition>
      <d2p1:Text>sample string 4</d2p1:Text>
      <d2p1:Type>sample string 9</d2p1:Type>
    </d2p1:CombinesModelView>
    <d2p1:CombinesModelView>
      <d2p1:CombinedAnswerIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:CombinedAnswerIDs>
      <d2p1:CustomText>sample string 5</d2p1:CustomText>
      <d2p1:DisplaySetting>sample string 6</d2p1:DisplaySetting>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:ItemGUID>sample string 11</d2p1:ItemGUID>
      <d2p1:LabelSetting>sample string 7</d2p1:LabelSetting>
      <d2p1:Position>sample string 8</d2p1:Position>
      <d2p1:QuestionID>3</d2p1:QuestionID>
      <d2p1:QuestionType>sample string 12</d2p1:QuestionType>
      <d2p1:ReportID>2</d2p1:ReportID>
      <d2p1:Rollup>true</d2p1:Rollup>
      <d2p1:StartPosition>1</d2p1:StartPosition>
      <d2p1:Text>sample string 4</d2p1:Text>
      <d2p1:Type>sample string 9</d2p1:Type>
    </d2p1:CombinesModelView>
  </CombinedAnswers>
  <ExtraSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">
    <d2p1:MeanScore>true</d2p1:MeanScore>
    <d2p1:Respondents>RespondentsThatAnsweredQuestion</d2p1:Respondents>
    <d2p1:Rights>Private</d2p1:Rights>
    <d2p1:LayoutMode>true</d2p1:LayoutMode>
  </ExtraSettings>
  <Items>
    <FrequencyBaseItem>
      <GUID xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 3</GUID>
      <Order xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">5</Order>
      <SubTitle xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 6</SubTitle>
      <Title xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 4</Title>
      <GridsterModel>
        <Column>2</Column>
        <Row>1</Row>
        <SizeX>3</SizeX>
        <SizeY>4</SizeY>
      </GridsterModel>
      <IsOperationalData>true</IsOperationalData>
      <ItemType>OperationalData</ItemType>
      <MaxAxis>2</MaxAxis>
      <ReportITemType>Frequency</ReportITemType>
      <_reportITemType>Frequency</_reportITemType>
    </FrequencyBaseItem>
    <FrequencyBaseItem>
      <GUID xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 3</GUID>
      <Order xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">5</Order>
      <SubTitle xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 6</SubTitle>
      <Title xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model">sample string 4</Title>
      <GridsterModel>
        <Column>2</Column>
        <Row>1</Row>
        <SizeX>3</SizeX>
        <SizeY>4</SizeY>
      </GridsterModel>
      <IsOperationalData>true</IsOperationalData>
      <ItemType>OperationalData</ItemType>
      <MaxAxis>2</MaxAxis>
      <ReportITemType>Frequency</ReportITemType>
      <_reportITemType>Frequency</_reportITemType>
    </FrequencyBaseItem>
  </Items>
  <ReportHeader>
    <Image>sample string 3</Image>
    <SubTitle>sample string 2</SubTitle>
    <Title>sample string 1</Title>
  </ReportHeader>
</FrequencyReportViewModel>