GET 360/CommentContainer/Single?responseId={responseId}&sourceId={sourceId}&search={search}

Gets a single CommentContainer for provided responseId, sourceId and highlights text in search term

Request Information

URI Parameters

Name	Description	Type	Additional information
responseId	The id of the response to return	string	Required
sourceId	The source that the response belongs to	string	Required
search	Any search criteria that was used to find response - used to highlight text that met the search criteria	string

Body Parameters

None.

Response Information

Resource Description

SMG.Rosetta.Contracts.Comments.CommentContainer

Response Formats

application/json, text/json

Sample:

{
  "Details": [
    {
      "ReceivedDate": "2024-04-25T11:31:56.1698594-05:00",
      "EventDate": "2024-04-25T11:31:56.1698594-05:00",
      "UnitName": "sample string 3",
      "UnitId": 1,
      "Comments": [
        {
          "Tags": [
            {
              "PropertyType": "Theme",
              "Text": "sample string 1"
            },
            {
              "PropertyType": "Theme",
              "Text": "sample string 1"
            }
          ],
          "Language": "sample string 1",
          "Text": "sample string 2",
          "Measure": "sample string 3",
          "Sentiment": 1,
          "AudioFilePath": "sample string 4"
        },
        {
          "Tags": [
            {
              "PropertyType": "Theme",
              "Text": "sample string 1"
            },
            {
              "PropertyType": "Theme",
              "Text": "sample string 1"
            }
          ],
          "Language": "sample string 1",
          "Text": "sample string 2",
          "Measure": "sample string 3",
          "Sentiment": 1,
          "AudioFilePath": "sample string 4"
        }
      ],
      "SourceType": "sample string 4",
      "SourceName": "sample string 5",
      "SurveyId": 6,
      "SourceId": "sample string 7",
      "Attributes": [
        {
          "MeasureName": "sample string 1",
          "Value": {},
          "DisplayType": "NotSpecified",
          "DisplayValue": "sample string 3"
        },
        {
          "MeasureName": "sample string 1",
          "Value": {},
          "DisplayType": "NotSpecified",
          "DisplayValue": "sample string 3"
        }
      ],
      "HeaderAttributes": [
        {
          "MeasureName": "sample string 1",
          "Value": {},
          "DisplayType": "NotSpecified",
          "DisplayValue": "sample string 3"
        },
        {
          "MeasureName": "sample string 1",
          "Value": {},
          "DisplayType": "NotSpecified",
          "DisplayValue": "sample string 3"
        }
      ],
      "ResponseId": "sample string 8",
      "HasBeenRead": true,
      "ZoneContinent": 1,
      "Zone0": 1,
      "Zone1": 1,
      "Zone2": 1
    },
    {
      "ReceivedDate": "2024-04-25T11:31:56.1698594-05:00",
      "EventDate": "2024-04-25T11:31:56.1698594-05:00",
      "UnitName": "sample string 3",
      "UnitId": 1,
      "Comments": [
        {
          "Tags": [
            {
              "PropertyType": "Theme",
              "Text": "sample string 1"
            },
            {
              "PropertyType": "Theme",
              "Text": "sample string 1"
            }
          ],
          "Language": "sample string 1",
          "Text": "sample string 2",
          "Measure": "sample string 3",
          "Sentiment": 1,
          "AudioFilePath": "sample string 4"
        },
        {
          "Tags": [
            {
              "PropertyType": "Theme",
              "Text": "sample string 1"
            },
            {
              "PropertyType": "Theme",
              "Text": "sample string 1"
            }
          ],
          "Language": "sample string 1",
          "Text": "sample string 2",
          "Measure": "sample string 3",
          "Sentiment": 1,
          "AudioFilePath": "sample string 4"
        }
      ],
      "SourceType": "sample string 4",
      "SourceName": "sample string 5",
      "SurveyId": 6,
      "SourceId": "sample string 7",
      "Attributes": [
        {
          "MeasureName": "sample string 1",
          "Value": {},
          "DisplayType": "NotSpecified",
          "DisplayValue": "sample string 3"
        },
        {
          "MeasureName": "sample string 1",
          "Value": {},
          "DisplayType": "NotSpecified",
          "DisplayValue": "sample string 3"
        }
      ],
      "HeaderAttributes": [
        {
          "MeasureName": "sample string 1",
          "Value": {},
          "DisplayType": "NotSpecified",
          "DisplayValue": "sample string 3"
        },
        {
          "MeasureName": "sample string 1",
          "Value": {},
          "DisplayType": "NotSpecified",
          "DisplayValue": "sample string 3"
        }
      ],
      "ResponseId": "sample string 8",
      "HasBeenRead": true,
      "ZoneContinent": 1,
      "Zone0": 1,
      "Zone1": 1,
      "Zone2": 1
    }
  ],
  "SourceOffsets": [
    {
      "SourceId": "sample string 1",
      "Offset": 2
    },
    {
      "SourceId": "sample string 1",
      "Offset": 2
    }
  ]
}

application/xml, text/xml

Sample:

<CommentContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMG.Rosetta.Contracts.Comments">
  <Details>
    <CommentDetail>
      <Attributes>
        <Attribute>
          <DisplayType>NotSpecified</DisplayType>
          <DisplayValue>sample string 3</DisplayValue>
          <MeasureName>sample string 1</MeasureName>
          <Value />
        </Attribute>
        <Attribute>
          <DisplayType>NotSpecified</DisplayType>
          <DisplayValue>sample string 3</DisplayValue>
          <MeasureName>sample string 1</MeasureName>
          <Value />
        </Attribute>
      </Attributes>
      <Comments>
        <Comment>
          <AudioFilePath>sample string 4</AudioFilePath>
          <Language>sample string 1</Language>
          <Measure>sample string 3</Measure>
          <Sentiment>1</Sentiment>
          <Tags>
            <Tag>
              <PropertyType>Theme</PropertyType>
              <Text>sample string 1</Text>
            </Tag>
            <Tag>
              <PropertyType>Theme</PropertyType>
              <Text>sample string 1</Text>
            </Tag>
          </Tags>
          <Text>sample string 2</Text>
        </Comment>
        <Comment>
          <AudioFilePath>sample string 4</AudioFilePath>
          <Language>sample string 1</Language>
          <Measure>sample string 3</Measure>
          <Sentiment>1</Sentiment>
          <Tags>
            <Tag>
              <PropertyType>Theme</PropertyType>
              <Text>sample string 1</Text>
            </Tag>
            <Tag>
              <PropertyType>Theme</PropertyType>
              <Text>sample string 1</Text>
            </Tag>
          </Tags>
          <Text>sample string 2</Text>
        </Comment>
      </Comments>
      <EventDate>2024-04-25T11:31:56.1698594-05:00</EventDate>
      <HasBeenRead>true</HasBeenRead>
      <HeaderAttributes>
        <Attribute>
          <DisplayType>NotSpecified</DisplayType>
          <DisplayValue>sample string 3</DisplayValue>
          <MeasureName>sample string 1</MeasureName>
          <Value />
        </Attribute>
        <Attribute>
          <DisplayType>NotSpecified</DisplayType>
          <DisplayValue>sample string 3</DisplayValue>
          <MeasureName>sample string 1</MeasureName>
          <Value />
        </Attribute>
      </HeaderAttributes>
      <ReceivedDate>2024-04-25T11:31:56.1698594-05:00</ReceivedDate>
      <ResponseId>sample string 8</ResponseId>
      <SourceId>sample string 7</SourceId>
      <SourceName>sample string 5</SourceName>
      <SourceType>sample string 4</SourceType>
      <SurveyId>6</SurveyId>
      <UnitId>1</UnitId>
      <UnitName>sample string 3</UnitName>
      <Zone0>1</Zone0>
      <Zone1>1</Zone1>
      <Zone2>1</Zone2>
      <ZoneContinent>1</ZoneContinent>
    </CommentDetail>
    <CommentDetail>
      <Attributes>
        <Attribute>
          <DisplayType>NotSpecified</DisplayType>
          <DisplayValue>sample string 3</DisplayValue>
          <MeasureName>sample string 1</MeasureName>
          <Value />
        </Attribute>
        <Attribute>
          <DisplayType>NotSpecified</DisplayType>
          <DisplayValue>sample string 3</DisplayValue>
          <MeasureName>sample string 1</MeasureName>
          <Value />
        </Attribute>
      </Attributes>
      <Comments>
        <Comment>
          <AudioFilePath>sample string 4</AudioFilePath>
          <Language>sample string 1</Language>
          <Measure>sample string 3</Measure>
          <Sentiment>1</Sentiment>
          <Tags>
            <Tag>
              <PropertyType>Theme</PropertyType>
              <Text>sample string 1</Text>
            </Tag>
            <Tag>
              <PropertyType>Theme</PropertyType>
              <Text>sample string 1</Text>
            </Tag>
          </Tags>
          <Text>sample string 2</Text>
        </Comment>
        <Comment>
          <AudioFilePath>sample string 4</AudioFilePath>
          <Language>sample string 1</Language>
          <Measure>sample string 3</Measure>
          <Sentiment>1</Sentiment>
          <Tags>
            <Tag>
              <PropertyType>Theme</PropertyType>
              <Text>sample string 1</Text>
            </Tag>
            <Tag>
              <PropertyType>Theme</PropertyType>
              <Text>sample string 1</Text>
            </Tag>
          </Tags>
          <Text>sample string 2</Text>
        </Comment>
      </Comments>
      <EventDate>2024-04-25T11:31:56.1698594-05:00</EventDate>
      <HasBeenRead>true</HasBeenRead>
      <HeaderAttributes>
        <Attribute>
          <DisplayType>NotSpecified</DisplayType>
          <DisplayValue>sample string 3</DisplayValue>
          <MeasureName>sample string 1</MeasureName>
          <Value />
        </Attribute>
        <Attribute>
          <DisplayType>NotSpecified</DisplayType>
          <DisplayValue>sample string 3</DisplayValue>
          <MeasureName>sample string 1</MeasureName>
          <Value />
        </Attribute>
      </HeaderAttributes>
      <ReceivedDate>2024-04-25T11:31:56.1698594-05:00</ReceivedDate>
      <ResponseId>sample string 8</ResponseId>
      <SourceId>sample string 7</SourceId>
      <SourceName>sample string 5</SourceName>
      <SourceType>sample string 4</SourceType>
      <SurveyId>6</SurveyId>
      <UnitId>1</UnitId>
      <UnitName>sample string 3</UnitName>
      <Zone0>1</Zone0>
      <Zone1>1</Zone1>
      <Zone2>1</Zone2>
      <ZoneContinent>1</ZoneContinent>
    </CommentDetail>
  </Details>
  <SourceOffsets xmlns:d2p1="http://schemas.datacontract.org/2004/07/SMG.Rosetta.Contracts.Report.CommentReport">
    <d2p1:SourceOffset>
      <d2p1:Offset>2</d2p1:Offset>
      <d2p1:SourceId>sample string 1</d2p1:SourceId>
    </d2p1:SourceOffset>
    <d2p1:SourceOffset>
      <d2p1:Offset>2</d2p1:Offset>
      <d2p1:SourceId>sample string 1</d2p1:SourceId>
    </d2p1:SourceOffset>
  </SourceOffsets>
</CommentContainer>