Versions Compared

Key

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

...

  • Methods have a quota limit. Requests will be rejected if you reach your quota limit.
  • Each form data record has two auto generated unique key fields. Please be sure to use to the value from the correct key field when using a specific method:
    • RecordKey – This is a long text value that is more efficient than RecordId. This is referred to as "Record_Key" in exports. 
    • RecordId – RecordId is a shorter human readable value that contains an auto increment number at the end. This is referred to as "Form_Record" field in the View data and Dispatch tabs and in exports. 
  • Both RecordKey and RecordId are unique for every record.
  • Some of the API methods described here use and/or return two different date:time values:
    • Date_Created – This is the date:time when a record is first saved as complete on a mobile device (or on the website).
    • Date_Received – This is the date:time when a record was first received by the website.
  • Date_Received is the the most reliable method for preventing overlapping record ranges. Since doForms works in connected AND disconnected manner, records may not become available to the web services until some time after the Date_Created time.
  • All date/time values are returned in the UTC/GMT time zone. You can use the Time Zone parameter that is returned by the newest version of the getDataByRecordKey method to calculate the local Date_Created.
  • Note that in all cases the "[WS ID]" and "[Password]" refer to a specific doForms project/form web service.
  • Fields are not guaranteed to always be returned in the same order. Always use Use the field name instead of the index when parsing data.

...