GET Reporting/Alerts/{projectDefinedId}/{alertId}?language={language}&includeAudioEncodedData={includeAudioEncodedData}

Pulls back all the details for a particular alert given the project and user in the language specified.

Request Information

URI Parameters

Name	Description	Type	Additional information
projectDefinedId	The project defined id.	string	Required
alertId	The Alert Id.	integer	Required
language	The language.	string	Required
includeAudioEncodedData		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Smg.RestApi.Model.Reporting.Alert

Alert information retrieved via username, project defined id, and language

Response Formats

application/json, text/json

Sample:

{
  "HierarchyName": "sample string 1",
  "HierarchyDisplayName": "sample string 2",
  "ResponseTypeDesc": "sample string 3",
  "ResponseTypeID": 4,
  "AlertID": 5,
  "CallDate": "2024-04-24T22:35:27.8135494-05:00",
  "HierarchyDescription": "sample string 7",
  "IsResolved": true,
  "ResolutionCompleteDate": "2024-04-24T22:35:27.8135494-05:00",
  "UID": "sample string 9",
  "VisitDate": "2024-04-24T22:35:27.8135494-05:00",
  "HierarchyNumber": "sample string 10",
  "HierarchySkey": 11,
  "SurveyResponseComments": [
    {
      "CommentId": 1,
      "ResponseId": 2,
      "QuestionId": 3,
      "DateTime": "2024-04-24T22:35:27.8135494-05:00",
      "Skey": 5,
      "Text": "sample string 6",
      "MimeType": "sample string 7",
      "EncodedData": "sample string 8",
      "CommentType": "sample string 9",
      "HierarchyNumber": "sample string 10",
      "HierarchyName": "sample string 11",
      "HierarchyDisplay": "sample string 12",
      "HierarchyDisplayOrderBy": "sample string 13"
    },
    {
      "CommentId": 1,
      "ResponseId": 2,
      "QuestionId": 3,
      "DateTime": "2024-04-24T22:35:27.8135494-05:00",
      "Skey": 5,
      "Text": "sample string 6",
      "MimeType": "sample string 7",
      "EncodedData": "sample string 8",
      "CommentType": "sample string 9",
      "HierarchyNumber": "sample string 10",
      "HierarchyName": "sample string 11",
      "HierarchyDisplay": "sample string 12",
      "HierarchyDisplayOrderBy": "sample string 13"
    }
  ],
  "AlertComments": [
    {
      "DateAdded": "2024-04-24T22:35:27.8135494-05:00",
      "PlacedBy": "sample string 2",
      "CommentText": "sample string 3"
    },
    {
      "DateAdded": "2024-04-24T22:35:27.8135494-05:00",
      "PlacedBy": "sample string 2",
      "CommentText": "sample string 3"
    }
  ],
  "SurveyResult": {
    "Skey": 1,
    "MethodologyId": 2,
    "TermId": 3,
    "Uid": "sample string 4",
    "StoreId": "sample string 5",
    "DateTime": "2024-04-24T22:35:27.8135494-05:00",
    "UnitLocalDateTime": "2024-04-24T22:35:27.8135494-05:00",
    "CallDateTime": "2024-04-24T22:35:27.8135494-05:00",
    "Term": "sample string 9",
    "VisitDate": "2024-04-24T22:35:27.8135494-05:00",
    "ResponseId": 11
  },
  "SurveyResponseValues": [
    {
      "QuestionId": 1,
      "QuestionText": "sample string 2",
      "ResponseColumn": "sample string 3",
      "ResponseValue": "sample string 4"
    },
    {
      "QuestionId": 1,
      "QuestionText": "sample string 2",
      "ResponseColumn": "sample string 3",
      "ResponseValue": "sample string 4"
    }
  ],
  "ResolvedBy": "sample string 12",
  "SetResolutionComplete": true,
  "DataSourceType": "sample string 14"
}

application/xml, text/xml

Sample:

<Alert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model.Reporting">
  <AlertComments>
    <AlertComment>
      <CommentText>sample string 3</CommentText>
      <DateAdded>2024-04-24T22:35:27.8135494-05:00</DateAdded>
      <PlacedBy>sample string 2</PlacedBy>
    </AlertComment>
    <AlertComment>
      <CommentText>sample string 3</CommentText>
      <DateAdded>2024-04-24T22:35:27.8135494-05:00</DateAdded>
      <PlacedBy>sample string 2</PlacedBy>
    </AlertComment>
  </AlertComments>
  <AlertID>5</AlertID>
  <CallDate>2024-04-24T22:35:27.8135494-05:00</CallDate>
  <DataSourceType>sample string 14</DataSourceType>
  <HierarchyDescription>sample string 7</HierarchyDescription>
  <HierarchyDisplayName>sample string 2</HierarchyDisplayName>
  <HierarchyName>sample string 1</HierarchyName>
  <HierarchyNumber>sample string 10</HierarchyNumber>
  <HierarchySkey>11</HierarchySkey>
  <IsResolved>true</IsResolved>
  <ResolutionCompleteDate>2024-04-24T22:35:27.8135494-05:00</ResolutionCompleteDate>
  <ResolvedBy>sample string 12</ResolvedBy>
  <ResponseTypeDesc>sample string 3</ResponseTypeDesc>
  <ResponseTypeID>4</ResponseTypeID>
  <SetResolutionComplete>true</SetResolutionComplete>
  <SurveyResponseComments>
    <Comment>
      <CommentId>1</CommentId>
      <CommentType>sample string 9</CommentType>
      <DateTime>2024-04-24T22:35:27.8135494-05:00</DateTime>
      <EncodedData>sample string 8</EncodedData>
      <HierarchyDisplay>sample string 12</HierarchyDisplay>
      <HierarchyDisplayOrderBy>sample string 13</HierarchyDisplayOrderBy>
      <HierarchyName>sample string 11</HierarchyName>
      <HierarchyNumber>sample string 10</HierarchyNumber>
      <MimeType>sample string 7</MimeType>
      <QuestionId>3</QuestionId>
      <ResponseId>2</ResponseId>
      <Skey>5</Skey>
      <Text>sample string 6</Text>
    </Comment>
    <Comment>
      <CommentId>1</CommentId>
      <CommentType>sample string 9</CommentType>
      <DateTime>2024-04-24T22:35:27.8135494-05:00</DateTime>
      <EncodedData>sample string 8</EncodedData>
      <HierarchyDisplay>sample string 12</HierarchyDisplay>
      <HierarchyDisplayOrderBy>sample string 13</HierarchyDisplayOrderBy>
      <HierarchyName>sample string 11</HierarchyName>
      <HierarchyNumber>sample string 10</HierarchyNumber>
      <MimeType>sample string 7</MimeType>
      <QuestionId>3</QuestionId>
      <ResponseId>2</ResponseId>
      <Skey>5</Skey>
      <Text>sample string 6</Text>
    </Comment>
  </SurveyResponseComments>
  <SurveyResponseValues>
    <SurveyResponseValue>
      <QuestionId>1</QuestionId>
      <QuestionText>sample string 2</QuestionText>
      <ResponseColumn>sample string 3</ResponseColumn>
      <ResponseValue>sample string 4</ResponseValue>
    </SurveyResponseValue>
    <SurveyResponseValue>
      <QuestionId>1</QuestionId>
      <QuestionText>sample string 2</QuestionText>
      <ResponseColumn>sample string 3</ResponseColumn>
      <ResponseValue>sample string 4</ResponseValue>
    </SurveyResponseValue>
  </SurveyResponseValues>
  <SurveyResult>
    <CallDateTime>2024-04-24T22:35:27.8135494-05:00</CallDateTime>
    <DateTime>2024-04-24T22:35:27.8135494-05:00</DateTime>
    <MethodologyId>2</MethodologyId>
    <ResponseId>11</ResponseId>
    <Skey>1</Skey>
    <StoreId>sample string 5</StoreId>
    <Term>sample string 9</Term>
    <TermId>3</TermId>
    <Uid>sample string 4</Uid>
    <UnitLocalDateTime>2024-04-24T22:35:27.8135494-05:00</UnitLocalDateTime>
    <VisitDate>2024-04-24T22:35:27.8135494-05:00</VisitDate>
  </SurveyResult>
  <UID>sample string 9</UID>
  <VisitDate>2024-04-24T22:35:27.8135494-05:00</VisitDate>
</Alert>