GET api/V3/Survey/detailedlist?surveyId={surveyId}&lastResponseId={lastResponseId}

Lists all the survey responses From ReportDb.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

Use this to get the survey responses.

integer

Default value is 0

lastResponseId

Use this to get the survey responses after that id.

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Top 100 Survey responses

Collection of V3.Survey
NameDescriptionTypeAdditional information
SurveyId

Survey Id

integer

None.

ResponseId

Response Id

integer

None.

SurveyDate

Survey Date

date

None.

OutletName

Outlet name

string

None.

OutletErpId

Outlet Erp Id

string

None.

UserName

Outlet name

string

None.

UserErpId

Outlet Erp Id

string

None.

BeatName

Beat Name

string

None.

BeatErpId

Beat erpId

string

None.

SurveyCapturedTime

Survey captured

date

None.

Images

Images

string

None.

Responses

Responses

Collection of Object

None.

PositionCode

Position Code of the Beat

string

None.

PositionName

Position Name of the Beat

string

None.

PositionLevel

Position Level of the Beat

PositionCodeLevel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SurveyId": 1,
    "ResponseId": 2,
    "SurveyDate": "2025-04-04T05:36:16.3126838+00:00",
    "OutletName": "sample string 4",
    "OutletErpId": "sample string 5",
    "UserName": "sample string 6",
    "UserErpId": "sample string 7",
    "BeatName": "sample string 8",
    "BeatErpId": "sample string 9",
    "SurveyCapturedTime": "2025-04-04T05:36:16.3126838+00:00",
    "Images": "sample string 11",
    "Responses": [
      {},
      {}
    ],
    "PositionCode": "sample string 12",
    "PositionName": "sample string 13",
    "PositionLevel": "Level8"
  },
  {
    "SurveyId": 1,
    "ResponseId": 2,
    "SurveyDate": "2025-04-04T05:36:16.3126838+00:00",
    "OutletName": "sample string 4",
    "OutletErpId": "sample string 5",
    "UserName": "sample string 6",
    "UserErpId": "sample string 7",
    "BeatName": "sample string 8",
    "BeatErpId": "sample string 9",
    "SurveyCapturedTime": "2025-04-04T05:36:16.3126838+00:00",
    "Images": "sample string 11",
    "Responses": [
      {},
      {}
    ],
    "PositionCode": "sample string 12",
    "PositionName": "sample string 13",
    "PositionLevel": "Level8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSurvey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <Survey>
    <BeatErpId>sample string 9</BeatErpId>
    <BeatName>sample string 8</BeatName>
    <Images>sample string 11</Images>
    <OutletErpId>sample string 5</OutletErpId>
    <OutletName>sample string 4</OutletName>
    <PositionCode>sample string 12</PositionCode>
    <PositionLevel>Level8</PositionLevel>
    <PositionName>sample string 13</PositionName>
    <ResponseId>2</ResponseId>
    <Responses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </Responses>
    <SurveyCapturedTime>2025-04-04T05:36:16.3126838+00:00</SurveyCapturedTime>
    <SurveyDate>2025-04-04T05:36:16.3126838+00:00</SurveyDate>
    <SurveyId>1</SurveyId>
    <UserErpId>sample string 7</UserErpId>
    <UserName>sample string 6</UserName>
  </Survey>
  <Survey>
    <BeatErpId>sample string 9</BeatErpId>
    <BeatName>sample string 8</BeatName>
    <Images>sample string 11</Images>
    <OutletErpId>sample string 5</OutletErpId>
    <OutletName>sample string 4</OutletName>
    <PositionCode>sample string 12</PositionCode>
    <PositionLevel>Level8</PositionLevel>
    <PositionName>sample string 13</PositionName>
    <ResponseId>2</ResponseId>
    <Responses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </Responses>
    <SurveyCapturedTime>2025-04-04T05:36:16.3126838+00:00</SurveyCapturedTime>
    <SurveyDate>2025-04-04T05:36:16.3126838+00:00</SurveyDate>
    <SurveyId>1</SurveyId>
    <UserErpId>sample string 7</UserErpId>
    <UserName>sample string 6</UserName>
  </Survey>
</ArrayOfSurvey>