Forms with Matrix

Response definition

Response is a object which is just a wrapper around list of objects which contain data for each submission.

The looks like:

{
    "Submissions": [
      	{"individual Submission"},
      	{"individual Submission"}
      ]
}

Each individual Submission object is described with following properties:

Name	Type	Description
Id	UUID	Id of the submission
CreatedUtc	DateTime	UTC date and time of the submission creation
TemplateId	UUID	Id of the template which was used to create submission.
TemplateName	String	Name of the template which was used to create submission.
TemplateVersion	Integer	Version of the template which was used to create submission.
LastUpdatedBy	UUID	Id of the user which edited form lastly
LastUpdatedUtc	DateTime	UTC date and time of last updating the submission
Answers	Array of Answer objects	Array which hold Answer objects. Each Answer represents answer in the submission. Next two rows describe Answer object in a details.
Answer\Id	UUID	Id of the answer
Answer\Name	String	Name of the question
Answer\QuestionId	UUID	Id of the question
Answer\Value	String	Answer to the question
Place\Id	UUID	Id of the place at which submission was created
Place\Name	String	Name of the place in the moment when submission was created
Place\Code	String	Code of the place in the moment when submission was created
Place\Address	String	Full address of the place in the moment when submission was created
Place\TagNames	List of Strings	List of all names of all tags which were assigned on the place when submission was created.
User\Id	UUID	Id of the user who created submission
User\Name	String	Name of the user in the moment when submission was created
User\Code	String	Code of the user in the moment when submission was created
User\AvatarUrl	String	Url to the user's avatar in the moment when submission was created
User\Email	String	Email of the user in the moment when submission was created
SignatureUri	String	Uri address of the signature if the submission was signed
TerritoryId	UUID	Id of the territory in which submission was created. Territory is linked to the Place on which submission was created. If place is not assigned to any territory this value will be null.
ProjectId	UUID	Id of the project which is linked to the submission. If no project is linked to the submission, value will be null.
Gps\Latitude	Double	Latitude coordinate of the place at which submission was created
Gps\Longitude	Double	Longitude coordinate of the place at which submission was created
IsUserCheckedIn	Boolean	Flag which is equal to true is user was checked-in at the place in the moment of submission creation. Otherwise, value of the flag is false. If the data about check-in was not available at the moment of submission creation, value will be null.
VisitId	UUID	ID of the visit in which submission was created.
CheckInType	string	Type of the check-in during visit user created submission.
ProjectName	string	Name of the project linked to the submission.

Form questions and answers

The 'Answers' field in the response is an ordered list of key/value pairs. In each pair, the 'Name' is the verbatim question from the Submission, and the 'Value' is the answer. Note that if the question is changed in a Form template, the questions in the already-filled Forms do not change.

All direct questions in a Form will always appear in the 'Items' list; if they were not answered, the 'Value' will be "" (an empty string).

Question types and example responses

Type	Example response
Text	"This is the answer "
Numeric	"550"
Yes/No	"true"
Selection	"Texas"
Multiple selection	"California \| New York"
Photo	"https://repsly.s3.amazonaws.com/ag624afe-161a-43d3-a847-1b452dde1a09.jpg"
Multiple photos	"https://repsly.s3.amazonaws.com/tjbc6836-8b00-405a-a0a4-aa8e991de4a4.jpg \| https://repsly.s3.amazonaws.com/4534207d-34fb-4987-8a74-2e56c73d19k9.jpg"
Date	"2024-01-23"
Section header	""
Barcode	"123456789104"
Product	"12345678900 Heinz Mustard"