traccar-api-client

Traccar - JavaScript client for traccar No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 4.5
• Package version: 4.5.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install traccar-api-client --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your traccar from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('traccar') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Traccar = require('traccar-api-client');
 
var defaultClient = Traccar.ApiClient.instance;
// Configure HTTP API Server
defaultClient.basePath = 'https://YOUR-TRACCAR-SERVER/api';
 
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
 
var api = new Traccar.DefaultApi()
 
var opts = { 
  'all': true, // {Boolean} Can only be used by admins or managers to fetch all entities
  'userId': 56, // {Number} Standard users can use this only with their own _userId_
  'deviceId': 56, // {Number} Standard users can use this only with _deviceId_s, they have access to
  'groupId': 56, // {Number} Standard users can use this only with _groupId_s, they have access to
  'refresh': true // {Boolean} 
};
 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.attributesComputedGet(opts, callback);
 

Documentation for API Endpoints

All URIs are relative to http://demo.traccar.org/api

Class	Method	HTTP request	Description
Traccar.DefaultApi	attributesComputedGet	GET /attributes/computed	Fetch a list of Attributes
Traccar.DefaultApi	attributesComputedIdDelete	DELETE /attributes/computed/{id}	Delete an Attribute
Traccar.DefaultApi	attributesComputedIdPut	PUT /attributes/computed/{id}	Update an Attribute
Traccar.DefaultApi	attributesComputedPost	POST /attributes/computed	Create an Attribute
Traccar.DefaultApi	calendarsGet	GET /calendars	Fetch a list of Calendars
Traccar.DefaultApi	calendarsIdDelete	DELETE /calendars/{id}	Delete a Calendar
Traccar.DefaultApi	calendarsIdPut	PUT /calendars/{id}	Update a Calendar
Traccar.DefaultApi	calendarsPost	POST /calendars	Create a Calendar
Traccar.DefaultApi	commandsGet	GET /commands	Fetch a list of Saved Commands
Traccar.DefaultApi	commandsIdDelete	DELETE /commands/{id}	Delete a Saved Command
Traccar.DefaultApi	commandsIdPut	PUT /commands/{id}	Update a Saved Command
Traccar.DefaultApi	commandsPost	POST /commands	Create a Saved Command
Traccar.DefaultApi	commandsSendGet	GET /commands/send	Fetch a list of Saved Commands supported by Device at the moment
Traccar.DefaultApi	commandsSendPost	POST /commands/send	Dispatch commands to device
Traccar.DefaultApi	commandsTypesGet	GET /commands/types	Fetch a list of available Commands for the Device or all possible Commands if Device ommited
Traccar.DefaultApi	devicesGet	GET /devices	Fetch a list of Devices
Traccar.DefaultApi	devicesIdAccumulatorsPut	PUT /devices/{id}/accumulators	Update total distance and hours of the Device
Traccar.DefaultApi	devicesIdDelete	DELETE /devices/{id}	Delete a Device
Traccar.DefaultApi	devicesIdPut	PUT /devices/{id}	Update a Device
Traccar.DefaultApi	devicesPost	POST /devices	Create a Device
Traccar.DefaultApi	driversGet	GET /drivers	Fetch a list of Drivers
Traccar.DefaultApi	driversIdDelete	DELETE /drivers/{id}	Delete a Driver
Traccar.DefaultApi	driversIdPut	PUT /drivers/{id}	Update a Driver
Traccar.DefaultApi	driversPost	POST /drivers	Create a Driver
Traccar.DefaultApi	eventsIdGet	GET /events/{id}
Traccar.DefaultApi	geofencesGet	GET /geofences	Fetch a list of Geofences
Traccar.DefaultApi	geofencesIdDelete	DELETE /geofences/{id}	Delete a Geofence
Traccar.DefaultApi	geofencesIdPut	PUT /geofences/{id}	Update a Geofence
Traccar.DefaultApi	geofencesPost	POST /geofences	Create a Geofence
Traccar.DefaultApi	groupsGet	GET /groups	Fetch a list of Groups
Traccar.DefaultApi	groupsIdDelete	DELETE /groups/{id}	Delete a Group
Traccar.DefaultApi	groupsIdPut	PUT /groups/{id}	Update a Group
Traccar.DefaultApi	groupsPost	POST /groups	Create a Group
Traccar.DefaultApi	maintenanceGet	GET /maintenance	Fetch a list of Maintenance
Traccar.DefaultApi	maintenanceIdDelete	DELETE /maintenance/{id}	Delete a Maintenance
Traccar.DefaultApi	maintenanceIdPut	PUT /maintenance/{id}	Update a Maintenance
Traccar.DefaultApi	maintenancePost	POST /maintenance	Create a Maintenance
Traccar.DefaultApi	notificationsGet	GET /notifications	Fetch a list of Notifications
Traccar.DefaultApi	notificationsIdDelete	DELETE /notifications/{id}	Delete a Notification
Traccar.DefaultApi	notificationsIdPut	PUT /notifications/{id}	Update a Notification
Traccar.DefaultApi	notificationsPost	POST /notifications	Create a Notification
Traccar.DefaultApi	notificationsTestPost	POST /notifications/test	Send test notification to current user via Email and SMS
Traccar.DefaultApi	notificationsTypesGet	GET /notifications/types	Fetch a list of available Notification types
Traccar.DefaultApi	permissionsDelete	DELETE /permissions	Unlink an Object from another Object
Traccar.DefaultApi	permissionsPost	POST /permissions	Link an Object to another Object
Traccar.DefaultApi	positionsGet	GET /positions	Fetches a list of Positions
Traccar.DefaultApi	reportsEventsGet	GET /reports/events	Fetch a list of Events within the time period for the Devices or Groups
Traccar.DefaultApi	reportsRouteGet	GET /reports/route	Fetch a list of Positions within the time period for the Devices or Groups
Traccar.DefaultApi	reportsStopsGet	GET /reports/stops	Fetch a list of ReportStops within the time period for the Devices or Groups
Traccar.DefaultApi	reportsSummaryGet	GET /reports/summary	Fetch a list of ReportSummary within the time period for the Devices or Groups
Traccar.DefaultApi	reportsTripsGet	GET /reports/trips	Fetch a list of ReportTrips within the time period for the Devices or Groups
Traccar.DefaultApi	serverGet	GET /server	Fetch Server information
Traccar.DefaultApi	serverPut	PUT /server	Update Server information
Traccar.DefaultApi	sessionDelete	DELETE /session	Close the Session
Traccar.DefaultApi	sessionGet	GET /session	Fetch Session information
Traccar.DefaultApi	sessionPost	POST /session	Create a new Session
Traccar.DefaultApi	statisticsGet	GET /statistics	Fetch server Statistics
Traccar.DefaultApi	usersGet	GET /users	Fetch a list of Users
Traccar.DefaultApi	usersIdDelete	DELETE /users/{id}	Delete a User
Traccar.DefaultApi	usersIdPut	PUT /users/{id}	Update a User
Traccar.DefaultApi	usersPost	POST /users	Create a User

Documentation for Models

• Traccar.Attribute
• Traccar.Calendar
• Traccar.Command
• Traccar.CommandType
• Traccar.Device
• Traccar.DeviceAccumulators
• Traccar.Driver
• Traccar.Event
• Traccar.Geofence
• Traccar.Group
• Traccar.Maintenance
• Traccar.Notification
• Traccar.NotificationType
• Traccar.Permission
• Traccar.Position
• Traccar.ReportStops
• Traccar.ReportSummary
• Traccar.ReportTrips
• Traccar.Server
• Traccar.Statistics
• Traccar.User

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication