home api list

Hexostore API Documentation

range

/api/range/

List methods: get, post, patch

Detail methods: get, put, patch, delete

A Range represents a period in time and is created independently from records. A activitytype and trainingroutine may be associated with a Range to provide more contextual data. These associations must be specified within the context field when creating or updating a Range. Some examples are shown below.

You may set a value for an activityattribute in the activityattributes field. The activityattributes field is processed only if it is provided. In this API, foreign keys are usually not updated but this field is an exception. If you supply activityattributes during a PUT or PATCH, the activityattribute values will replace/update the existing activityattribute values. If an activityattribute is missing or has a missing or null value, its value will be deleted.

If you omit the activityattributes field altogether, it is ignored. Thus passing an empty value for activityattributes will delete all the existing values whereas omitting it altogether will have no effect. An important distinction!

The status reflects the "most important" status of the records available in the Range. "Most important" means if any records contain a given status, that status is assigned to the Range. The order of importance is:

• error,
• incomplete,
• realtime,
• realtime_complete,
• queued,
• processing,
• complete,
• deleted

Therefore if any Records have a status of 'error', that becomes the status of the Range, if not, 'incomplete' is checked and so on. There is one more status that is possible; If no records are available, the status is 'empty'.

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 Range 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 at http://www.thisisant.com/resources/fit. We export the following for each Fit Activity:

• UserProfile: a summary of the user's stats at the start of the Activity.

• Session: a summary of a section of data in the Activity. For now, 1 per file, summarizing the whole file.

• Lap: a sub-section of the exported data. This is used to represent sub- ranges. We export Ranges one rank below the exported Range.

• Record: a point-in-time description of the user's state, HR, position, etc. We export a Record for each GPS point if available and for each second if there is no GPS data.

Examples

Some examples for creating Ranges and linking them to different contexts:

Case: Create a top-level Range to incorporate a TrainingRoutine.

A post to /api/range/ of:

{
    "user": "/api/user/99/",
    "start": 362559400192,
    "end": 362559423513,
    "rank": 0,
    "context": {
        "trainingroutine": "/api/trainingroutine/1013/"
    }
}

Will yield:

{
    "id": 20279,
    "user": "/api/user/99/"
    "start": 362559400192,
    "end": 362559423513,
    "rank": 0,
    "context": {
        "activitytype": "/api/activitytype/103/"
        "targets": null,
        "trainingroutine": "/api/trainingroutine/1013/"
    },
    /*
    remainder omitted for brevity
    */
}

Case: Create a step Range within a TrainingRoutine.

A post to /api/range/ of:

{
    "user": "/api/user/99/",
    "start": 362559400192,
    "end": 362559401472,
    "rank": 1,
    "context": {
        "trainingroutine": "/api/trainingroutine/1013/",
        "step": 0
    }
}

Will yield:

{
    "id": 20279,
    "user": "/api/user/99/"
    "start": 362559400192,
    "end": 362559401472,
    "context": {
        "activitytype": "/api/activitytype/10/",
        "targets": {
            "custom_target_high": 0,
            "custom_target_low": 0,
            "duration_type": "distance",
            "duration_value": 3500,
            "intensity": "active",
            "target_type": "open",
            "target_value": 0
        },
        "trainingroutine": null
    },
    /*
    remainder omitted for brevity
    */
}

Case: create a Range linked with an activitytype and no trainingroutine

A post to /api/range/ of:

{
    "user": "/api/user/99/",
    "start": 362559400192,
    "end": 362559401472,
    "context": {
        "activitytype": "/api/activitytype/1/",
        "targets": {
            "custom_target_high": 0,
            "custom_target_low": 0,
            "duration_type": "distance",
            "duration_value": 3500,
            "intensity": "active",
            "target_type": "open",
            "target_value": 0
        }
    }
}

Will yield:

{
    "id": 20279,
    "user": "/api/user/99/"
    "start": 362559400192,
    "end": 362559401472,
    "context": {
        "activitytype": "/api/activitytype/1/",
        "targets": {
            "custom_target_high": 0,
            "custom_target_low": 0,
            "duration_type": "distance",
            "duration_value": 3500,
            "intensity": "active",
            "target_type": "open",
            "target_value": 0
        }
        "trainingroutine": null
    },
    /*
    remainder omitted for brevity
    */
}

The targets are optional, so a post to /api/range/ of:

{
    "user": "/api/user/99/",
    "start": 362559400192,
    "end": 362559401472,
    "context": {
        "activitytype": "/api/activitytype/1/"
    }
}

Will yield:

{
    "id": 20279,
    "user": "/api/user/99/"
    "start": 362559400192,
    "end": 362559401472,
    "context": {
        "activitytype": "/api/activitytype/1/",
        "targets": null,
        "trainingroutine": null
    },
    /*
    remainder omitted for brevity
    */
}

© 2024 by Carré Technologies Inc.