Connectors Reference
Survey123 for ArcGIS is a simple and intuitive form-centric data gathering solution that makes creating, sharing, and analyzing surveys possible in just three easy steps: 1) Ask Questions; 2) Get the Answers; 3) Make the best Decisions.
|
Status: Production |
Tier: Standard |
Version: 1.1 |
|
Name |
Summary |
|
Get surveys |
|
|
get Webhook Payload Schema |
|
|
remove webhook |
|
Name |
Summary |
|
AddData (string surveyId, AddDataParameterAddWebhookBody addWebhookBody) |
When a survey response is submitted |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get surveys
Description: This action retrieves a list of surveys owned by the logged in-user
Syntax:
Survey123.GetOwnedSurveyList ([internal]boolean isPublished)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
isPublished |
boolean
|
|
True |
Returns:
Type:GetOwnedSurveyListResponse
Summary: get Webhook Payload Schema
Description: get Webhook Payload Schema
Syntax:
Survey123.GetWebhookPayloadSchema (string surveyItemId, [internal]boolean onlyGetFeature, [Optional]GetWebhookPayloadSchemaParameterWebhookSchemaBody webhookSchemaBody)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
surveyItemId |
string
|
survey item id |
True |
|
|
onlyGetFeature |
boolean
|
|
True |
|
|
webhookSchemaBody |
GetWebhookPayloadSchemaParameterWebhookSchemaBody
|
|
False |
Returns:
Type:GetWebhookPayloadSchemaResponse
Summary: remove webhook
Description: remove webhook
Syntax:
Survey123.RemoveWebhook (string surveyItemId, string webhookId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
surveyItemId |
string (survey item id) |
survey item id |
True |
|
|
webhookId |
string (webhook id) |
webhook id |
True |
Returns:
Summary: When a survey response is submitted
Description: Triggers a new flow when a survey response is submitted by a user
Syntax:
Survey123.AddData (string surveyId, AddDataParameterAddWebhookBody addWebhookBody)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
surveyId |
string (Choose a survey) |
Choose a survey |
True |
|
|
addWebhookBody |
AddDataParameterAddWebhookBody
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webhook |
|
webhook |
Summary:
Description: webhook
Properties:
|
Name |
Type |
Summary |
|
name |
string name |
The webhook name |
|
events |
array of (string) events |
events |
|
url |
string url |
url |
|
includePortalInfo |
boolean includePortalInfo |
Include the portal info in the payload, such as the portal URL. |
|
includeUserInfo |
boolean includeUserInfo |
Include the user info in the payload, such as the user name, email address, first name and last name. |
|
includeSurveyInfo |
boolean includeSurveyInfo |
Include the survey info in the payload, such as the survey title and survey item id. |
|
includeServiceRequest |
boolean includeServiceRequest |
Include the submitted record info in the payload, such as attributes and geometry of the feature. |
|
includeServiceResponse |
boolean includeServiceResponse |
Include the raw server response in the payload. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webhook |
webhook |
webhook |
Summary: webhook
Description: webhook
Properties:
|
Name |
Type |
Summary |
|
events |
array of (string) events |
events |
|
includePortalInfo |
boolean includePortalInfo |
includePortalInfo |
|
includeUserInfo |
boolean includeUserInfo |
includeUserInfo |
|
includeSurveyInfo |
boolean includeSurveyInfo |
includeSurveyInfo |
|
includeServiceResponse |
boolean includeServiceResponse |
includeServiceResponse |
|
includeServiceRequest |
boolean includeServiceRequest |
includeServiceRequest |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean success |
success |
|
id |
string id |
id |
|
surveyName |
string surveyName |
surveyName |
|
webhookId |
string webhookId |
webhookId |