Customer

Endpoint that helps user to retrieve, create or update Customer/s.

APIDescription
GET customers

Retrieve all Customers

GET customers/{customerID}

Retrieve one Customer

GET customers/level/{levelID}

Retrieve all Customers for one Level. Dealer role is required.

POST customers

Create Customers. Dealer role is required.

PUT customers

Update Customers. Dealer role is required.

DataCollector

Endpoint to support CRUD operations on DataCollector or Clients

APIDescription
GET datacollectors?customerID={customerID}

Get all DataCollector clients for a customer

GET datacollectors/{clientID}

Get DataCollector client for a customer

POST datacollectors

Create a new DataCollector client.

PUT datacollectors

Update DataCollector client.

DELETE datacollectors/{clientID}

Delete DataCollector client for a customer

DataCollectorRange

Endpoint to support CRUD operations on DataCollector Ranges.

APIDescription
GET datacollectorranges/{clientRangeID}

Get client range for DataCollector client

POST datacollectorranges

Create new ranges for DataCollector client.

PUT datacollectorranges

Update ranges for DataCollector client.

DELETE datacollectorranges/{clientRangeID}

Delete client range for DataCollector client

Device

Endpoint that is used to retrieve and update device/s.

APIDescription
GET devices?customerID={customerID}

Retrieve all Devices. CustomerID query param is required.

GET devices/{deviceID}

Retrieve one Device. CustomerID query param is required.

PUT devices

Update Devices.

Doc

Docs endpoint helper

APIDescription
GET docs/release

Gets the release date of the current JA Web API version.

Level

Endpoint that helps user to retrieve, create or update level/s.

APIDescription
GET levels

Retrieve all Levels.

GET levels/{levelID}

Retrieve one Level

POST levels

Create Level. ManageChildLevel role is required.

PUT levels

Update Level. Dealer role is required.

Login

Endpoint that helps user to retrieve user token key

APIDescription
GET login

Retrieve user Token key. Username and Password query params are required.

Report

Endpoint to support New Reporting system

APIDescription
GET reports?customerID={customerID}

Get all reports in the scope of CustomerID.

GET reports/{reportGUID}

No documentation available.

GET reports/schedules?reportGUID={reportGUID}

Get all ReportSchedules for a Report.

GET reports/schedules/{emailSchdeuleGUID}?reportGUID={reportGUID}

Get all ReportSchedules for a Report.

GET reports/run?ReportGuid={ReportGuid}&CustomerID={CustomerID}&StartDate={StartDate}&EndDate={EndDate}&TagID={TagID}&ActiveDeviceWithin={ActiveDeviceWithin}&OutputFormat={OutputFormat}&DealerID={DealerID}

Run report. CustomerID query param is required.

User

Endpoint to retrieve, create or update users

APIDescription
GET users

Retrieve all Users

GET users/{username}

Retrieve one User

GET users?customerID={customerID}

No documentation available.

POST users

Create User

PUT users

Update User

POST users/forgotPassword

Endpoint to reset the password for user.