GET api/ArgusAPI/GetRouteReport

Request Information

URI Parameters

None.

Body Parameters

GetRouteReportRequest
NameDescriptionTypeAdditional information
Login

string

None.

Password

string

None.

Region

string

None.

ApplicationName

string

None.

SessionId

string

None.

StartDate

string

None.

RouteRangeBegin

string

None.

RouteRangeEnd

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",
  "RouteRangeBegin": "sample string 7",
  "RouteRangeEnd": "sample string 8"
}

application/xml, text/xml

Sample:
<GetRouteReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <ApplicationName>sample string 4</ApplicationName>
  <Login>sample string 1</Login>
  <Password>sample string 2</Password>
  <Region>sample string 3</Region>
  <RouteRangeBegin>sample string 7</RouteRangeBegin>
  <RouteRangeEnd>sample string 8</RouteRangeEnd>
  <SessionId>sample string 5</SessionId>
  <StartDate>sample string 6</StartDate>
</GetRouteReportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetRouteReportResponse
NameDescriptionTypeAdditional information
ControlList

Collection of ddlcontrolitem

None.

Records

Collection of Collection of string

None.

StatusCode

string

None.

StatusDescription

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ControlList": [
    {
      "ColumnTitle": "sample string 1",
      "ColumnBindName": "sample string 2",
      "ColumnWidth": 3
    },
    {
      "ColumnTitle": "sample string 1",
      "ColumnBindName": "sample string 2",
      "ColumnWidth": 3
    }
  ],
  "Records": [
    [
      "sample string 1",
      "sample string 2"
    ],
    [
      "sample string 1",
      "sample string 2"
    ]
  ],
  "StatusCode": "sample string 1",
  "StatusDescription": "sample string 2"
}

application/xml, text/xml

Sample:
<GetRouteReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <ControlList>
    <ddlcontrolitem>
      <ColumnBindName>sample string 2</ColumnBindName>
      <ColumnTitle>sample string 1</ColumnTitle>
      <ColumnWidth>3</ColumnWidth>
    </ddlcontrolitem>
    <ddlcontrolitem>
      <ColumnBindName>sample string 2</ColumnBindName>
      <ColumnTitle>sample string 1</ColumnTitle>
      <ColumnWidth>3</ColumnWidth>
    </ddlcontrolitem>
  </ControlList>
  <Records 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>
  </Records>
  <StatusCode>sample string 1</StatusCode>
  <StatusDescription>sample string 2</StatusDescription>
</GetRouteReportResponse>