Content Comparison

[
  {
    "key": "def123",
    "name": "Device one",
    "email": "me@me.com",
    "number": "5551231234",
    "teamKey": "tuv123"
  },
  {
    "key": "def234",
    "name": "Device two",
    "email": "you@you.com",
    "number": "5551234321",
    "teamKey": "tuv123",
    "lastTrack": {
      "date": "2018-06-29T11:56:26.000Z",
      "offset": -240,
      "status": "MOVING",
      "position": {
        "accuracy": 20.885,
        "altitude": 304.899,
        "latitude": 34.101222,
        "longitude": -84.0015005
      },
      "velocity": {
        "bearing": 31.2198,
        "direction": "NNE",
        "distance": 489.332,
        "speed": 7.6032
      }
    }
  }
]

Returns all devices the user has access to.

• Get a more limited list of devices at /teams/{key}/devices.
• If the device has GPS tracking enabled, the last track received is returned in lastTrack.
• Optional query parameters: latitude, longitude
  • If a device has a lastTrack node, return the distance to the provided latitude and longitude in lastTrack.distanceToTarget.
• Requires user authentication.

{
  "key": "def123",  
  "number": "5551231234",
  "name": "Device one",
  "email": "me@me.com",
  "teamKey": "tuv123"
}

Returns the requested device.

• If number = "Available" the device license has not been assigned to a device.
• Optional query parameters: latitude, longitude
  • If a device has a lastTrack node, return the distance to the provided latitude and longitude in lastTrack.distanceToTarget.
• Requires user authentication.

[
  {
    "key": "act123",
    "submissionKey": "abc123",
    "projectKey": "pqr123",
    "formKey": "fgh123",
    "receiveTime": "2019-08-20T14:38:54.896-04:00",
    "type": "new",
    "submissionId": "acme$$12345$$Published&&1",
    "submissionName": "My name | 3",
    "projectName": "Main Project",
    "formName": "First Form v1",
    "userId": "5551231234",
    "userName": "Device one"
  }
]

Returns all submission activity for a device that the user has access to.

• Required query parameters:
  • @beginTime - ISO formatted date/time inclusive
  • @endDate - ISO formatted date/time exclusive
• Requires user token authentication.
• To query all activity, see the /activity? endpoint.

[
  {
    "key": "rst123",
    "id": "acme$$12345$$Published&&1"
  },
  {
    "key": "rst124",
    "id": "acme$$12345$$Published&&2"
  }
]

• Requires user or webservice authentication.

Delete a dispatch.

• Any related submission can be deleted at /submissions/{key or id}.
• Requires user or webservice authentication.

{ "key": "abc123",
  "id": "acme$$12345$$Published&&1",
  "name": "My name | 3",
  "type": "dispatch",
  "formKey": "fgh123",
  "formName": "First Form v1",
  "formVersion": 1.0, 
  "offset": -240,
  "ownerId": "5551231234",
  "ownerName": "Device one",
  "ownerType": "device",
  "projectKey": "pqr123",
  "receiveTime": "2019-08-20T14:38:54.896-04:00",
  "sourceId": "me@me.com",
  "sourceName": "My Name",
  "sourceType": "user",
  "status": "On site",
  "statusTime": "2019-08-20T15:30:24.052-04:00",
  "systemStatus":"Viewed",
  "timezone": "Eastern Daylight Time",
  "updateTime": "2019-08-20T15:35:19.139-04:00",
  "updateUser": "me@me.com", 
  "fields": [
    { "name": "Name",
      "data": "text",
      "type": "text",
      "text": "My name" 
    },
    { "name": "Choose",
      "data": "text",
      "type": "choose_one",
      "text": "3"
    },
    { "name": "Form_Title",
      "data": "text",
      "type": "label",
      "text": "Form_Title"
    },
    { "name": "Today_s_date",
      "data": "date",
      "type": "date_time",
      "date": "2019-08-19T00:00:00.000Z"
    },
    { "name": "Number",
      "data": "integer",
      "type": "numeric",
      "integer": 25
    },
    { "name": "Customer_Table",
      "data": "rows",
      "type": "table",
      "rows": [
        { "index": 0,
           "fields": [
            { "name": "Customer_ID",
              "data": "text",
              "type": "lookup",
              "text": "32-151"
            },
            { "name": "Customer_name",
              "data": "text",
              "type": "text",
              "text": "ABC Companies"
            } ]
        },
        { "index": 1,
          "fields": [
            { "name": "Customer_name",
              "data": "text",
              "type": "text",
              "text": "Global Industries"
            },
            { "name": "Customer_ID",
              "data": "text",
              "type": "lookup",
              "text": "44-158"
            } ]
        } ]
    }
}

Returns the data of a dispatch record by key or id.

• See /submissions/{key} endpoint for more details.
  
  
• Dispatch specific fields:
  • submissionKey - Populated if the dispatch has been converted into a submission.
  • systemStatus - Same as status, but will never be set to a user defined status value.
• Requires user or webservice authentication.

{
  "key": "fil123",
  "name": "My picture.jpg",
  "size": 2276338,
  "md5": "md123==",
  "createTime": "2019-07-18T19:22:40.958Z",
  "updateTime": "2019-07-18T19:52:38.600Z",
  "expireTime": "2019-08-17T19:52:38.600Z"
}

Get information about a file.

• Requires user authentication.

Delete a file.

• Requires user authentication.
• Files are automatically deleted after 30 days.

[
  {
    "key": "act124",
    "submissionKey": "abc123",
    "projectKey": "pqr123",
    "formKey": "fgh123",
    "receiveTime": "2019-08-20T15:35:19.139-04:00",
    "type": "update",
    "submissionId": "acme$$12345$$Published&&1",
    "submissionName": "My name | 3",
    "projectName": "Main Project",
    "formName": "First Form v1",
    "userId": "me@me.com",
    "userName": "My Name"
  },
  {
    "key": "act123",
    "submissionKey": "abc123",
    "projectKey": "pqr123",
    "formKey": "fgh123",
    "receiveTime": "2019-08-20T14:38:54.896-04:00",
    "type": "new",
    "submissionId": "acme$$12345$$Published&&1",
    "submissionName": "My name | 3",
    "projectName": "Main Project",
    "formName": "First Form v1",
    "userId": "5551231234",
    "userName": "Device one"
  }
]

Returns all submission activity for a form that the user has access to.

• Requires user or webservice authentication.
• Required query parameters:
  • @beginTime - ISO formatted date/time inclusive
  • @endDate - ISO formatted date/time exclusive
• Requires user token authentication.
• To query all activity, see the /activity? endpoint.

[
  { "name": "Form_Title",
    "data": "text",
    "type": "label",
    "options": {
    "label": { "en": "First Form" },
      "level": 0 }
  },
  { "name": "Name",
    "data": "text",
    "type": "text",
    "options": {
      "label": { "en": "Name" },
      "level": 0 }
  }
]

Returns the fields array for the selected form by key or by id.

• Requires user or webservice authentication.
• See the /forms/{key} endpoint for more detail.

[
  {
    "key": "pqr123",
    "name": "Main Project"
  },
  {
    "key": "pqr234",
    "name": "Second Project"
  }
]

Returns all projects the requested form is assigned to.

• Requires user or webservice authentication.

{
  "key": "ghi123",
  "name": "Group One"
}

Returns the requested group by key.

• Requires user authentication.

[
  {
    "key": "lmn123",
    "name": "Customer_List",
    "description": "List of customers",
    "useForm": false,
    "encrypt": false,
    "version": 2,
    "createTime": "2021-07-09T21:01:47.037Z",
    "createUser": "you@you.com",
    "updateTime": "2021-07-09T23:19:02.132Z",
    "updateUser": "you@you.com"
  },
  {
    "key": "lmn124",
    "name": "Lookups_Parts_Form",
    "description": "",
    "useForm": true,
    "useFilter": false,    
    "formKey": "fgh123",
    "projectKey": "pqr123",
    "update": true,
    "encrypt": false,    
    "version": 70,
    "createTime": "2021-05-04T20:24:31.952Z",
    "createUser": "you@you.com",
    "updateTime": "2021-07-09T23:19:02.132Z",
    "updateUser": "you@you.com"
  }
]

Return all lookups in the account.

• Requires user authentication.
• useForm - true if the lookup is a form based lookup.
• useFilter - true if a form based lookup has a filter applied.
• update - true if the form based lookup updates automatically as submissions are updated.
• encrypt - true if the lookup is encrypted.
• version - increments each time the lookup is updated.

{
  "name": "Customer_List",
  "description": "List of customers",
  "finalize": true,
  "encrypt": false,
  "columns": [
    {
      "name": "Customer code",
      "caption": "The customer code"
    },
    {
      "name": "Customer name"
    }
  ],
  "rows":[
    {"Customer code": "ABC123", "Customer name": "ABC Customer"},
    {"Customer code": "DEF456", "Customer name": "DEF Customer"}
  ]
}

Add a new lookup.

• Requires user authentication.
• Form based lookups can not be added via the API.
• name - required. If the name provided duplicates the name of an existing lookup, the name will be made unique.
• description - optional.
• finalize - optional. True if all rows are included in this request. The lookup will be marked as ready to deliver to devices.
• encrypt - optional. True if the lookup should be encrypted at rest. The account must have field encryption enabled to use encryption.
• columns - required. The columns in the lookup. Columns can not be changed after the lookup is created.
  • name - required.
  • caption - optional.
• rows - optional. The first set of rows in the lookup. The field names must match the names specified in columns. Add additional rows at PUT /lookups/{key} or POST /lookups/{key}/rows.
  
  • Property names must match the names defined in the columns.
• fileName - optional. The name of a file previously uploaded at POST /files/{fileName}.
• fileKey - optional. The key of a file previously uploaded at POST /files/{fileName}. If fileName or fileKey is specified, rows will be ignored. The file must be either CSV or xlsx format and the columns in the file must match the columns specified in this request. Add additional rows from a file at PUT /lookups/{key}.
• fileHasHeaders - optional. Set to false if the file to import does not have a header row.

{
  "code": 200,
  "count": 2,
  "lookup": {
    "key": "lmn123",
    "name": "Customer_List",
    "description": "List of customers",
    "useForm": false,
    "encrypt": false,
    "version": 1,
    "createTime": "2021-07-09T21:01:47.037Z",
    "createUser": "you@you.com",
    "updateTime": "2021-07-09T21:01:47.037Z",
    "updateUser": "you@you.com",
    "columns": [
      {
        "name": "Customer code",
        "caption": "The customer code"
      },
      {
        "name": "Customer name"
      }
    ]
  }
}

• count - The number of rows added in this request.
• lookup - The lookup that was added.

{
  "key": "lmn124",
  "name": "Lookups_Parts_Form",
  "description": "",
  "useForm": true,
  "useFilter": false,
  "formKey": "fgh123",
  "projectKey": "pqr123",
  "update": true,
  "encrypt": false,
  "version": 70,
  "createTime": "2021-05-04T20:24:31.952Z",
  "createUser": "you@you.com",
  "updateTime": "2021-07-09T23:19:02.132Z",  
  "updateUser": "you@you.com",  
  "columns": [
    {
      "name": "Part_Number",
      "caption": "Part number"
    },
    {
      "name": "Part_Name",
      "caption": "Part name"
    }
  ]
}

Return a lookup.

• columns - Requires user authentication.
• columns - the list of columns in the lookup.

{
  "finalize": true,
  "rows":[
    {"Customer code": "ABC123", "Customer name": "ABC Customer"},
    {"Customer code": "DEF456", "Customer name": "DEF Customer"}
  ]
}

Replace all rows in the lookup with the rows in the request.

• Requires user authentication.
• finalize - optional. True if no more rows will be added and the updated lookup should be sent to devices.
• rows - optional. The field names must match the names specified in columns when the lookup was created.
• If the existing lookup contains a large number of rows, or if a large number of rows is included in the request body, the request may fail.
• fileName - optional. The name of a file previously uploaded at POST /files/{fileName}.
• fileKey - optional. The key of a file previously uploaded at POST /files/{fileName}. If fileName or fileKey is specified, rows will be ignored. The file must be either CSV or xlsx format and the columns in the file must match the columns specified in this request.
• fileHasHeaders - optional. Set to false if the file to import does not have a header row.

{
  "code": 200,
  "count": 2
}

• count - The number of rows added to the lookup in this request.

{
  "code": 951,
  "message": "Time out error. Please try a smaller request."
}

Delete a lookup.

• Requires user authentication.
• Form based lookups can not be deleted.
• Lookups that are currently used by forms can not be deleted. Ensure that no forms are using this lookup by checking GET /lookups/{key}/forms.
• Lookups that contain rows can not be deleted. Empty the lookup by calling DELETE /lookups/{key}/rows.

[
  {
    "name": "Part_Number",
    "caption": "Part number"
  },
  {
    "name": "Part_Name",
    "caption": "Part name"
  }
]

Return the columns in a lookup.

• Requires user authentication.

[
  {
    "Customer code": "GHI789", 
    "Customer name": "GHI Customer"
  },
  {
    "Customer code": "JKL012", 
    "Customer name": "JKL Customer"
  }
]

Append rows to a lookup.

• Requires user authentication.
• Use query parameter @finalize=true to mark the lookup as ready to distribute to devices.

{
  "code": 200,
  "count": 2
}

• count - The number of records added to the lookup in this request.

{
  "code": 200,
  "complete": true
}

Delete rows from a lookup.

• Requires user authentication.
• complete - true if all records have been removed from the lookup. Call the endpoint repeatedly until complete = true before beginning any other operation on the lookup.

{
  "Customer code": "DEF456", 
  "Customer name": "DEF Customer",
  "@id": 4667408283598848
}

Get a single row in a lookup by id.

• Requires user authentication.

{
  "Customer code": "DEF456", 
  "Customer name": "DEF Customer New Name"
}

Update a row in a lookup.

• Requires user authentication.
• Use query parameter @finalize=true to mark the lookup as ready to distribute to devices.

{
  "Customer code": "DEF456", 
  "Customer name": "DEF Customer New Name",
  "@id": 4667408283598848
}

Remove a row from a lookup.

• Requires user authentication.
• Use query parameter @finalize=true to mark the lookup as ready to distribute to devices.

{
  "key": "nop123",
  "submissionKey": "abc123",
  "webserviceId": "acme$$12345$$Published$$67890",
  "customerKey": "cde123",
  "event": "create",
  "status": "completed",
  "message": "One record updated."
}

Returns the requested webhook notification.

• Requires user or webservice authentication.
• See Webhooks for more information.

{
  "status": "completed",
  "message": "One record updated."
}

• Requires user or webservice authentication.
• status can be one of "completed", "failed".
• message (optional) is any message for the end user. Maximum 1,000 characters.
• See Webhooks for more information.

[
  {
    "key": "act124",
    "submissionKey": "abc123",
    "projectKey": "pqr123",
    "formKey": "fgh123",
    "receiveTime": "2019-08-20T15:35:19.139-04:00",
    "type": "update",
    "submissionId": "acme$$12345$$Published&&1",
    "submissionName": "My name | 3",
    "projectName": "Main Project",
    "formName": "First Form v1",
    "userId": "me@me.com",
    "userName": "My Name"
  },
  {
    "key": "act123",
    "submissionKey": "abc123",
    "projectKey": "pqr123",
    "formKey": "fgh123",
    "receiveTime": "2019-08-20T14:38:54.896-04:00",
    "type": "new",
    "submissionId": "acme$$12345$$Published&&1",
    "submissionName": "My name | 3",
    "projectName": "Main Project",
    "formName": "First Form v1",
    "userId": "5551231234",
    "userName": "Device one"
  }
]

Returns all submission activity for a project that the user has access to.

• Requires user or webservice authentication.
• Required query parameters:
  • @beginTime - ISO formatted date/time inclusive
  • @endDate - ISO formatted date/time exclusive
• Requires user token authentication.
• To query all activity, see the /activity? endpoint.

[
  {
    "key": "rst123",
    "name": "Report 1"
  },
  {
    "key": "rst124",
    "name": "Report 2"
  },
  {
    "key": "rst125",
    "name": "Report 3"
  }
]

Returns all published reports.

• Requires user authentication.
• Requires report manager rights.

[
  {
    "key": "rst123",
    "name": "Report 1"
  },
  {
    "key": "rst124",
    "name": "Report 2"
  }
]

Returns reports assigned to the user.

• Requires user authentication.

[
  {
    "key": "qrs123",
    "createDate": "2020-03-20T16:30:15.517Z",
    "type": "pdf",
    "name": "Report-1.pdf"
  },
  {
    "key": "qrs124",
    "createDate": "2020-03-23T16:33:16.022Z",
    "type": "pdf",
    "name": "Report-1.pdf"
  }
]

Returns all current results for the selected report.

• Requires user authentication.
• Report results are purged after seven days.
• Possible values for type:
  • pdf
  • xlsx

{
  "key": "qrs123",
  "createDate": "2020-03-20T16:30:15.517Z",
  "type": "pdf",
  "name": "Report-1.pdf"
}

Returns the details for the selected result.

• Requires user authentication.

Content-Type: application/pdf
Content-Disposition: filename="Report-1.pdf"

Returns the PDF file for the selected result.

• Requires user authentication.
• Only valid for results with type=pdf

Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Disposition: attachment; filename="Report-1.xlsx"

Returns the Excel file for the selected result.

• Requires user authentication.
• Only valid for results with type=xlsx

[
  {
    "key": "abc123",
    "id": "acme$$12345$$Published&&1"
  },
  {
    "key": "abc124",
    "id": "acme$$12345$$Published&&2"
  }
]

Returns submission identifiers that match a query.

• Requires user or webservice authentication.
• The project and form to query must be specified in one of two ways:
  • By using web service authentication.
  • Or by specifying @projectKey and @formKey in the URL.
• The following system fields can be queried:
  • @receiveTime - The date and time the submission was first received by the doForms servers.
  • @statusTime - The date and time the status was last changed.
  • @updateTime - The date and time the submission was last edited.
  • @status - The current status of the submission.
• Any user defined field that is not inside a table or repeatable can be queried by using the data name of the field as the parameter name.
  
  
• Include a parameter once for an equals condition:
  
  • A single parameter for date and date/time fields is interpreted as requesting a 24 hour range beginning with the parameter value.
  • A single parameter for time fields is interpreted as requesting a 1 minute range beginning with the parameter value.
• Include a parameter twice for a between condition:
  • The first value is inclusive (greater than or equal) and the second is exclusive (less than).
    
    
• The first field specified in the parameters is used as the primary condition:
  
  • Text comparison is case sensitive.
  • Text sorting is UTF-8 (e.g. "Z" is before "a").
  • Optimize query performance by using the condition that will return the fewest records as the primary condition.
  • To use case insensitive text comparison, provide a date range parameter as the primary condition.
• Date/time parameters:
  • Use ISO date/time format with timezone offset.
  • If the offset is positive, URL encode the plus as %2B.
  • The date portion is ignored when querying time type fields. 
  • The time portion is ignored when querying date type fields.
• URL encode text parameter values.
• Numeric parameters:
  • Use a period to specify decimal place.
• Use @limit and @skip to specify a range of records to return.
  • If @limit is not specified a default value of 200 is used.
  • If @skip is not specified a default value of 0 is used.
  • If the number of submissions returned matches @limit, then more submissions remain to be retrieved.
• Example queries: 
  • Get submissions by received date range for a 24 hour period. Project and form specified by web service authentication:
    
    • /submissions?@receiveTime=2019-09-15T13:08:36.000-04:00&@receiveTime=2019-09-16T13:08:36.000-04:00
  • Get submissions where Order_Code = "A123". Project and form specified as URL parameters:
    
    • /submissions?@projectKey=pqr123&@formKey=fgh123&Order_Code=A123

Delete a submission

• Requires user or webservice authentication.
• Any related dispatch record can be deleted at /dispatches/{key or id}.

{ "key": "abc123",
  "id": "acme$$12345$$Published&&1",
  "name": "My name | 3",
  "type": "submission",
  "dispatchKey": "abc456",
  "formKey": "fgh123",
  "formName": "First Form v1",
  "formVersion": 1.0,  
  "offset": -240,
  "ownerId": "5551231234",
  "ownerName": "Device one",
  "ownerType": "device",
  "projectKey": "pqr123",
  "openTime": "2019-08-20T14:20:19.378-04:00",
  "createTime": "2019-08-20T14:38:51.591-04:00",
  "receiveTime": "2019-08-20T14:38:54.896-04:00",
  "sourceId": "me@me.com",
  "sourceName": "My Name",
  "sourceType": "user",
  "status": "Completed",
  "statusTime": "2019-08-20T15:30:24.052-04:00",
  "timezone": "Eastern Daylight Time",
  "updateTime": "2019-08-20T15:35:19.139-04:00",
  "updateUser": "me@me.com",  
  "fields": [
    { "name": "Name",
      "data": "text",
      "type": "text",
      "text": "My name" 
    },
    { "name": "Choose",
      "data": "text",
      "type": "choose_one",
      "text": "3"
    },
    { "name": "Form_Title",
      "data": "text",
      "type": "label",
      "text": "Form_Title"
    },
    { "name": "Signature",
      "data": "blob",
      "type": "signature",
      "blob": { 
        "key": "bcd123",
        "id": "acme$$08202019165520$$Published&&1$$S1",
        "type": "jpg" }
    },
    { "name": "Picture",
      "data": "blob",
      "type": "image",
      "blob": { 
        "key": "bcd124",
        "id": "acme$$08202019165520$$Published&&1$$P1",
        "type": "jpg" }
    },
    { "name": "Today_s_date",
      "data": "date",
      "type": "date_time",
      "date": "2019-08-19T00:00:00.000Z"
    },
    { "name": "Number",
      "data": "integer",
      "type": "numeric",
      "integer": 25
    },
    { "name": "Customer_Table",
      "data": "rows",
      "type": "table",
      "rows": [
        { "index": 0,
          "fields": [
            { "name": "Customer_ID",
              "data": "text",
              "type": "lookup",
              "text": "32-151"
            },
            { "name": "Customer_name",
              "data": "text",
              "type": "text",
              "text": "ABC Companies"
            } ]
        },
        { "index": 1,
          "fields": [
            { "name": "Customer_name",
              "data": "text",
              "type": "text",
              "text": "Global Industries"
            },
            { "name": "Customer_ID",
              "data": "text",
              "type": "lookup",
              "text": "44-158"
            } ]
        } ]
    }
}

Returns the data captured in a form submission by key or id.

• Requires user or webservice authentication.
• key - The key identifier of the submission.
• id - The human readable identifier of the submission.
• name - The record name of the submission.
• type - The type of data record. Always "submission".
• dispatchKey - The key of the dispatch linked to this submission. Populated only if dispatch was used to capture the data. Retrieve the dispatch at /dispatches/{key or id}.
• formKey - The key of the form definition.
• formName - The name of the form.
• formVersion - The form version used to generate this response. May be different than the version used to capture the data.
• offset - The number of minutes offset from UTC as captured by the device.
• ownerId - The human readable identifier of the record owner. Owner fields are only populated if the record was dispatched or forwarded and represent the last owner of the record.
• ownerName - The name of the owner.
• ownerType - The owner type. Possible values are "device", "email", "link".
• projectKey - The key of the project.
• openTime - The time the submission was started on the device in the device local time.
• createTime - The time the submission was first saved as complete on the device in the device local time.
• receiveTime - The time the submission was received at the server in the device local time.
• sourceId - The human readable identifier of the record source. Source fields represent the originator of the record.
• sourceName - The name of the source.
• sourceType - The source type. Possible values are "device", "link", "user".
• deviceId - The device hardware id.
• deviceKey - The key of the device.
• status - The current status of the record.
• statusTime - The time the status was last updated.
• timezone - The name of the timezone as captured by the device.
• updateTime - The time the submission was last edited.
• updateUser - The user name of the last user to edit the submission.
• fields - The array of fields. See the /forms/{key} endpoint for more details.
  • name - The data name of the field.
  • type - The type of control.
  • data - The data type. Also indicates the property where the data can be retrieved.
    
    
• Possible values for data:
  • blob - An attachment:
    • key - The key of the attachment.
    • id - The human readable identifier of the attachment.
    • type - The extension that should be used when saving the attachment.
  • date - A date value with time set to 00:00 utc.
  • datetime - A date/time value in device local time.
  • email - An email message:
    
    • addresses - An array of email addresses.
    • message - The message.
  • fax - A fax message:
    • addresses - An array of fax numbers.
    • message - The message on the fax cover page.
  • fields - An array of fields.
  • integer - An integer value.
  • location - A location:
    • longitude - The longitude in decimal format.
    • latitude - The latitude in decimal format.
    • altitude - The altitude in meters.
    • accuracy - The accuracy in meters.
  • number - A decimal value.
  • rows - An array of rows:
    • index - The row number (zero based).
    • fields - An array of fields.
  • strings - An array of strings.
  • text - A string.
  • time - A time value in device local time with date set to Jan 1, 1970.
    
    
• Additional form definition information can be returned with each field:
  • choices - Add "?choices=true" to the URL to include the list of choices with each choose type field.
  • options - Add "?options=true" to the URL to include the additional field options with each field.
  • To add both choices and options use: /submissions/{key}?choices=true&options=true
  • Including these options may increase the response size substantially.

[
  {
    "key": "act123",
    "submissionKey": "abc123",
    "projectKey": "pqr123",
    "formKey": "fgh123",
    "receiveTime": "2019-08-20T18:38:54.896Z",
    "type": "new",
    "submissionId": "acme$$12345$$Published&&1",
    "submissionName": "My name | 3",
    "projectName": "Main Project",
    "formName": "First Form v1",
    "userId": "5551231234",
    "userName": "App User"
  },
  {
    "key": "act124",
    "submissionKey": "abc123",
    "projectKey": "pqr123",
    "formKey": "fgh123",
    "receiveTime": "2019-08-20T19:13:04.387Z",
    "type": "update",
    "submissionId": "acme$$12345$$Published&&1",
    "submissionName": "My name | 3",
    "projectName": "Main Project",
    "formName": "First Form v1",
    "userId": "me@me.com",
    "userName": "My Name"
  }
]

Returns the activity of the selected submission.

• Requires user or webservice authentication.
• receiveDate - The date the activity occured.
• type - new or update.
• formName - The record name as calculated at the time of the activity.
• userId - The mobile number or email address of the mobile user or web user that made the change.
• userName - The nickname or the full name of the mobile user or web user that made the change.

[
  {
    "key": "bcd123",
    "id": "acme$$08202019165520$$Published&&1$$S1",
    "index": 0,
    "field": {...},
    "fileName": "1.jpg",
    "type": "jpg"
  },
  {
    "key": "bcd124",
    "id": "acme$$08202019165520$$Published&&1$$P1",
    "field": {...},
    "fileName": 2.jpg",    
    "type": "jpg"
  }
]

Returns information about all attachment blobs in the form submission by the key or id of the submission.

• Requires user or webservice authentication.

{
  "key": "bcd123",
  "id": "acme$$08202019165520$$Published&&1$$S1",
  "index": 0,
  "field": {...},
  "fileName": "1.jpg",
  "type": "jpg"
}

Returns information about a single blob in a submission.

• Requires user or webservice authentication.
• index - If the image is in a table or repeatable, the row number of the table or repeatable that contains the image.
• field - The field. See /submissions/{key or id} for more information on fields.
• fileName - The file name. Is unique within the submission.
• type - The file extension.

application/octet-stream

Returns the binary data of a single blob in a submission.

• Requires user or webservice authentication.
• Save the binary to a file using the value of the "type" field as the extension.

[
  {
    "key": "def123",
    "name": "Device one",
    "number": "5551231234",
    "teamKey": "tuv123"
  },
  {
    "key": "def234",
    "name": "Device two",
    "number": "5551234321",
    "teamKey": "tuv123"
  }
]

Returns all the devices assigned to the requested team.

• Requires user authentication.
• Unassigned devices are included in the "main" team.
• Optional query parameters: latitude, longitude
  • If a device has a lastTrack node, return the distance to the provided latitude and longitude in lastTrack.distanceToTarget.

[
  {
    "key": "uvw123",
    "email": "me@me.com",
    "firstName": "My",
    "lastName": "Name",
    "workPhone": "(555) 123-1234"
  },
  {
    "key": "uvw124",
    "email": "you@you.com",
    "firstName": "Your",
    "lastName": "Name",
    "groupKey": "ghi123",
    "workPhone": "555 123 1235"
  }
]

Returns all web users for the account.

• Requires user authentication.
• See /groups/{key}/users for a more limited list of users.

{
  "key": "uvw123",
  "email": "me@me.com",
  "firstName": "My",
  "lastName": "Name",
  "workPhone": "(555) 123-1234"
}

Returns the requested web user by key or by email.

• Requires user authentication.

{
  "key": "wxy123",
  "id": "acme$$12345$$Published$$67890",
  "active": true,
  "formKey": "fgh123",
  "projectKey": "pqr123",
  "password": "mypassword"
}

Returns the requested web service including the password.

• Requires user authentication.
• Authenticated user must have System Manage rights.