ReportTrafficStats - LorenData/ECGrid-API GitHub Wiki

Statistical Traffic Report for a period of time for the Session Network/Mailbox.

  public DataSet ReportTrafficStats(string SessionID,
                                    dateTime TargetTime,
                                    short NumPeriods,
                                    StatisticsPeriod Period)

Parameters

SessionID - String - GUID
TargetTime - System.DateTime
NumPeriods - Short
Period - StatisticsPeriod

Returns

DataSet

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://os.ecgrid.io/ReportTrafficStats"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ReportTrafficStats xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <TargetTime>dateTime</TargetTime>
      <NumPeriods>short</NumPeriods>
      <Period>Hour or Day or Week or Month</Period>
    </ReportTrafficStats>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ReportTrafficStatsResponse xmlns="https://os.ecgrid.io/">
      <ReportTrafficStatsResult>
        <xsd:schema>schema</xsd:schema>xml</ReportTrafficStatsResult>
    </ReportTrafficStatsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ReportTrafficStats xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <TargetTime>dateTime</TargetTime>
      <NumPeriods>short</NumPeriods>
      <Period>Hour or Day or Week or Month</Period>
    </ReportTrafficStats>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ReportTrafficStatsResponse xmlns="https://os.ecgrid.io/">
      <ReportTrafficStatsResult>
        <xsd:schema>schema</xsd:schema>xml</ReportTrafficStatsResult>
    </ReportTrafficStatsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v4.1/prod/ECGridOS.asmx/ReportTrafficStats?SessionID=string&TargetTime=string&NumPeriods=string&Period=string HTTP/1.1
Host: os.ecgrid.io

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="https://os.ecgrid.io/">
  <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx/ReportTrafficStats HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&TargetTime=string&NumPeriods=string&Period=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="https://os.ecgrid.io/">
  <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>

Back To Common API Calls