Customer Reports
Endpoint: https://www.dumpster.software/controller.html.
Provides a list of reports, a list of params based on a valid id and a single report based on valid params.
Here you will submit the following arguments and the system will respond with a JSON that includes:
Retrieve reports (list):
Arguments |
Req |
Data Type |
Example |
command |
Y |
N/A |
cmdBoxTPortalReportList |
username_api |
Y |
N/A |
Same as the handshake |
session_key_api |
Y |
N/A |
Provided by handshake |
username_customer |
Y |
N/A |
To be issued |
session_key_customer |
Y |
N/A |
Provided by customer handshake |
Box Tracker Response:: A JSON with the following fields:
Field |
Example |
Explanation |
status |
200 |
See the status code section |
errorString |
ERROR: Invalid Session Key |
What if anything went wrong |
reportObjList |
--- |
An object that contains all customer reports available to the portal
|
Sample Code ( Perl ):
#!/usr/bin/perl
use strict;
use LWP::UserAgent;
use Data::Dumper;
use JSON;
use URI::Encode qw(uri_decode uri_encode);
my $destination;
my %fields = (
command => "cmdBoxTPortalReportList",
username_api => "username_api",
session_key_api => "session_key_api",
username_customer => "username_customer",
session_key_customer => "session_key_customer",
);
my @args = ();
foreach my $key (keys %fields) {
my $value = uri_encode($fields{$key});
push @args, "$key=$value";
}
my $queryString = join('&', @args);
$destination = "https://www.dumpster.software/controller.html?$queryString";
my $ua = LWP::UserAgent->new;
my $response = $ua->request(HTTP::Request->new(GET => $destination));
my $json = JSON->new();
my $obj = $json->decode($response->content);
print Data::Dumper->Dump([$obj]);
Retrieve report (single):
Arguments |
Req |
Data Type |
Example |
command |
Y |
N/A |
cmdBoxTPortalReportDetails |
username_api |
Y |
N/A |
Same as the handshake |
session_key_api |
Y |
N/A |
Provided by handshake |
username_customer |
Y |
N/A |
To be issued |
session_key_customer |
Y |
N/A |
Provided by customer handshake |
report_id |
Y |
int(11) |
54321 |
params |
Y |
--- |
See available reports for more details |
Box Tracker Response:: A JSON with the following fields:
Field |
Example |
Explanation |
status |
200 |
See the status code section |
errorString |
ERROR: Invalid Session Key |
What if anything went wrong |
reportObj |
--- |
An object that contains all information belonging to the target report
|
Sample Code ( Perl ):
#!/usr/bin/perl
use strict;
use LWP::UserAgent;
use Data::Dumper;
use JSON;
use URI::Encode qw(uri_decode uri_encode);
my $destination;
my %fields = (
command => "cmdBoxTPortalReportDetails",
username_api => "username_api",
session_key_api => "session_key_api",
username_customer => "username_customer",
session_key_customer => "session_key_customer",
report_id => "report_id",
params => "params"
);
my @args = ();
foreach my $key (keys %fields) {
my $value = uri_encode($fields{$key});
push @args, "$key=$value";
}
my $queryString = join('&', @args);
$destination = "https://www.dumpster.software/controller.html?$queryString";
my $ua = LWP::UserAgent->new;
my $response = $ua->request(HTTP::Request->new(GET => $destination));
my $json = JSON->new();
my $obj = $json->decode($response->content);
print Data::Dumper->Dump([$obj]);
Retrieve report params
Arguments |
Req |
Data Type |
Example |
command |
Y |
N/A |
cmdBoxTPortalReportParams |
username_api |
Y |
N/A |
Same as the handshake |
session_key_api |
Y |
N/A |
Provided by handshake |
username_customer |
Y |
N/A |
To be issued |
session_key_customer |
Y |
N/A |
Provided by customer handshake |
customer_id |
Y |
int(11) |
Provided by customer handshake |
report_id |
Y |
int(11) |
12345 |
Box Tracker Response:: A JSON with the following fields:
Sample Code ( Perl ):
#!/usr/bin/perl
use strict;
use LWP::UserAgent;
use Data::Dumper;
use JSON;
use URI::Encode qw(uri_decode uri_encode);
my $destination;
my %fields = (
command => "cmdBoxTPortalReportParams",
report_id => "report_id",
username_api => "username_api",
session_key_api => "session_key_api",
username_customer => "username_customer",
session_key_customer => "session_key_customer",
customer_id => "customer_id"
);
my @args = ();
foreach my $key (keys %fields) {
my $value = uri_encode($fields{$key});
push @args, "$key=$value";
}
my $queryString = join('&', @args);
$destination = "https://www.dumpster.software/controller.html?$queryString";
my $ua = LWP::UserAgent->new;
my $response = $ua->request(HTTP::Request->new(GET => $destination));
my $json = JSON->new();
my $obj = $json->decode($response->content);
print Data::Dumper->Dump([$obj]);