RoutingBox.DataService
Click here for a complete list of operations.
GetCompanyUsage
Gets usage statistics between the specified dates for all companies.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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 /Service.asmx HTTP/1.1 Host: rb-group2.intelligentbits.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "RoutingBox/GetCompanyUsage" <?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> <GetCompanyUsage xmlns="RoutingBox"> <token>string</token> <startDate>dateTime</startDate> <endDate>dateTime</endDate> </GetCompanyUsage> </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> <GetCompanyUsageResponse xmlns="RoutingBox"> <GetCompanyUsageResult> <CompanyUsage> <CancelledTripCount>int</CancelledTripCount> <CompanyCode>string</CompanyCode> <CompanyName>string</CompanyName> <CompletedTripCount>int</CompletedTripCount> <CsmEmail>string</CsmEmail> <EndDate>dateTime</EndDate> <LastLogin>dateTime</LastLogin> <Notes>string</Notes> <PendingTripCount>int</PendingTripCount> <PreviousCancelledTripCount>int</PreviousCancelledTripCount> <PreviousCompletedTripCount>int</PreviousCompletedTripCount> <PreviousPendingTripCount>int</PreviousPendingTripCount> <ProfileUrl>string</ProfileUrl> <StartDate>dateTime</StartDate> </CompanyUsage> <CompanyUsage> <CancelledTripCount>int</CancelledTripCount> <CompanyCode>string</CompanyCode> <CompanyName>string</CompanyName> <CompletedTripCount>int</CompletedTripCount> <CsmEmail>string</CsmEmail> <EndDate>dateTime</EndDate> <LastLogin>dateTime</LastLogin> <Notes>string</Notes> <PendingTripCount>int</PendingTripCount> <PreviousCancelledTripCount>int</PreviousCancelledTripCount> <PreviousCompletedTripCount>int</PreviousCompletedTripCount> <PreviousPendingTripCount>int</PreviousPendingTripCount> <ProfileUrl>string</ProfileUrl> <StartDate>dateTime</StartDate> </CompanyUsage> </GetCompanyUsageResult> </GetCompanyUsageResponse> </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 /Service.asmx HTTP/1.1 Host: rb-group2.intelligentbits.com 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> <GetCompanyUsage xmlns="RoutingBox"> <token>string</token> <startDate>dateTime</startDate> <endDate>dateTime</endDate> </GetCompanyUsage> </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> <GetCompanyUsageResponse xmlns="RoutingBox"> <GetCompanyUsageResult> <CompanyUsage> <CancelledTripCount>int</CancelledTripCount> <CompanyCode>string</CompanyCode> <CompanyName>string</CompanyName> <CompletedTripCount>int</CompletedTripCount> <CsmEmail>string</CsmEmail> <EndDate>dateTime</EndDate> <LastLogin>dateTime</LastLogin> <Notes>string</Notes> <PendingTripCount>int</PendingTripCount> <PreviousCancelledTripCount>int</PreviousCancelledTripCount> <PreviousCompletedTripCount>int</PreviousCompletedTripCount> <PreviousPendingTripCount>int</PreviousPendingTripCount> <ProfileUrl>string</ProfileUrl> <StartDate>dateTime</StartDate> </CompanyUsage> <CompanyUsage> <CancelledTripCount>int</CancelledTripCount> <CompanyCode>string</CompanyCode> <CompanyName>string</CompanyName> <CompletedTripCount>int</CompletedTripCount> <CsmEmail>string</CsmEmail> <EndDate>dateTime</EndDate> <LastLogin>dateTime</LastLogin> <Notes>string</Notes> <PendingTripCount>int</PendingTripCount> <PreviousCancelledTripCount>int</PreviousCancelledTripCount> <PreviousCompletedTripCount>int</PreviousCompletedTripCount> <PreviousPendingTripCount>int</PreviousPendingTripCount> <ProfileUrl>string</ProfileUrl> <StartDate>dateTime</StartDate> </CompanyUsage> </GetCompanyUsageResult> </GetCompanyUsageResponse> </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 /Service.asmx/GetCompanyUsage?token=string&startDate=string&endDate=string HTTP/1.1 Host: rb-group2.intelligentbits.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfCompanyUsage xmlns="RoutingBox"> <CompanyUsage> <CancelledTripCount>int</CancelledTripCount> <CompanyCode>string</CompanyCode> <CompanyName>string</CompanyName> <CompletedTripCount>int</CompletedTripCount> <CsmEmail>string</CsmEmail> <EndDate>dateTime</EndDate> <LastLogin>dateTime</LastLogin> <Notes>string</Notes> <PendingTripCount>int</PendingTripCount> <PreviousCancelledTripCount>int</PreviousCancelledTripCount> <PreviousCompletedTripCount>int</PreviousCompletedTripCount> <PreviousPendingTripCount>int</PreviousPendingTripCount> <ProfileUrl>string</ProfileUrl> <StartDate>dateTime</StartDate> </CompanyUsage> <CompanyUsage> <CancelledTripCount>int</CancelledTripCount> <CompanyCode>string</CompanyCode> <CompanyName>string</CompanyName> <CompletedTripCount>int</CompletedTripCount> <CsmEmail>string</CsmEmail> <EndDate>dateTime</EndDate> <LastLogin>dateTime</LastLogin> <Notes>string</Notes> <PendingTripCount>int</PendingTripCount> <PreviousCancelledTripCount>int</PreviousCancelledTripCount> <PreviousCompletedTripCount>int</PreviousCompletedTripCount> <PreviousPendingTripCount>int</PreviousPendingTripCount> <ProfileUrl>string</ProfileUrl> <StartDate>dateTime</StartDate> </CompanyUsage> </ArrayOfCompanyUsage>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /Service.asmx/GetCompanyUsage HTTP/1.1 Host: rb-group2.intelligentbits.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&startDate=string&endDate=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfCompanyUsage xmlns="RoutingBox"> <CompanyUsage> <CancelledTripCount>int</CancelledTripCount> <CompanyCode>string</CompanyCode> <CompanyName>string</CompanyName> <CompletedTripCount>int</CompletedTripCount> <CsmEmail>string</CsmEmail> <EndDate>dateTime</EndDate> <LastLogin>dateTime</LastLogin> <Notes>string</Notes> <PendingTripCount>int</PendingTripCount> <PreviousCancelledTripCount>int</PreviousCancelledTripCount> <PreviousCompletedTripCount>int</PreviousCompletedTripCount> <PreviousPendingTripCount>int</PreviousPendingTripCount> <ProfileUrl>string</ProfileUrl> <StartDate>dateTime</StartDate> </CompanyUsage> <CompanyUsage> <CancelledTripCount>int</CancelledTripCount> <CompanyCode>string</CompanyCode> <CompanyName>string</CompanyName> <CompletedTripCount>int</CompletedTripCount> <CsmEmail>string</CsmEmail> <EndDate>dateTime</EndDate> <LastLogin>dateTime</LastLogin> <Notes>string</Notes> <PendingTripCount>int</PendingTripCount> <PreviousCancelledTripCount>int</PreviousCancelledTripCount> <PreviousCompletedTripCount>int</PreviousCompletedTripCount> <PreviousPendingTripCount>int</PreviousPendingTripCount> <ProfileUrl>string</ProfileUrl> <StartDate>dateTime</StartDate> </CompanyUsage> </ArrayOfCompanyUsage>