Customer

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

APIDescription
GET customers

Retrieve all Customers. Roles: ApiRole

GET customers/{customerID}

Retrieve one Customer. Roles: ApiRole/FreeRole

GET customers/level/{levelID}

Retrieve all Customers for one Level. Roles: ApiRole+DealerRole/FreeRole

POST customers

Create Customers. Roles: ApiRole+DealerRole

PUT customers

Update Customers. Roles: ApiRole

DataCollector

Endpoint to support CRUD operations on DataCollector or Clients

APIDescription
GET datacollectors?customerID={customerID}

Get all DataCollector clients for a customer Roles: ApiRole/FreeRole

GET datacollectors/{clientID}

Get DataCollector client for a customer Roles: ApiRole

POST datacollectors

Create a new DataCollector client. Roles: ApiRole

PUT datacollectors

Update DataCollector client. Roles: ApiRole/FreeRole

DELETE datacollectors/{clientID}

Delete DataCollector client for a customer Roles: ApiRole

DataCollectorRange

Endpoint to support CRUD operations on DataCollector Ranges.

APIDescription
GET datacollectorranges/{clientRangeID}

Get client range for DataCollector client Roles: ApiRole

POST datacollectorranges

Create new ranges for DataCollector client. Roles: ApiRole/FreeRole

PUT datacollectorranges

Update ranges for DataCollector client. Roles: ApiRole/FreeRole

DELETE datacollectorranges/{clientRangeID}

Delete client range for DataCollector client Roles: ApiRole/FreeRole

Device

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

APIDescription
GET devices?customerID={customerID}

Retrieve all Devices. Roles: ApiRole/FreeRole

GET devices/{deviceID}

Retrieve one Device. Roles: ApiRole/FreeRole

PUT devices

Update Devices. Roles: ApiRole

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. Roles: ApiRole

GET levels/{levelID}

Retrieve one Level. Roles: ApiRole

POST levels

Create Level. Roles: ApiRole+ManageChildLevelsRole

PUT levels

Update Level. Roles: ApiRole+DealerRole

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. Roles: ApiRole

GET reports/{reportGUID}

Get report using ReportGUID. Roles: ApiRole

GET reports/schedules?reportGUID={reportGUID}

Get all ReportSchedules for a Report. Roles: ApiRole

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

Get all ReportSchedules for a Report. Roles: ApiRole

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

Run report. Roles: ApiRole

User

Endpoint to retrieve, create or update users

APIDescription
GET users

Retrieve all Users Roles: ApiRole

GET users?username={username}

Retrieve one User Roles: ApiRole

GET users?customerID={customerID}

Retrieve all Users for Customer ID Roles: ApiRole/FreeRole

GET users/{username}

Retrieve one User Roles: ApiRole

POST users

Create User Roles: ApiRole

PUT users

Update User Roles: ApiRole

POST users/forgotPassword

Endpoint to reset the password for user.