GET api/ArgusAPI/GetSurveySummary

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Login	string	None.
Password	string	None.
Region	string	None.
ApplicationName	string	None.
SessionId	string	None.
StartDate	string	None.
EndDate	string	None.
StartRoute	string	None.
EndRoute	string	None.
StartTime	string	None.
EndTime	string	None.
IncludeDetail	string	None.
Mode	string	None.
Warehouse	string	None.
StartExclude	string	None.
EndExclude	string	None.
MassedOnly	string	None.
KidsOnly	string	None.
EastOrWest	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Login": "sample string 1",
  "Password": "sample string 2",
  "Region": "sample string 3",
  "ApplicationName": "sample string 4",
  "SessionId": "sample string 5",
  "StartDate": "sample string 6",
  "EndDate": "sample string 7",
  "StartRoute": "sample string 8",
  "EndRoute": "sample string 9",
  "StartTime": "sample string 10",
  "EndTime": "sample string 11",
  "IncludeDetail": "sample string 12",
  "Mode": "sample string 13",
  "Warehouse": "sample string 14",
  "StartExclude": "sample string 15",
  "EndExclude": "sample string 16",
  "MassedOnly": "sample string 17",
  "KidsOnly": "sample string 18",
  "EastOrWest": "sample string 19"
}

application/xml, text/xml

Sample:

<GetSurveySummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <ApplicationName>sample string 4</ApplicationName>
  <EastOrWest>sample string 19</EastOrWest>
  <EndDate>sample string 7</EndDate>
  <EndExclude>sample string 16</EndExclude>
  <EndRoute>sample string 9</EndRoute>
  <EndTime>sample string 11</EndTime>
  <IncludeDetail>sample string 12</IncludeDetail>
  <KidsOnly>sample string 18</KidsOnly>
  <Login>sample string 1</Login>
  <MassedOnly>sample string 17</MassedOnly>
  <Mode>sample string 13</Mode>
  <Password>sample string 2</Password>
  <Region>sample string 3</Region>
  <SessionId>sample string 5</SessionId>
  <StartDate>sample string 6</StartDate>
  <StartExclude>sample string 15</StartExclude>
  <StartRoute>sample string 8</StartRoute>
  <StartTime>sample string 10</StartTime>
  <Warehouse>sample string 14</Warehouse>
</GetSurveySummaryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetSurveySummaryResponse

Name	Description	Type	Additional information
SummaryRpts		Collection of Collection of string	None.
StatusCode		string	None.

Response Formats

application/json, text/json

Sample:

{
  "SummaryRpts": [
    [
      "sample string 1",
      "sample string 2"
    ],
    [
      "sample string 1",
      "sample string 2"
    ]
  ],
  "StatusCode": "sample string 1"
}

application/xml, text/xml

Sample:

<GetSurveySummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <StatusCode>sample string 1</StatusCode>
  <SummaryRpts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
    </d2p1:ArrayOfstring>
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
    </d2p1:ArrayOfstring>
  </SummaryRpts>
</GetSurveySummaryResponse>