Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NOTE: This document is deprecated in favor of https://developer.sagebridge.org/articles/upload_data_format.html

This documentation describes the data format Bridge expects. For documentation on how to upload files to the Bridge Server, see Bridge REST API

...

info.json should also include the "schemaRevision" field, to let tell the Bridge server which revision of the schema Bridge should use. If this is omitted, Bridge will assume schemaRevision 1.

info.json must also include the appVersion and phoneInfo fields, which describe app version and phone hardware (and optionally software) respectively. NOTE: appVersion and phoneInfo have a max length of 48 characters. Submitting appVersion or phoneInfo longer than 48 characters will be truncated.

If you have the surveyGuid and surveyCreatedOn, you can use those instead of item and schemaRevision. Example:

Code Block
  {
    "files" : [ {
      "filename" : "foo.json",
      "timestamp" : "2015-03-02T03:26:59-08:00"
    }, {
      "filename" : "bar.json",
      "timestamp" : "2015-03-02T03:27:09-08:00"
    } ],
    "surveyGuid":"983326c1-6391-4a10-9b06-82c3a3c090b4",
    "surveyCreatedOn":"2015-08-27T21:55:57.964Z",
    "appVersion" : "version 1.0.2, build 8",
    "phoneInfo" : "iPhone 6"
 }

 


Surveys

Surveys consist of metadata in the info.json file as well as individual files for each survey answer.

...

fieldDefinitions is a list of fieldDefinition entries. Each entry specifies the field name, field type, and whether the field is required or optional. A schema cannot contain fields with the same name.

Valid field types include:

...