GetDailySummary
- Method
SlimCD.Reports.GetDailySummary
Purpose
Gets daily summary for a clientid/siteid/date range.Description
Produces transaction counts and amounts for the date range specified. Check, gift and card totals are listed separately, where card totals are broken out by brand (Visa/MasterCard/Discover, etc).Business Rules
Argument List
Name Required Usage GetDailySummaryRequest Required Object containing properties for the request timeout Optional Integer wait time, in seconds, before timeout response is generated callback* Optional Function to call upon completion of asynchronous request *for JavaScript only
GetDailySummary Request Fields
Field Name Type Length Required Description Username string 20 require Username or API Access Credential that accesses web service. Password int 20 require Plaintext password for the client account. MetaBankID int 9 require * Value of the SLIM CD MetaBank id, or zero. CBankID string 9 require * Value of the SLIM CD bank id, or zero ClientID string 10 conditional Assigned by the Slim CD administrator. SiteID integer 10 optional Assigned by the Slim CD administrator.. StartDate date 10 require * Plaintext password for the client account. EndDate date 10 require * Plaintext password for the client account. 1. Passwords are required except when the username is set to an API Access Credential, in which case it should be passed in as an empty string.
Reply Fields
reply outer tag for the reply data block response Success, FAIL, Error response code 0, 1, 2 (respective) matching the above description If successful, this will contain the single word, OK. Otherwise it will contain a description of failure or error which occurred reponseurl The Slimcd.com url which was called for this operation datablock The confirmation text returned from the server. Reply Hierarchy
- reply
- response
- responsecode
- description
- responseurl
- datablock
- Summary
- SummaryRecord
- TotalTransactions
- SalesAmount
- CreditAmount
- NetAmount
- NetVisa
- NetMastercard
- NetAmex
- NetDiscover
- NetDiners
- NetJCB
- NetPinDebit
- NetPaperChecks
- NetElectronicChecks
- NetGiftCards
- SummaryRecord
- Summary
Remarks
- General
- Names in name/value pairs are NOT case-sensitive
- Names inside XML tags ARE case-sensitive
- Function-Specific
- None
- reply
- Include
012<script src="https://trans.slimcd.com/soft/json/slimcd.js"></script>
Method
1234function GetDailySummary(request,callback)function GetDailySummary(request,timeout,callback)
Request
123456789101112request= {"username": "1032","password": "289075","metabankid": "0","bankid": "0","clientid": "0","siteid": "0","startdate": "","enddate": ""}
Reply
123456789101112131415161718192021222324252627282930callback ( {"reply":{"response": "Success","responsecode": "0","description": "OK","responseurl": "http://stats.slimcd.com/wswebservices/reports.asmx/GetDailySummary","datablock": {"Summary": {"SummaryRecord": {"TotalTransactions": "59","SalesAmount": "2594.84","CreditAmount": "0.00","NetAmount": "2594.84","NetVisa": "2438.84","NetMastercard": "0.00","NetAmex": "156.00","NetDiscover": "0.00","NetDiners": "0.00","NetJCB": "0.00","NetPinDebit": "0.00","NetPaperChecks": "0.00","NetElectronicChecks": "0.00","NetGiftCards": "0.00"}}}}} );
Sample Code
1234567891011121314151617181920212223<script src="https://trans.slimcd.com/soft/json/slimcd.js"></script><script>// <![CDATA[SlimCD.Reports.GetDailySummary({"username": "1032","password": "289075","metabankid": "0","bankid": "0","clientid": "0","siteid": "0","startdate": "","enddate": ""},function (reply) {if (reply.response == "Success") {alert ('Batch Closed');} else {alert('There was a problem closing the batch:\r\n' + reply.description);}});// ]]></script>
Downloads
- Include
012include 'slimcd.php';
Method
123function Reports_GetDailySummary(Reports_GetDailySummaryRequest $request,$timeout=false)Request
123456789101112131415class Reports_GetDailySummaryRequest{// property declarationpublic $username = '';public $password = '';public $metabankid=0;public $bankid=0;public $clientid=0;public $siteid=0;public $startdate="";public $enddate="";}JSON Reply
12345678910111213141516171819202122232425262728{"response": "Success","responsecode": "0","description": "OK","responseurl": "http://stats.slimcd.com/wswebservices/reports.asmx/GetDailySummary","datablock": {"Summary": {"SummaryRecord": {"TotalTransactions": "59","SalesAmount": "2594.84","CreditAmount": "0.00","NetAmount": "2594.84","NetVisa": "2438.84","NetMastercard": "0.00","NetAmex": "156.00","NetDiscover": "0.00","NetDiners": "0.00","NetJCB": "0.00","NetPinDebit": "0.00","NetPaperChecks": "0.00","NetElectronicChecks": "0.00","NetGiftCards": "0.00"}}}}Sample Code
123456789101112131415161718192021222324include 'slimcd.php';// Create the Slim CD object$SlimCD = new SlimCD() ;// Create a GetDailySummary Request class$request = new Reports_GetDailySummaryRequest() ;$request->username = '1032';$request->password = '289075';$request->metabankid='0';$request->bankid='0';$request->clientid='0';$request->siteid='0';$request->startdate="";$request->enddate="";$result = $SlimCD->Reports_GetDailySummary($request);if ($result->response == 'Success') {echo 'Success!' ;}else {echo $result->response . ':' . $result->description ;}Downloads
Download full sample source. - Include
123using SlimCD;
Method
123public GetDailySummaryReply GetDailySummary(GetDailySummaryRequest request, int timeout);
Request
12345678910111213public class GetDailySummaryRequest{public string username { get; set; }public string password { get; set; }public int metabankid { get; set; }public int bankid { get; set; }public int clientid { get; set; }public int siteid { get; set; }public string startdate { get; set; }public string enddate { get; set; }}
Reply
12345678910111213141516171819202122232425public class GetDailySummaryReply{public string response;public string responsecode;public string description;public string responseurl;public string totaltransactions;public string salesamount;public string creditamount;public string netamount;public string netvisa;public string netmastercard;public string netamex;public string netdiscover;public string netdiners;public string netjcb;public string netpindebit;public string netpaperchecks;public string netelectronicchecks;public string netgiftcards;public string senddata;public string recvdata;}
Cross Reference: ClientSample Code
1234567891011121314151617181920212223242526SlimCD.Reports reports = new SlimCD.Reports();reports.debug = true;reports.transURL = TransURL;reports.statsURL = StatsURL;GetDailySummaryRequest request = new GetDailySummaryRequest();GetDailySummaryReply reply = new GetDailySummaryReply();request.username = 1032;request.password = 289075;request.metabankid =0 ;request.bankid =0 ;request.clientid =0 ;request.siteid =0 ;request.startdate = "";request.enddate = "";reply = reports.GetDailySummary(request, 60);if (reply.response.ToUpper() == "SUCCESS"){MessageBox.Show("Success");}else{MessageBox.Show("There was a problem:\n(" + reply.response & ") " + reply.description);}Downloads
Download full sample source. - Include
123using SlimCD;
Method
012public async Task GetDailySummary(GetDailySummaryRequest request, int timeout);
Request
12345678910111213public class GetDailySummaryRequest{public string username { get; set; }public string password { get; set; }public int metabankid { get; set; }public int bankid { get; set; }public int clientid { get; set; }public int siteid { get; set; }public string startdate { get; set; }public string enddate { get; set; }}
Reply
1234567891011121314151617181920212223242526public class GetSessionFieldsReplypublic class GetDailySummaryReply{public string response;public string responsecode;public string description;public string responseurl;public string totaltransactions;public string salesamount;public string creditamount;public string netamount;public string netvisa;public string netmastercard;public string netamex;public string netdiscover;public string netdiners;public string netjcb;public string netpindebit;public string netpaperchecks;public string netelectronicchecks;public string netgiftcards;public string senddata;public string recvdata;}
Cross Reference: ClientSample Code
1234567891011121314151617181920212223242526SlimCD.Reports reports = new SlimCD.Reports();reports.debug = true;reports.transURL = TransURL;reports.statsURL = StatsURL;GetDailySummaryRequest request = new GetDailySummaryRequest();GetDailySummaryReply reply = new GetDailySummaryReply();request.username = 1032;request.password = 289075;request.metabankid =0 ;request.bankid =0 ;request.clientid =0 ;request.siteid =0 ;request.startdate = "";request.enddate = "";reply = await reports.GetDailySummary(request, 60);if (reply.response.ToUpper() == "SUCCESS"){MessageBox.Show("Success");}else{MessageBox.Show("There was a problem:\n(" + reply.response & ") " + reply.description);}Downloads
- Include
012#import "SlimCD.h"
Method
1234567typedef void (^ReportsGetDailySummaryReplyBlock)(ReportsGetDailySummaryReply *reply);- (void) reportsGetDailySummaryWithRequest:(ReportsGetDailySummaryRequest*)request replyBlock:(ReportsGetDailySummaryReplyBlock)replyBlock;- (void) reportsGetDailySummaryWithRequest:(ReportsGetDailySummaryRequest*)request timeout:(NSTimeInterval)timeout replyBlock:(ReportsGetDailySummaryReplyBlock)replyBlock;Request
1234567891011121314@interface ReportsGetDailySummaryRequest@property (strong) NSString *userName;@property (strong) NSString *password;@property (strong) NSNumber *metaBankID;@property (strong) NSNumber *bankID;@property (strong) NSNumber *clientID;@property (strong) NSNumber *siteID;@property (strong) NSDate* startDate;@property (strong) NSDate* endDate;@endReply
1234567891011121314151617181920@interface ReportsGetDailySummaryReply : SlimCDReply@property (strong) NSString *totalTransactions;@property (strong) NSString *salesAmount;@property (strong) NSString *creditAmount;@property (strong) NSString *netAmount;@property (strong) NSString *netVisa;@property (strong) NSString *netMastercard;@property (strong) NSString *netAmex;@property (strong) NSString *netDiscover;@property (strong) NSString *netDiners;@property (strong) NSString *netJCB;@property (strong) NSString *netPinDebit;@property (strong) NSString *netPaperChecks;@property (strong) NSString *netElectronicChecks;@property (strong) NSString *netGiftCards;@endSample Code
12345678910111213141516171819202122232425SlimCD *api = [[SlimCD alloc] init];ReportsGetDailySummaryRequest *request = [[ReportsGetDailySummaryRequest alloc] init];request.userName = @"1032";request.password = @"289075";request.metaBankID = @0;request.bankID = @0;request.clientID = @1032;request.siteID = @228226448;request.startDate = [NSDate date];request.endDate = [NSDate date];[api reportsGetDailySummaryWithRequest:request replyBlock:^(ReportsGetDailySummaryReply *reply ){if ( reply.responseCode == RC_SUCCESS ){NSLog(@"Daily summary loaded successfully.");}else{NSLog(@"Unable to load daily summary.");}}]; - Method
1234567public void getDailySummary(GetDailySummaryRequest reportDailySummaryRequest,int timeout ,GetDailySummaryCallback callback)public void getDailySummary(GetDailySummaryRequest reportDailySummaryRequest,GetDailySummaryCallback callback)
Request
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980public class GetDailySummaryRequest{// request parameters.private String username;private String password;private int metabankid;private int bankid;private int clientid;private int siteid;private String startdate;private String enddate;// set default value.public GetDailySummaryRequest(){username="";password="";metabankid=0;bankid=0;clientid=0;siteid=0;startdate="";enddate="";}// setters and getters.public int getMetabankid() {return metabankid;}public void setMetabankid(int metabankid) {this.metabankid = metabankid;}public int getBankid() {return bankid;}public void setBankid(int bankid) {this.bankid = bankid;}public int getClientid() {return clientid;}public void setClientid(int clientid) {this.clientid = clientid;}public int getSiteid() {return siteid;}public void setSiteid(int siteid) {this.siteid = siteid;}public String getUsername() {return username;}public void setUsername(String username) {this.username = username;}public String getPassword() {return password;}public void setPassword(String password) {this.password = password;}public String getStartdate() {return startdate;}public void setStartdate(String startdate) {this.startdate = startdate;}public String getEnddate() {return enddate;}public void setEnddate(String enddate) {this.enddate = enddate;}}
Reply
1234567891011121314public class GetDailySummaryReply{private Summary summary=null;// setters and getters.public Summary getSummary() {return summary;}public void setSummary(Summary summary) {this.summary = summary;}}
Sample Code
1234567891011121314151617181920212223242526272829303132// set the request parameter.GetDailySummaryRequest request=newGetDailySummaryRequest();request.setUsername("1032");request.setPassword("289075");request.setSiteid(0);request.setStartdate("7/16/2013");request.setEnddate("7/16/2013");request.setBankid(0);request.setMetabankid(0);request.setClientid(0);callback = this;//To make web service request.new ReportsGetDailySummary().getDailySummary(request,new GetDailySummaryCallback(){@Overridepublic void getDailySummaryReply(GetDailySummaryReply reply){if (reply.getResponse().equals("Success"))textBox.setText("Success");elsetextBox.setText("There was a problem:\n" + reply.getResponse()+"\n Descriptin "+ reply.getDescription());}});
Downloads
Download full sample source. - URL
Protocols
- SOAP/XML
- HTTP POST
- HTTP GET
Request
Status Codes
Status Code Status Description Explanation 200 200 OK Approved or declined attempts will return a response with an XML reply block 500 500 Internal Server Error The response will not contain XML, as a server error has occurred. Reply Output is in XML format if a status code of 200 is returned.
123456789<!--?xml version="1.0" encoding="utf-8" ?-->Error2error retrieving daily summary infohttps://stats.slimcd.com/wswebservices/reports.asmx/GetDailySummaryIf the block’s tag does not indicate “Success”, the tag will contain an error description which can be displayed to the end-user
Sample Code
DOWNLOAD
EXERCISER TOOL
Remarks
- Remarks Go here
- URL
123https://stats.slimcd.com/soft/json/jsonscript.asp?service=GetDailySummary
Protocols- HTTP POST
- HTTP GET
This function accepts either name/value pairs or JSON
Request
Reply
123456789101112131415161718192021222324252627282930{"reply": {"response": "Success","responsecode": "0","description": "OK","responseurl": "http://stats.slimcd.com/wswebservices/reports.asmx/GetDailySummary","datablock": {"Summary": {"SummaryRecord": {"TotalTransactions": "59","SalesAmount": "2594.84","CreditAmount": "0.00","NetAmount": "2594.84","NetVisa": "2438.84","NetMastercard": "0.00","NetAmex": "156.00","NetDiscover": "0.00","NetDiners": "0.00","NetJCB": "0.00","NetPinDebit": "0.00","NetPaperChecks": "0.00","NetElectronicChecks": "0.00","NetGiftCards": "0.00"}}}}}Sample Code
Remarks
- None