web:access_rest_api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
web:access_rest_api [2016/02/01 20:11] mjallison [Responses] |
web:access_rest_api [2016/02/09 00:25] (current) mjallison [Responses] |
||
|---|---|---|---|
| Line 38: | Line 38: | ||
| { | { | ||
| id: integer, | id: integer, | ||
| + | expire: long, (mSec) | ||
| text: "String of announcement" | text: "String of announcement" | ||
| } | } | ||
| | | ||
| Other return objects possible are: | 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** | **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** | **Project** | ||
| { | { | ||
| + | handle: integer, | ||
| + | name: string, | ||
| + | description: string, | ||
| + | lastTrackTime: long, | ||
| + | modifiedTime: long, | ||
| + | status: integer, | ||
| + | trackCount: integer | ||
| } | } | ||
| **WorkingTime** | **WorkingTime** | ||
| { | { | ||
| + | projectHandle: integer, | ||
| + | dayStart: long, | ||
| + | morningStart: long, | ||
| + | clipToStart: boolean, | ||
| + | morningEnd: long, | ||
| + | clipToMidday: boolean, | ||
| + | afternoonStart: long, | ||
| + | clipToEnd: boolean, | ||
| + | afternoonEnd: long | ||
| } | } | ||
| **Track** | **Track** | ||
| { | { | ||
| + | handle: integer, | ||
| + | trackerAlias: string, | ||
| + | trackerSerial: string, | ||
| + | projectHandle: integer, | ||
| + | discoveryTime: long, | ||
| + | startTime: long, | ||
| + | endTime: long, | ||
| + | totalPoints: long, | ||
| + | fixType: integer, | ||
| + | attributes: object | ||
| } | } | ||
| **TrackPoints** | **TrackPoints** | ||
| { | { | ||
| + | count: integer, | ||
| + | [ Point ] | ||
| + | } | ||
| + | |||
| + | **Point** | ||
| + | { | ||
| + | time: long, | ||
| + | lat: double, | ||
| + | lon: double, | ||
| + | alt: double | ||
| } | } | ||
| **Tracker** | **Tracker** | ||
| { | { | ||
| + | serial: string, | ||
| + | alias: string, | ||
| + | lastLat: double, | ||
| + | lastLon: double, | ||
| + | lastAlt: double, | ||
| + | lastTime: long, | ||
| + | totalPoints: integer | ||
| } | } | ||
| | | ||
| **Telemetry** | **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 ===== | ===== Method Breakdown ===== | ||
| Line 84: | Line 182: | ||
| | CONNECTION (0) | | | | | | | CONNECTION (0) | | | | | | ||
| | | connect() | StorageServer | GET | userid,password,token | GR | | | | connect() | StorageServer | GET | userid,password,token | GR | | ||
| - | | | connectResetPassword() | | GET | userid,password | GR | | + | | | connectResetPassword() | | GET | userid,password | GR | **still needed** | |
| | | disconnect() | | PUT | | GR | | | | disconnect() | | PUT | | GR | | ||
| - | | | getAllAnnouncements() | Announcement* | GET | | GR [ Announcement ] | | + | | | getAnnouncements() | Announcement* | GET | | GR [ Announcement ] | |
| | ASSOCIATION (4) | | | | | | | ASSOCIATION (4) | | | | | | ||
| | | getAssociations() | Association* | GET | | | | | getAssociations() | Association* | GET | | | ||
web/access_rest_api.1454357495.txt.gz · Last modified: 2016/02/01 20:11 by mjallison
Page Tools
