Differences

This shows you the differences between two versions of the page.

--- web:access_rest_api [2016/02/01 20:08]
mjallison [Responses]
+++ web:access_rest_api [2016/02/09 00:25] (current)
mjallison [Responses]
@@ Line 38: / Line 38: @@
    {
       id: integer,
+      expire: long, (mSec)
       text: "String of announcement"
    }
 Other return objects possible are:
-**Folder**
+**StoredItem**
    {
-      handle: int-value,
+      handle      : int-value,
-      name  : string,
+      name        : string,
-      folders: [ string* ]
+      description : string,
-      files  : [ string* ]
+      isFolder    : boolean,
+      size        : long,
+      children: [ StoredItem* ]
+   }
+**ApplicationState** return from connection/open or connection/check
+   {
+      userid: string,
+      token: string,
+      lastPath: string,
+      hasAccess: boolean,
+      hasLicense: boolean,
+      hasTracks: boolean,
+      isAdmin: boolean,
+      isSupport: boolean
    }
 **AccountInfo**
    {
+      user: string,
+      userid: string,
+      totalSpace: long,
+      usedSpace: long
    }
+**StorageUser** (minimal needed for admin functions)
+   {
+      handle: integer,
+      customerId: string,
+      userId: string,
+      firstName: string,
+      lastName: string,
+      phone: string,
+      role: string
+   }
+**LicenseKey** (minimal needed for admin functions)
+   {
+      handle: integer,
+      type: integer,
+      number: string,
+      customerId: string,
+      maxCheckoutPeriod: long,
+      dueDate: long,
+      checkoutUser: string,
+      checkoutUserPhone: string
+   }
+**Project**
+   {
+      handle: integer,
+      name: string,
+      description: string,
+      lastTrackTime: long,
+      modifiedTime: long,
+      status: integer,
+      trackCount: integer
+   }
+**WorkingTime**
+   {
+      projectHandle: integer,
+      dayStart: long,
+      morningStart: long,
+      clipToStart: boolean,
+      morningEnd: long,
+      clipToMidday: boolean,
+      afternoonStart: long,
+      clipToEnd: boolean,
+      afternoonEnd: long
+   }
+**Track**
+   {
+      handle: integer,
+      trackerAlias: string,
+      trackerSerial: string,
+      projectHandle: integer,
+      discoveryTime: long,
+      startTime: long,
+      endTime: long,
+      totalPoints: long,
+      fixType: integer,
+      attributes: object
+   }
+**TrackPoints**
+   {
+      count: integer,
+      [ Point ]
+   }
+**Point**
+   {
+      time: long,
+      lat: double,
+      lon: double,
+      alt: double
+   }
+**Tracker**
+   {
+      serial: string,
+      alias: string,
+      lastLat: double,
+      lastLon: double,
+      lastAlt: double,
+      lastTime: long,
+      totalPoints: integer
+   }
+**Telemetry**
+   {
+      serial: string,
+      time: long,
+      channel: int,
+      value: numeric | string (depends on channel type)
+   }
+**Vehicle**
+   {
+      assetId: string,
+      type: integer,
+      status: integer,
+      description: string,
+      color: integer, (RGBA 32bit value)
+      avgLoad: double
+   }
 ===== Method Breakdown =====
@@ Line 60: / Line 182: @@
 | CONNECTION (0) |                             |                   | | |
 |                | connect()                   | StorageServer     | GET  | userid,password,token | GR |
-|                | connectResetPassword()      |                   | GET  | userid,password | GR |
+|                | connectResetPassword()      |                   | GET  | userid,password | GR | **still needed** |
 |                | disconnect()                |                   | PUT  | | GR |
-|                | getAllAnnouncements()       | Announcement*     | GET  | | GR [ Announcement ] |
+|                | getAnnouncements()          | Announcement*     | GET  | | GR [ Announcement ] |
 | ASSOCIATION (4) |                            |                   | | |
 |                | getAssociations()           | Association*      | GET  | |

AGTEK R & D Wiki

User Tools

Site Tools

Differences

Page Tools