ReportTrafficStats

Greg Kolinski edited this page Sep 21, 2017 · 1 revision

Back To Common API Calls


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:


Returns

Report Stats - DataSet


Remarks

When NumPeriods is positive, TargetTime will be rolled back to match the initial time of the selected Period interval. For example, if the Period is Day, then the TargetTime will be set back to 12 midnight or if the period is Week, then the TargetTime will be set to Sunday at 12 midnight. When NumPeriods is a negative value, TargetTime will be rolled forward to the end of the Period.

There is no record for periods without any activity.

Kilocharacters (KCs) are rounded per Parcel/Interchange based on the Network/Mailbox configuration.


Code Example

C#

using System.Xml;
using System.Data;
using System.Web.Services.Protocols;
using ECGridService = <ProjectName>.net.ecgridos;

try
{
    using (ECGridService.ECGridOSAPIv3 ECGrid = new ECGridService.ECGridOSAPIv3())
    {
        try
        {
            string SessionID = "00000000-0000-0000-0000-000000000000";
            short NumPeriods = 3;
            DateTime TargetTime = new DateTime(2017, 1, 01);

            DataSet ReportStats = ECGrid.ReportTrafficStats(SessionID, TargetTime, NumPeriods, ECGridService.StatisticsPeriod.Day);

            // For each table in the DataSet, print the row values.
            foreach (DataTable table in ReportStats.Tables)
            {
                Console.WriteLine(table.TableName);

                foreach (DataRow row in table.Rows)
                {
                    foreach (DataColumn column in table.Columns)
                    {
                        Console.WriteLine(row[column].);
                    }
                }
            }

        }
        catch (SoapException SoapEx)
        {
            // See SOAP Exceptions in the Appendix
            var ECG_Ex = CatchException(SoapEx);
            Console.WriteLine($"ECGridOS Soap Exception: {ECG_Ex.ErrorCode} , Item: {ECG_Ex.ErrorItem}, Message: {ECG_Ex.ErrorMessage}, String: {ECG_Ex.ErrorString}");
        }
    } // END USING
}
catch (Exception ex){ Console.WriteLine("Unhandled Exception: " + ex.ToString()); }

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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/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="http://ecgridos.net/">
      <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="http://ecgridos.net/">
      <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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
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="http://ecgridos.net/">
      <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="http://ecgridos.net/">
      <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 /v3.2/prod/ecgridos.asmx/ReportTrafficStats?SessionID=string&TargetTime=string&NumPeriods=string&Period=string HTTP/1.1
Host: ecgridos.net
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="http://ecgridos.net/">
  <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 /v3.2/prod/ecgridos.asmx/ReportTrafficStats HTTP/1.1
Host: ecgridos.net
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="http://ecgridos.net/">
  <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>

Back To Common API Calls

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.