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:-

http://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 , HTML to return an HTML web page containing a formatted table or JSON to return JSON formatted data

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_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: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_WORK_IN_PROGRESS,XML,1,0

HTML: http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_WORK_IN_PROGRESS,HTML,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 :

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_PARTS_INVOICES_DETAIL

This is the Parts Invoice Detailed 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_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_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_SALES_ACTUAL_PROFIT

This is the 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

A sample can be viewed at :

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

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

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

4=1=In Stock Only, 0=all

5= 1=Unsold Only, 0=all

A sample can be viewed at :

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_DEBTORS_TRANSACTIONS

This reports a detailed Debtors list as available from the Sales Ledger Detailed Debtors Report

The report accepts 3 parameters

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

2=Branch List - this is a dot separated list of branch nos to report outstanding transactions for eg for branches 1 & 2 will contain 1.2. Leave blank for all

3=Transaction types to include : a dot separated list of transaction types to include where 10=Parts, 20=Service, 30=Sales, 40=Sundry Invoices, 71=Contract Hire, 72=Rental

A sample can be viewed at :

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

XML_WARRANTY_DEBTORS

This reports a Warranty Debtors list as available from the Warranty Menu - Outstanding Claims report

The report accepts 1 parameter

1=Branch List - this is a dot separated list of branch nos to report outstanding transactions for eg for branches 1 & 2 will contain 1.2. Must contain at least one branch

A sample can be viewed at :

XML_WORKSHOP_LOADING

This reports the workshop loading list as available from the workshop diary from within the Service Reception Screen

The report accepts 3 parameters

1=Branch List - this is a dot separated list of branch nos to report outstanding transactions for eg for branches 1 & 2 will contain 1.2. Must contain at least one branch

2= Date From in dotted format e.g. 01.2.16

3= Date To in dotted format e.g. 29.2.16

A sample can be viewed at :

XML_NOMINAL_TRANSACTIONS

This reports a Nominal Transaction report as available from the Nominal Ledger Reports - Transaction Reports option

The report accepts 3 parameters

1=Nominal Ledger account no (with company prefix eg 01.1.10.10.10)

2=Date From

3=Date To

A sample can be viewed at :

HTML:http://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/GetNavigatorReport/1945920.775.4087.4403.11C72_747261696E696E67312E646D73657276696365732E636F2E756B,1,XML_NOMINAL_TRANSACTIONS,HTML,01.1.10.10.10,01.1.15,31.12.15

XML_SUPPLIER_QUERIES

This reports a list of current Purchase Ledger invoices which have quesries on report as available from the Purchase Ledger menu

The report accepts 1 parameter

1=Company No (eg 01)

A sample can be viewed at :

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