home api list

Hexostore API Documentation

record

/api/record/

List methods: get, post

Detail methods: get, put, patch, delete

Records represent uploaded data. When a user syncs her device a record is created to link together all the associated data that is recorded for that session.

This resource may be requested in FIT format and TCX format in addition to the default, JSON. Specify the format you would like in the Accept header. FIT and TCX are represented by the application/vnd.ant.fit and application/vnd.garmin.tcx+xml mimetypes respectively.

We export a Record as a Fit Activity File or TCX Activity. See chapter 9 Activity File (page 47) of D00001309 FIT File Types Description Rev 1.6.pdf (available here). The TCX specification can be found at: http://www.garmindeveloper.com/schemas /tcx/v2/

We export the following for each Fit Activity:

Fields

algo:

Version of algo used to process datatype

This field is readonly.

data_status:

Information on the underlying data.

This field is readonly.

dev_id:

dev_id: Device ID (phone) 32 char.

This field may be blank

This field will default to: '' (empty string)

device:

A reference to device. Maybe specified by URI or ID. Using a URI is recommended.

This field may be blank

This field may be null

device_start:

Original recording start time from the Hexoskin device.

This field may be blank

This field will default to: '' (empty string)

duration:

An integer representing the desired duration in seconds

This field is readonly.

end:

Recording end. An integer indicating the number of 256ths of a second that have passed since Jan 1, 1970 UTC, ie. a traditional timestamp, multiplied by 256.

This field may be blank

This field may be null

firmware_rev:

firmware_rev: Hexoskin Firmware revision, char.

This field will default to: 000

garment:

Garment UID (Example: SNX334000). Add the prefix "SN" to the value for the complete UID. A value of 00000000 indicates that the garment is not defined.

This field may be blank

This field will default to: '' (empty string)

id:

The primary key for this resource. Integer data. Ex: 2673

This field is readonly.

importfile:

A single related resource. Can be either a URI or set of nested resource data.

This field is readonly.

last_modified:

A date & time as a string. Ex: "2010-11-10T03:07:43"

This field is readonly.

metrics:

This field will contain an array of the metrics specified in include_metrics. If this argument is not supplied or there are no metrics for the given Range, it will be empty.

This field is readonly.

resource_uri:

The unique URI where the object resides.

This field is readonly.

soft_protocole:

Integer data. Ex: 2673

This field is required.

soft_uid:

soft_uid: Software UID.

This field is required.

start:

Recording start. An integer indicating the number of 256ths of a second that have passed since Jan 1, 1970 UTC, ie. a traditional timestamp, multiplied by 256.

This field may be blank

This field may be null

start_date:

A date & time as a string. Ex: "2010-11-10T03:07:43"

This field is readonly.

status:

One of "realtime", "realtime_complete", "syncing", "complete", "queued", "processing", "error" or "incomplete". "Realtime" means that the Record has been created by HxSolo for realtime tracking but hasn't been synced yet. "Complete" and "incomplete" indicate whether or not the record currently has a complete set of data in the database. "Queued" indicates the record is queued for processing. "processing" indicates the record is currently being processed. "error" indicates that an error was encountered while processing the record.

This field is readonly.

user:

A user. Maybe specified by URI, email, or ID. Using a URI is recommended.

This field is returned fully populated.

Filtering Options

device: exact, in, gt, gte, lt, lte, range

device_start: exact, in, gt, gte, lt, lte, range

duration: exact, in, range, gt, gte, lt, lte

end: exact, range, gt, gte, lt, lte

id: exact, in, gt, gte, lt, lte, range

include_histograms: exact

This is not a filtering field but a comma-separated list of histogram IDs returned for the Record. See histograms available at: histogram

include_metrics: exact

This is not a filtering field but a comma-separated list of metric IDs returned for the Record. See metrics available at: metric

last_modified: exact, in, range, gt, gte, lt, lte

start: exact, range, gt, gte, lt, lte

status: exact, in

user: exact, in, gt, gte, lt, lte, range

Sorting Options

id, start, end, device, user, last_modified

© 2014 by CarrĂ© Technologies Inc.