Superfy Platform API Documentation

General

• API Standard (Home)
• Table of Contents Page

General API

• Get Available Account Types
• Get Specific Account Type Information and Given Modules

User API

• Request Reset Password for User
• Authorize User
• Check Validity of DeviceID and Token
• Get Current User Profile
• Update Current User Profile
• Request New Email Verification Link

Company API

• Get Company Information
• Update Company Information
• Create New Department / Roles
• Get Available Department / Roles
• Get Specific Department / Roles Detail
• Update Specific Department / Roles
• Delete Specific Department / Roles
• Add New User in Company
• Get Available Users in Company
• Get Specific User Detail in Company
• Update Specific User in Company
• Delete Specific User in Company
• Create User-created Asset Fullness Level Filter
• Get User-created Asset Fullness Level Filter
• Get Specific User-created Asset Fullness Level Filter
• Update Specific User-created Asset Fullness Level Filter
• Delete Specific User-created Asset Fullness Level Filter
• Get All Asset Fullness Level (for Zone Explorer)
• Get Data of All Companies

Notification API

• Get List of Notification
• Create New Notification
• Update Specific Notification
• Delete Specific Notification
• Get List of Notification Sent to Mobile
• Get Specific of Notification Content
• Mark Notification as Read
• Acknowledge Emergency Notification
• Hide/Dismiss Notification

Inventory Management API

• Add New Custom Location
• Get Available Custom Locations
• Get Specific Custom Location Detail
• Update Specific Custom Location
• Delete Specific Custom Location
• Add New Manufacturer
• Get Available Manufacturers
• Get Specific Manufacturer Detail
• Update Specific Manufacturer
• Delete Specific Manufacturer
• Create New Asset Type
• Get Available Asset Types
• Get Specific Asset Type Detail
• Update Specific Asset Type
• Delete Specific Asset Type
• Get Available System-default Icons
• Get Available Custom Icons
• Add New Custom Icons
• Add New Tags
• Get Available Tags
• Update Tags
• Delete Tags
• Add New Vehicle
• Get Available Vehicles
• Get Specific Vehicle Detail
• Update Specific Vehicle
• Delete Specific Vehicle

Sensor Management API

• Get Available Sensor Manufacturers
• Check If Sensor Belongs to Company
• Add New Sensor
• Get Available Sensors
• Get Specific Sensor Detail
• Update Specific Sensor
• Delete Specific Sensor
• Get Sensor Allocation History
• Allocate Sensor to Bin
• Deallocate / Detach Sensor from Bin
• Update Sensor Allocation Settings from Bin
• Set Global Sensor Settings
• Get Global Sensor Settings
• Set Specific Sensor Setting
• Get Specific Sensor Setting
• Get Allocated Sensor Data (Chart)
• Get Allocated Sensor Data (Raw)

Route Schedule API

• Add New Route/Schedule
• Get Available Routes/Schedules
• Get Specific Route/Schedule Detail
• Update Specific Route/Schedule
• Delete Specific Route/Schedule
• Recalculate Preview Route/Schedule
• Get Affected Bins and Routes Taken on Specific Route/Schedule (for Preview Only) and Execution List
• Get Processed Route/Schedule List
• Get Processed Route/Schedule Detail
• Generate Route
• Delete Specific Processed Route/Schedule
• Run / Execute Processed Route (Add or Update Execution Data)
• Delete Execution Data on Processed Route
• Collect Specific Asset on Processed Route
• Cancel Collect / De-Collect Specific Asset on Processed Route
• Log Driver GPS on Processed Route
• Get Driver Processed GPS on Processed Route

Zones API

• Add New Zone
• Get Available Zones
• Get Specific Zone Detail
• Update Specific Zone
• Delete Specific Zone
• Add New Group
• Get Available Groups
• Get Specific Group Detail
• Update Specific Group
• Delete Specific Group
• Create New Pin on a Zone Map
• Get Available Pins on Map (Specific or All Zone)
• Get Specific Pin on a Zone Map
• Update Specific Pin on a Zone Map
• Delete Specific Pin on a Zone Map
• Add New Image on a Pin
• Get Available Images on a Pin
• Get Specific Image on a Pin
• Update Specific Image on a Pin
• Delete Specific Image on a Pin
• Get Allocated Sensor History on a Pin
• Get Vendor List

Reports API

• Raw Sensor Data