OneStop Web API Help Page

Introduction

This API provides access to core OneStop functionality

The following items are read / write

Users
Group general configuration
Group scan schedules
Group general configuration
Device general information

The following items are read only

Device meter and consumable readings
Consumable orders
Consumable history
Device alerts

An initial http request to URL/authToken should be made, passing username, password and an authkey
The returned token should then be passed on the header of all subsequent calls.

Groups

API	Description
GET OneStop/Groups	Gets a list of groups the current user can see
GET OneStop/Groups/{GroupName}?ExactMatch={ExactMatch}	Gets a list of groups with name matching provided name
GET OneStop/Groups/{GroupID}	Get details for the specified group
PUT OneStop/Groups/{GroupID}	Update the specified group
POST OneStop/Groups/{GroupID}	Add new group
DELETE OneStop/Groups/{GroupID}	Delete specified group
GET OneStop/UserGroupInfo	No documentation available.
POST OneStop/Groups/{GroupID}/ImportReadings	Import new readings

ChangeLog

API	Description
PUT OneStop/Groups/{GroupID}/ChangeLog	No documentation available.
PUT OneStop/Groups/{GroupID}/UpdateStock	No documentation available.

Users

API	Description
GET OneStop/Groups/{GroupID}/Users	Gets all users in specified group
GET OneStop/Groups/{GroupID}/Users/{UserID}	Gets specified user
POST OneStop/Groups/{GroupID}/Users	Adds a new user to specified group
DELETE OneStop/Groups/{GroupID}/Users/{UserID}	Deletes user from specified group
PUT OneStop/Groups/{GroupID}/Users	Updates the specified user
GET OneStop/Groups/Users/UserInfo	No documentation available.

MeterReadings

API	Description
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/LatestReading	Gets latest meter reading for specified device
GET OneStop/Groups/{GroupID}/LatestReadings?IncludeSubGroups={IncludeSubGroups}	Gets latest meter readings for specified group
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/LatestReadingSummary	Gets latest meter reading summary for specified device
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Readings?ValidReadingsOnly={ValidReadingsOnly}&FromDate={FromDate}&ToDate={ToDate}	Gets meter readings for specified device
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/ReadingsSummary?ValidReadingsOnly={ValidReadingsOnly}&FromDate={FromDate}&ToDate={ToDate}	Gets meter reading summaries for specified device

ServiceCalls

API	Description
GET OneStop/Groups/{GroupID}/ServiceCall/{ServiceProviderID}	Gets a list of service calls in the specified group
GET OneStop/Groups/{GroupID}/ServiceCall/{serviceCallID}/WorkUnit	Gets a list of work units in the specified service call
PUT OneStop/Groups/{GroupID}/ServiceCall/{ServiceCallID}/WorkUnit	Updates the specified work unit
PUT OneStop/Groups/{GroupID}/ServiceCall/{ServiceCallID}/WorkUnitest	No documentation available.
GET OneStop/Groups/ServiceCall/StockLocation?serviceProviderID={serviceProviderID}	No documentation available.
GET OneStop/Groups/ServiceCall/AppStockSearch?serviceProviderID={serviceProviderID}&stockLocationID={stockLocationID}&engineerStockLocationID={engineerStockLocationID}&searchString={searchString}	No documentation available.
GET OneStop/Groups/ServiceCall/UserStockLocation?userKey={userKey}&serviceProviderID={serviceProviderID}	No documentation available.
GET OneStop/Groups/ServiceCall/UserStockSearch?stockLocationID={stockLocationID}	No documentation available.
GET OneStop/Groups/ServiceCall/PartUsed?servicecallworkunitID={servicecallworkunitID}&stockitemID={stockitemID}	No documentation available.
GET OneStop/ServiceCalls?serviceProviderID={serviceProviderID}&stockLocationID={stockLocationID}&engineerStockLocationID={engineerStockLocationID}&searchString={searchString}	No documentation available.

Model

API	Description
GET OneStop/Models	Gets all models

Customers

API	Description
GET OneStop/v3/Customers	Returns a list of customers
GET OneStop/v3/Customers/{customerID}	Get details for the specified Customer
GET OneStop/v3/Customers/{customerID}/MeterSummary?readingDate={readingDate}&managed={managed}	Gets meter reading summary for specified customer
DELETE OneStop/v3/Customers/{customerID}	Delete specified group
POST OneStop/v3/Customers	Add new customer

DeviceAlerts

API	Description
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/OpenDeviceAlerts	Gets open notifications for specified device
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/ClosedDeviceAlerts	Gets closed notifications for specified device
GET OneStop/Groups/{GroupID}/OpenDeviceAlerts?IncludeSubGroups={IncludeSubGroups}&ReportTime={ReportTime}	Gets open notifications for specified group
GET OneStop/Groups/{GroupID}/ClosedDeviceAlerts?IncludeSubGroups={IncludeSubGroups}&ReportTime={ReportTime}&ClearTime={ClearTime}	Gets open notifications for specified group

Consumables

API	Description
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/ConsumablesSummary	Gets consumables summary for specified device
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/ConsumablesSummary/{ConsumableID}	Get summary for specified consumable
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables	Gets consumable details for specified device
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables/{ConsumableID}	Get details for specified consumable
GET OneStop/Groups/{GroupID}/ConsumablesSummary?IncludeSubGroups={IncludeSubGroups}	Gets consumables summary for specified group
GET OneStop/Groups/{GroupID}/Consumables?IncludeSubGroups={IncludeSubGroups}	Gets consumables for specified group
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables/{ConsumableID}/Orders	Get orders for specified consumable
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables/Orders	Get orders for all consumables for specified device
PUT OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables/{ConsumableID}/Orders/{ConsumableOrderID}	Update consumable order
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables/{ConsumableID}/History	Get history for specified consumable. An new entry is added each time a consumable change is processed
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables/{ConsumableID}/Readings?ValidReadingsOnly={ValidReadingsOnly}&FromDate={FromDate}&ToDate={ToDate}	Gets readings for specified consumable

Lookups

API	Description
GET OneStop/Lookups/{ServiceProviderID}	Gets a list of all lookups per service provider

ScanSettings

API	Description
GET OneStop/Groups/{GroupID}/ScanSettings	Gets general scan settings for specified group
PUT OneStop/Groups/{GroupID}/ScanSettings	Update scan settings for specified group
POST OneStop/Groups/{GroupID}/ScanSettings	Add scan settings for specified group
GET OneStop/Groups/{GroupID}/ScanSchedules	Gets scan schedules for specified group
GET OneStop/Groups/{GroupID}/ScanSchedules/{ScheduleID}	Gets specified scan schedule
PUT OneStop/Groups/{GroupID}/ScanSchedules	Update specified scan schedules
POST OneStop/Groups/{GroupID}/ScanSchedules	Add scan settings for specified group
DELETE OneStop/Groups/{GroupID}/ScanSchedules/{ScheduleID}	Deletes specified scan schedule
GET OneStop/Groups/{GroupID}/ConfigFile	Gets config file for specified group

Devices

API	Description
GET OneStop/Groups/{GroupID}/Devices?IncludeSubGroups={IncludeSubGroups}&Managed={Managed}	Gets a summary of devices in the specified group
GET OneStop/Groups/{GroupID}/DevicesWithDetail?IncludeSubGroups={IncludeSubGroups}&Managed={Managed}	Gets a list of devices in the specified group with device details
GET OneStop/Groups/{GroupID}/DeviceInfoForApp?IncludeSubGroups={IncludeSubGroups}	No documentation available.
GET OneStop/Groups/{GroupID}/DevicesWithConsumableInfo?IncludeSubGroups={IncludeSubGroups}	Gets a summary of devices in the specified group. Included consumable levels for toner, drum and waste toner
GET OneStop/Groups/{GroupID}/Devices/{DeviceID}	Gets specified Device
PUT OneStop/Groups/{GroupID}/Devices	Updates the specified device
DELETE OneStop/Groups/{GroupID}/Devices/{DeviceID}	Deletes specified device. Will delete all history associated with the device

Manufacturer

API	Description
GET OneStop/Manufacturers	Gets all Manufacturers

SecurityProfiles

API	Description
GET OneStop/Groups/{GroupID}/SecurityProfiles	Gets all security profiles in specified group
GET OneStop/Groups/{GroupID}/SecurityProfiles/{SecurityProfileID}	Gets elements for specified security profile