Simple Reporting Service

Top  Previous  Next

Overview

The Simple Reporting Service is a reporting based RESTful web service which responds with XML (supported by a XSD style sheet to format the data), JSON or HTML

This interface is best used with web applications or where data is required to be consumed by Excel or MS-Access.  The data is based upon standard Navigator reports and the data returned will be in the format of the underlying report.

To use the service, an API key should be requested from DMS Navigator, please contact your Account Manager or the Helpdesk for more details.

The service can be called using the following generic URL which is in the form:-

https://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/[api key],[report name],[style],[parameters]

There are several reports available, which are each documented below.   Each web service call requires at least 4 fields :-

API Key - As supplied by DMS Navigator - the api key is in two parts with a comma separator

Report Name - the name of the report (see below)

Style - must be XML to return an XML dataset, JSON to return a JSON dataset or  HTML to return an HTML web page containing a formatted table

Parameters - at least one parameter for the report (parameters must be comma separated). Note: Date fields should be supplied in the format dd.mm.yy eg 01.09.15 = 1st September 2015

Valid Report Names are :-

XML_ALL_ENQUIRY_LIST

This extracts all Sales enquiries from the Sales 360 system

The report takes a four parameters:

1 = branch list (dot separated)

2 = staff nos (dot separated or blank for all)

3. date from (dd.mm.yy)

4. date to (dd.mm.yy)

 

XML_WORK_IN_PROGRESS

 

This is the Work in progress report, which returns a report in the form of the Work In Progress Report available from the Workshop Managers Toolkit

 

The report accepts two parameters :-

 

1=Branch No

2=Include Invoiced Jobs ? 1/0

 

A sample can be viewed at :

 

XML: https://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_WORK_IN_PROGRESS,XML,1,0

HTML: https://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_WORK_IN_PROGRESS,HTML,1,0

JSON:https://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_WORK_IN_PROGRESS,JSON,1,0

 

XML_WORKS_INVOICES

 

This is the Workshop Invoice Report as available in the Workshop Managers Toolkit

 

The report accepts three parameters :-

1=Branch list (seperated by dots)

2=Date From

3=Date to

 

A sample can be viewed at :

 

XML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_WORKS_INVOICES,XML,1,01.01.14,31.12.14

 

HTML:http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_WORKS_INVOICES,HTML,1,01.01.14,31.12.14

 

XML_PARTS_INVOICES

 

This is the Parts Invoice Report as available from the Parts Managers Toolkit

 

The report accepts three parameters :-

1=Branch list (separated by dots)

2=Date From

3=Date to

 

A sample can be viewed at :

 

XML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_PARTS_INVOICES,XML,1,01.01.14,31.12.14

 

HTML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_PARTS_INVOICES,HTML,1,01.01.14,31.12.14

 

XML_SALES_ENQUIRIES

 

This is the Sales Enquiry Report as available from the Sales Managers Toolkit

 

The report accepts three parameters :-

1=Branch list (separated by dots)

2=Date From

3=Date to

 

A sample can be viewed at :

 

XML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_SALES_ENQUIRIES,XML,1,01.01.14,31.12.14

 

HTML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_SALES_ENQUIRIES,HTML,1,01.01.14,31.12.14

 

 

XML_SALES_PROFIT

 

This is the Pipeline Profit Report as available from the Sales Managers Toolkit

 

The report accepts four parameters :-

 

1=Branch list (separated by dots)

2=date from

3=date to

4=(D)elivery date or (O)rder date

 

A sample can be viewed at :

 

XML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_SALES_PROFIT,XML,1,01.01.14,31.12.14,D

 

HTML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_SALES_PROFIT,HTML,1,01.01.14,31.12.14,D

 

XML_SALES_ORDERS

 

This is the Sales Order Book Report as available from the Sales Managers Toolkit

 

The report accepts one parameters :-

 

1=Branch list (separated by dots)

 

A sample can be viewed at :

 

XML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_SALES_ORDERS,XML,1

 

HTML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_SALES_ORDERS,HTML,1

 

XML_VEHICLE_STOCK_LIST

 

This is the Vehicle Stock List as available from either of the Sales Toolkit, The Sales Managers Toolkit or the Vehicle Administrators Toolkit

 

The report accepts several parameters :-

 

1=Branch list (separated by dots)

2=0-Sales Managers, 1=Sale mans stock list, 2=Vehicle Admin Stocklist, or named list as supplied by Navigator

3=0-New, 1-Used, blank=both

4=1=In Stock Only, 0=all

5= 1=Unsold Only, 0=all

6- 1=Only include vehicles set for Advertise on Web, 0/blank=all

 

A sample can be viewed at :

 

XML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_VEHICLE_STOCK_LIST,XML,1,0,,1,1

 

HTML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/194322.775.4087.4291.EA5B_77796C616D2E646D73657276696365732E636F2E756B,1,XML_VEHICLE_STOCK_LIST,HTML,1,0,,1,1

 

XML_NOMINAL_TRIAL_BALANCE

 

This reports a Nominal Trial Balance as available from the Nominal Ledger Reports - Ledger Reports option

 

The report accepts 4 parameters

 

1=Branch No - the trial balance will be generated for the company that the branch belongs to

2=Report No - this is numeric and lines up with the drop down list available when generating a trial balance

3=Period - This is the nominal period

4=Year (0=current, 1-Last year)

 

A sample can be viewed at :

 

XML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_NOMINAL_TRIAL_BALANCE,XML,1,1,12,0

 

HTML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_NOMINAL_TRIAL_BALANCE,HTML,1,1,12,0