Creating a report in the VisitReport app via deeplinks

Introduction

Deeplink for creating the report from the external source is constructed from the two parts:

The base part: snapaddy-vr://app/report , and
Query parameters which contain values for certain fields listed in the table below. Each query parameter is assigned a value with the following syntax: name=value . Multiple query parameters are concatenated with & character. Eventually, concatenated query parameters are further concatenated with the base part with the ? character.

This is the example of the deeplink: snapaddy-vr://app/report? templateId=123&firstName=John&lastName=Doe.

When the report is created, there will be an additional participant associated with the newly created report. Fields values for this participant can be provided as query parameters in the deeplink by using the specification in the table below.

Field	Property name	Field type	Mandatory field	Description
Template ID	`templateId`	`string`	Yes	ID of the template in which the report will be created.
Salutation	`gender`	`0` for male, `1` for female	No	Gender of the participant.
First name	`firstName`	`string`	No	First name of the participant.
Last name	`lastName`	`string`	No	Last name of the participant.
Company	`organization`	`string`	No	Name of the participant’s company.
Job	`position`	`string`	No	Participant’s job title.
Phone	`phone`	`string`	No	Participant’s phone number.
Mobile	`mobile`	`string`	No	Participant’s mobile phone number.
Fax	`fax`	`string`	No	Participant’s fax number.
Email	`email`	`string`	No	Participant’s email address.
Website	`website`	`string`	No	Participant’s website address.
Street	`street`	`string`	No	Participant’s primary address.
Street 2	`street2`	`string`	No	Participant’s secondary address.
Zip	`zip`	`string`	No	Zip code of participant’s address of residence.
State	`state`	`string`	No	Participant’s state of residence.
Country	`country`	`string`	No	Participant’s country of residence.

Custom fields

Participant can be created with additional custom fields by providing query parameters that start with c_ prefix.
For example, snapaddy-vr://app/report?templateId=123&firstName=John&lastName=Doe&c_age=30&c_type=lead will create the participant with custom field age with the value of 30, and custom field type with the value of lead.

Additional notes

Please be aware that all query parameters should be properly URI encoded (by calling encodeURIComponent in JavaScript, or with some other method).