GrowthZone REST API API Reference
undefined
API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
GET /api/forms/{formid}
(no description)
OK
Response Example (200 OK)
{
"FormId": "integer",
"AuditId": "integer",
"Name": "string",
"Description": "string",
"PublishedStartDate": "string",
"PublishedEndDate": "string",
"FormTypeId": "integer",
"AcceptViaHttpCollector": "boolean",
"PostbackUrl": "string",
"FormUrl": "string",
"TemplatedFormUrl": "string",
"NotificationReceipients": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"PostSubmitMessage": "string",
"PostSubmitDownloadFile": "string",
"EmailConfirmationToSubmitter": "boolean"
}
POST /api/forms/{formid}
undefined
(no description)
Request Example
{
"FormId": "integer",
"AuditId": "integer",
"Name": "string",
"Description": "string",
"PublishedStartDate": "string",
"PublishedEndDate": "string",
"FormTypeId": "integer",
"AcceptViaHttpCollector": "boolean",
"PostbackUrl": "string",
"FormUrl": "string",
"TemplatedFormUrl": "string",
"NotificationReceipients": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"PostSubmitMessage": "string",
"PostSubmitDownloadFile": "string",
"EmailConfirmationToSubmitter": "boolean"
}
OK
Response Example (200 OK)
{
"FormId": "integer",
"FormIdHashed": "string",
"FormTypeId": "integer",
"AuditId": "integer",
"TimeZoneId": "integer",
"AcceptViaHttpCollector": "boolean",
"Name": "string",
"FormType": "string",
"ResponseCount": "integer",
"LatestResponse": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
DELETE /api/forms/{formid}/{auditid}
(no description)
(no description)
OK
GET /api/forms/{formid}/base
(no description)
OK
Response Example (200 OK)
{
"FormId": "integer",
"AuditId": "integer",
"Name": "string",
"Actions": "string"
}
POST /api/forms/copy/{formid}
(no description)
OK
Response Example (200 OK)
{
"FormId": "integer",
"FormIdHashed": "string",
"FormTypeId": "integer",
"AuditId": "integer",
"TimeZoneId": "integer",
"AcceptViaHttpCollector": "boolean",
"Name": "string",
"FormType": "string",
"ResponseCount": "integer",
"LatestResponse": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
Generates Pdf document containing for response for selected form response item
Generates Pdf document containing for response for selected form response item
(no description)
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
Generates Xlsx document containing for responses for selected form
Generates Xlsx document containing for responses for selected form
(no description)
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/forms/field/{formcustomfieldid}
(no description)
OK
Response Example (200 OK)
{
"FormCustomFieldId": "integer",
"CustomFieldId": "integer",
"FormId": "integer",
"ObjectTypeId": "integer",
"DisplayOrder": "string",
"OriginalCustomFieldDataTypeId": "string",
"forceSave": "boolean",
"ExistingFormCustomFieldId": "string",
"Name": "string",
"DisplayName": "string",
"OriginalObjectTypeId": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"DataSize": "string",
"ScaleModel": "string",
"SelectListData": "string",
"SelectListItems": "string",
"FormSectionId": "string",
"PageNumber": "string",
"ChildCustomFields": "string",
"IsPublic": "string",
"IsRequired": "string",
"IsRemoved": "boolean",
"MappingName": "string",
"StandardFieldId": "string",
"ExternalDataSource": "string"
}
POST /api/forms/field/{formid}/{formcustomfieldid}
undefined
(no description)
(no description)
Request Example
{
"FormCustomFieldId": "integer",
"CustomFieldId": "integer",
"FormId": "integer",
"ObjectTypeId": "integer",
"DisplayOrder": "string",
"OriginalCustomFieldDataTypeId": "string",
"forceSave": "boolean",
"ExistingFormCustomFieldId": "string",
"Name": "string",
"DisplayName": "string",
"OriginalObjectTypeId": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"DataSize": "string",
"ScaleModel": "string",
"SelectListData": "string",
"SelectListItems": "string",
"FormSectionId": "string",
"PageNumber": "string",
"ChildCustomFields": "string",
"IsPublic": "string",
"IsRequired": "string",
"IsRemoved": "boolean",
"MappingName": "string",
"StandardFieldId": "string",
"ExternalDataSource": "string"
}
OK
Response Example (200 OK)
{
"FormCustomFieldId": "integer",
"CustomFieldId": "string",
"CustomFieldName": "string",
"CustomFieldDisplayName": "string",
"CustomFieldObjectType": "string",
"FormId": "integer",
"ObjectTypeId": "integer",
"IsDeletable": "boolean",
"DisplayName": "string",
"Name": "string",
"FormSectionName": "string",
"PageNumber": "string",
"DisplayOrder": "string",
"FormSectionDisplayOrder": "string",
"CustomFieldDataTypeId": "string",
"DataSize": "string",
"IsRequired": "string",
"IsRemoved": "boolean",
"MappingName": "string",
"FieldName": "string",
"FieldMappingName": "string",
"SelectListData": "string",
"StandardFieldId": "string",
"Description": "string",
"CssClass": "string",
"Actions": "string"
}
POST /api/forms/field/disable/{formcustomfieldid}
(no description)
OK
POST /api/forms/field/enable/{formcustomfieldid}
(no description)
OK
GET /api/forms/fieldmapping/{formcustomfieldid}
(no description)
OK
Response Example (200 OK)
{
"FormCustomFieldId": "integer",
"FormId": "integer",
"MappingName": "string"
}
POST /api/forms/fieldmapping/{formcustomfieldid}
undefined
(no description)
Request Example
{
"FormCustomFieldId": "integer",
"FormId": "integer",
"MappingName": "string"
}
OK
Response Example (200 OK)
{
"FormCustomFieldId": "integer",
"CustomFieldId": "string",
"CustomFieldName": "string",
"CustomFieldDisplayName": "string",
"CustomFieldObjectType": "string",
"FormId": "integer",
"ObjectTypeId": "integer",
"IsDeletable": "boolean",
"DisplayName": "string",
"Name": "string",
"FormSectionName": "string",
"PageNumber": "string",
"DisplayOrder": "string",
"FormSectionDisplayOrder": "string",
"CustomFieldDataTypeId": "string",
"DataSize": "string",
"IsRequired": "string",
"IsRemoved": "boolean",
"MappingName": "string",
"FieldName": "string",
"FieldMappingName": "string",
"SelectListData": "string",
"StandardFieldId": "string",
"Description": "string",
"CssClass": "string",
"Actions": "string"
}
GET /api/forms/fields/{formid}
(no description)
OK
Response Example (200 OK)
{
"FormId": "integer",
"Name": "string",
"ObjectTypeId": "string",
"FormCustomFields": "string"
}
POST /api/forms/fields/{formid}
undefined
(no description)
Request Example
{
"FormId": "integer",
"ObjectTypeId": "string",
"FormCustomFields": "string"
}
OK
Response Example (200 OK)
{
"FormId": "integer",
"ObjectTypeId": "string",
"FormCustomFields": "string"
}
GET /api/forms/fields/typeahead/{formid}/{search}
(no description)
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/forms/form/{formid}/pages/{pagenumber}
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/forms/form/{formid}/section/add
undefined
(no description)
Request Example
{
"Id": "integer",
"FormId": "string",
"TenantId": "integer",
"FormSectionId": "integer",
"Name": "string",
"FormSectionName": "string",
"Description": "string",
"DisplayOrder": "string"
}
OK
Response Example (200 OK)
{
"Id": "integer",
"FormId": "string",
"TenantId": "integer",
"FormSectionId": "integer",
"Name": "string",
"FormSectionName": "string",
"Description": "string",
"DisplayOrder": "string"
}
GET /api/forms/form/{formid}/sections
(no description)
OK
Response Example (200 OK)
{
"TenantId": "integer",
"FormId": "string",
"Sections": "string"
}
GET /api/forms/formresponses/{formid}
undefined
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"FormId": "integer",
"Criteria": "string",
"IsMatched": "boolean",
"ReceivedOn": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/forms/formresponses/matchcontact/{formresponseid}
(no description)
OK
Response Example (200 OK)
{
"CurrentContactId": "integer",
"CurrentOrganizationContactId": "integer",
"FirstName": "string",
"LastName": "string",
"Email": "string",
"OrganizationName": "string",
"NotEnoughIndividualData": "boolean",
"IndividualNotMatchedYet": "boolean",
"NotEnoughOrganizationData": "boolean",
"OrganizationNotMatchedYet": "boolean",
"ShowPotentialMatchSection": "boolean",
"ContactId": "string",
"OrganizationContactId": "string",
"HideOrgUseSuggested": "boolean",
"ContactMatchType": "string",
"PotentialMatches": "string",
"Contact": "string",
"OrganizationMatchType": "string",
"PotentialOrganizations": "string",
"Organization": "string",
"FormResponseId": "integer",
"AuditId": "integer",
"InfoForm": "string"
}
POST /api/forms/formresponses/matchcontact/{formresponseid}
undefined
(no description)
Request Example
{
"CurrentContactId": "integer",
"CurrentOrganizationContactId": "integer",
"FirstName": "string",
"LastName": "string",
"Email": "string",
"OrganizationName": "string",
"NotEnoughIndividualData": "boolean",
"IndividualNotMatchedYet": "boolean",
"NotEnoughOrganizationData": "boolean",
"OrganizationNotMatchedYet": "boolean",
"ShowPotentialMatchSection": "boolean",
"ContactId": "string",
"OrganizationContactId": "string",
"HideOrgUseSuggested": "boolean",
"ContactMatchType": "string",
"PotentialMatches": "string",
"Contact": "string",
"OrganizationMatchType": "string",
"PotentialOrganizations": "string",
"Organization": "string",
"FormResponseId": "integer",
"AuditId": "integer",
"InfoForm": "string"
}
OK
Response Example (200 OK)
{
"FormId": "integer",
"FormResponseId": "integer",
"ContactId": "string",
"OrganizationContactId": "string",
"FormTypeId": "string",
"TotalRecordAvailable": "integer",
"Matched": "boolean",
"InfoFrom": "string",
"OrganizationDisplayName": "string",
"CreatedDate": "string",
"SubmitedOn": "string",
"Actions": "string"
}
DELETE /api/forms/formresponses/matchcontact/{formresponseid}/{auditid}/softwaretrialsetup
(no description)
(no description)
OK
Response Example (200 OK)
{
"FormId": "integer",
"FormResponseId": "integer",
"ContactId": "string",
"OrganizationContactId": "string",
"FormTypeId": "string",
"TotalRecordAvailable": "integer",
"Matched": "boolean",
"InfoFrom": "string",
"OrganizationDisplayName": "string",
"CreatedDate": "string",
"SubmitedOn": "string",
"Actions": "string"
}
POST /api/forms/formresponses/matchcontact/{formresponseid}/nextpage
undefined
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string"
}
OK
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"TenantId": "integer",
"ContactId": "integer",
"PersonName": "string",
"PrimaryCompanyId": "integer",
"PrimaryCompany": "string",
"LastCommunicationDate": "string",
"EmailAddress": "string",
"MembershipStatusTypeId": "string",
"EstimatedNumberOfCommunications": "integer",
"SystemContactTypeId": "string",
"IsContact": "boolean"
}
]
GET /api/forms/formresponses/matchcontact/{formresponseid}/softwaretrialsetup
(no description)
OK
Response Example (200 OK)
{
"CurrentContactId": "integer",
"CurrentOrganizationContactId": "integer",
"FirstName": "string",
"LastName": "string",
"Email": "string",
"OrganizationName": "string",
"NotEnoughIndividualData": "boolean",
"IndividualNotMatchedYet": "boolean",
"NotEnoughOrganizationData": "boolean",
"OrganizationNotMatchedYet": "boolean",
"ShowPotentialMatchSection": "boolean",
"ContactId": "string",
"OrganizationContactId": "string",
"HideOrgUseSuggested": "boolean",
"ContactMatchType": "string",
"PotentialMatches": "string",
"Contact": "string",
"OrganizationMatchType": "string",
"PotentialOrganizations": "string",
"Organization": "string",
"FormResponseId": "integer",
"AuditId": "integer",
"InfoForm": "string",
"MembershipTypeId": "string",
"EndDate": "string"
}
POST /api/forms/formresponses/matchcontact/{formresponseid}/softwaretrialsetup
undefined
(no description)
Request Example
{
"CurrentContactId": "integer",
"CurrentOrganizationContactId": "integer",
"FirstName": "string",
"LastName": "string",
"Email": "string",
"OrganizationName": "string",
"NotEnoughIndividualData": "boolean",
"IndividualNotMatchedYet": "boolean",
"NotEnoughOrganizationData": "boolean",
"OrganizationNotMatchedYet": "boolean",
"ShowPotentialMatchSection": "boolean",
"ContactId": "string",
"OrganizationContactId": "string",
"HideOrgUseSuggested": "boolean",
"ContactMatchType": "string",
"PotentialMatches": "string",
"Contact": "string",
"OrganizationMatchType": "string",
"PotentialOrganizations": "string",
"Organization": "string",
"FormResponseId": "integer",
"AuditId": "integer",
"InfoForm": "string",
"MembershipTypeId": "string",
"EndDate": "string"
}
OK
Response Example (200 OK)
{
"FormId": "integer",
"FormResponseId": "integer",
"ContactId": "string",
"OrganizationContactId": "string",
"FormTypeId": "string",
"TotalRecordAvailable": "integer",
"Matched": "boolean",
"InfoFrom": "string",
"OrganizationDisplayName": "string",
"CreatedDate": "string",
"SubmitedOn": "string",
"Actions": "string"
}
GET /api/forms/formresponses/matchcontact/matchorganization/{formresponseid}
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/forms/items
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"IsActive": "boolean",
"InActive": "boolean",
"EndedInLast30Days": "boolean",
"HasResponses": "boolean",
"HasRecentResponses": "boolean",
"LastResponseDate": "string",
"PublishEndDate": "string",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/forms/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/forms/lookup/formtypes
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/forms/lookup/thirdpartyresponseenabledforms
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/forms/lookup/trialregistration
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/forms/response/{formresponseid}
(no description)
OK
Response Example (200 OK)
{
"FormResponseId": "integer",
"FormId": "string",
"PublicFields": "string",
"Fields": "string"
}
POST /api/forms/response/{formresponseid}
undefined
(no description)
Request Example
{
"FormResponseId": "integer",
"FormId": "string",
"PublicFields": "string",
"Fields": "string"
}
OK
Response Example (200 OK)
{
"FormId": "integer",
"FormResponseId": "integer",
"ContactId": "string",
"OrganizationContactId": "string",
"FormTypeId": "string",
"TotalRecordAvailable": "integer",
"Matched": "boolean",
"InfoFrom": "string",
"OrganizationDisplayName": "string",
"CreatedDate": "string",
"SubmitedOn": "string",
"Actions": "string"
}
DELETE /api/forms/response/{formresponseid}
(no description)
OK
POST /api/forms/sections
undefined
Request Example
{
"TenantId": "integer",
"FormId": "string",
"Sections": "string"
}
OK
Response Example (200 OK)
{
"TenantId": "integer",
"FormId": "string",
"Sections": "string"
}
Schema Definitions
ListViewReturnModel<FormCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
FormsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- IsActive: boolean
- InActive: boolean
- EndedInLast30Days: boolean
- HasResponses: boolean
- HasRecentResponses: boolean
- LastResponseDate: string
- PublishEndDate: string
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"IsActive": "boolean",
"InActive": "boolean",
"EndedInLast30Days": "boolean",
"HasResponses": "boolean",
"HasRecentResponses": "boolean",
"LastResponseDate": "string",
"PublishEndDate": "string",
"Criteria": "string"
}
FormAddEditModel: object
- FormId: integer
- AuditId: integer
- Name: string
- Description: string
- PublishedStartDate: string
- PublishedEndDate: string
- FormTypeId: integer
- AcceptViaHttpCollector: boolean
- PostbackUrl: string
- FormUrl: string
- TemplatedFormUrl: string
- NotificationReceipients: string
- ObjectTypeId: string
- SearchObjectTypeId: string
- PostSubmitMessage: string
- PostSubmitDownloadFile: string
- EmailConfirmationToSubmitter: boolean
Example
{
"FormId": "integer",
"AuditId": "integer",
"Name": "string",
"Description": "string",
"PublishedStartDate": "string",
"PublishedEndDate": "string",
"FormTypeId": "integer",
"AcceptViaHttpCollector": "boolean",
"PostbackUrl": "string",
"FormUrl": "string",
"TemplatedFormUrl": "string",
"NotificationReceipients": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"PostSubmitMessage": "string",
"PostSubmitDownloadFile": "string",
"EmailConfirmationToSubmitter": "boolean"
}
FormsBaseModel: object
- FormId: integer
- AuditId: integer
- Name: string
- Actions: string
Example
{
"FormId": "integer",
"AuditId": "integer",
"Name": "string",
"Actions": "string"
}
FormCollectionItemModel: object
- FormId: integer
- FormIdHashed: string
- FormTypeId: integer
- AuditId: integer
- TimeZoneId: integer
- AcceptViaHttpCollector: boolean
- Name: string
- FormType: string
- ResponseCount: integer
- LatestResponse: string
- TotalRecordAvailable: integer
- Actions: string
Example
{
"FormId": "integer",
"FormIdHashed": "string",
"FormTypeId": "integer",
"AuditId": "integer",
"TimeZoneId": "integer",
"AcceptViaHttpCollector": "boolean",
"Name": "string",
"FormType": "string",
"ResponseCount": "integer",
"LatestResponse": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
GenericLookUpChoice<Int32>: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
FormCustomFieldSetup: object
- FormId: integer
- Name: string
- ObjectTypeId: string
- FormCustomFields: string
Example
{
"FormId": "integer",
"Name": "string",
"ObjectTypeId": "string",
"FormCustomFields": "string"
}
FormCustomFieldsData: object
- FormId: integer
- ObjectTypeId: string
- FormCustomFields: string
Example
{
"FormId": "integer",
"ObjectTypeId": "string",
"FormCustomFields": "string"
}
FormCustomFieldModel: object
- FormCustomFieldId: integer
-
Form field primary key
- CustomFieldId: integer
-
Form field backing custom field. can probably kill this.
- FormId: integer
-
Form this field is on
- ObjectTypeId: integer
-
Used to filter the ExistingFormCustomFieldId dropdown lookup list api call
- DisplayOrder: string
-
Dead code
- OriginalCustomFieldDataTypeId: string
-
Previously selected custom field's type
- forceSave: boolean
-
ignore any issues with the data and save it
- ExistingFormCustomFieldId: string
-
Newly selected custom field id. poorly named Reason, why we have additional field for this is that we can't make CustomFieldId as lookup - this will cause error in api builder
- Name: string
-
User defined name for the form field if it is not a custom field
- DisplayName: string
-
Dead code
- OriginalObjectTypeId: string
-
Dead code
- Description: string
-
Form field description
- CustomFieldDataTypeId: string
-
Form field data type if not custom field. poorly named
- DataSize: string
-
String length restriction if form field is a string
- ScaleModel: string
-
if form field type is scale and not a custom field then we allow setting range settings
- SelectListData: string
-
Json to fill SelectListData. can probably kill this.
- SelectListItems: string
-
if not a custom field and selected type is an allowed value then let user define options for the for field
- FormSectionId: string
-
Let user put the form field into a specified area
- PageNumber: string
-
Let user put the form field into a specified page
- ChildCustomFields: string
-
if not a custom field and selected type is table then let them define the columns of the table
- IsPublic: string
-
Show field to users or only staff
- IsRequired: string
-
Field can be ignored or not on form
- IsRemoved: boolean
-
Don't want to deleted existing data but also don't want to collect the data anymore
- MappingName: string
-
Name of property from api call
- StandardFieldId: string
-
GZ defined field selection. can probably kill this.
- ExternalDataSource: string
-
Api data to fill in form field options if selected type is right
Example
{
"FormCustomFieldId": "integer",
"CustomFieldId": "integer",
"FormId": "integer",
"ObjectTypeId": "integer",
"DisplayOrder": "string",
"OriginalCustomFieldDataTypeId": "string",
"forceSave": "boolean",
"ExistingFormCustomFieldId": "string",
"Name": "string",
"DisplayName": "string",
"OriginalObjectTypeId": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"DataSize": "string",
"ScaleModel": "string",
"SelectListData": "string",
"SelectListItems": "string",
"FormSectionId": "string",
"PageNumber": "string",
"ChildCustomFields": "string",
"IsPublic": "string",
"IsRequired": "string",
"IsRemoved": "boolean",
"MappingName": "string",
"StandardFieldId": "string",
"ExternalDataSource": "string"
}
FormCustomFieldListItem: object
- FormCustomFieldId: integer
- CustomFieldId: string
- CustomFieldName: string
- CustomFieldDisplayName: string
- CustomFieldObjectType: string
- FormId: integer
- ObjectTypeId: integer
- IsDeletable: boolean
- DisplayName: string
- Name: string
- FormSectionName: string
- PageNumber: string
- DisplayOrder: string
- FormSectionDisplayOrder: string
- CustomFieldDataTypeId: string
- DataSize: string
- IsRequired: string
- IsRemoved: boolean
- MappingName: string
- FieldName: string
- FieldMappingName: string
- SelectListData: string
- StandardFieldId: string
- Description: string
- CssClass: string
- Actions: string
Example
{
"FormCustomFieldId": "integer",
"CustomFieldId": "string",
"CustomFieldName": "string",
"CustomFieldDisplayName": "string",
"CustomFieldObjectType": "string",
"FormId": "integer",
"ObjectTypeId": "integer",
"IsDeletable": "boolean",
"DisplayName": "string",
"Name": "string",
"FormSectionName": "string",
"PageNumber": "string",
"DisplayOrder": "string",
"FormSectionDisplayOrder": "string",
"CustomFieldDataTypeId": "string",
"DataSize": "string",
"IsRequired": "string",
"IsRemoved": "boolean",
"MappingName": "string",
"FieldName": "string",
"FieldMappingName": "string",
"SelectListData": "string",
"StandardFieldId": "string",
"Description": "string",
"CssClass": "string",
"Actions": "string"
}
FormSectionSetup: object
- TenantId: integer
- FormId: string
- Sections: string
Example
{
"TenantId": "integer",
"FormId": "string",
"Sections": "string"
}
FormSectionAddEditItem: object
- Id: integer
- FormId: string
- TenantId: integer
- FormSectionId: integer
- Name: string
- FormSectionName: string
- Description: string
- DisplayOrder: string
Example
{
"Id": "integer",
"FormId": "string",
"TenantId": "integer",
"FormSectionId": "integer",
"Name": "string",
"FormSectionName": "string",
"Description": "string",
"DisplayOrder": "string"
}
FormCustomFieldMappingAddEditModel: object
- FormCustomFieldId: integer
- FormId: integer
- MappingName: string
Example
{
"FormCustomFieldId": "integer",
"FormId": "integer",
"MappingName": "string"
}
ListViewReturnModel<FormResponseListItem>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
FormResponsesAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- FormId: integer
- Criteria: string
- IsMatched: boolean
- ReceivedOn: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"FormId": "integer",
"Criteria": "string",
"IsMatched": "boolean",
"ReceivedOn": "string"
}
FormFindOrMatchContact: object
- CurrentContactId: integer
- CurrentOrganizationContactId: integer
- FirstName: string
- LastName: string
- Email: string
- OrganizationName: string
- NotEnoughIndividualData: boolean
- IndividualNotMatchedYet: boolean
- NotEnoughOrganizationData: boolean
- OrganizationNotMatchedYet: boolean
- ShowPotentialMatchSection: boolean
- ContactId: string
- OrganizationContactId: string
- HideOrgUseSuggested: boolean
- ContactMatchType: string
- PotentialMatches: string
- Contact: string
- OrganizationMatchType: string
- PotentialOrganizations: string
- Organization: string
- FormResponseId: integer
- AuditId: integer
- InfoForm: string
Example
{
"CurrentContactId": "integer",
"CurrentOrganizationContactId": "integer",
"FirstName": "string",
"LastName": "string",
"Email": "string",
"OrganizationName": "string",
"NotEnoughIndividualData": "boolean",
"IndividualNotMatchedYet": "boolean",
"NotEnoughOrganizationData": "boolean",
"OrganizationNotMatchedYet": "boolean",
"ShowPotentialMatchSection": "boolean",
"ContactId": "string",
"OrganizationContactId": "string",
"HideOrgUseSuggested": "boolean",
"ContactMatchType": "string",
"PotentialMatches": "string",
"Contact": "string",
"OrganizationMatchType": "string",
"PotentialOrganizations": "string",
"Organization": "string",
"FormResponseId": "integer",
"AuditId": "integer",
"InfoForm": "string"
}
PotentialContactMatch: object
- IsSelected: boolean
- TenantId: integer
- ContactId: integer
- PersonName: string
- PrimaryCompanyId: integer
- PrimaryCompany: string
- LastCommunicationDate: string
- EmailAddress: string
- MembershipStatusTypeId: string
- EstimatedNumberOfCommunications: integer
- SystemContactTypeId: string
- IsContact: boolean
Example
{
"IsSelected": "boolean",
"TenantId": "integer",
"ContactId": "integer",
"PersonName": "string",
"PrimaryCompanyId": "integer",
"PrimaryCompany": "string",
"LastCommunicationDate": "string",
"EmailAddress": "string",
"MembershipStatusTypeId": "string",
"EstimatedNumberOfCommunications": "integer",
"SystemContactTypeId": "string",
"IsContact": "boolean"
}
ODataInfo: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string"
}
FormResponseListItem: object
- FormId: integer
- FormResponseId: integer
- ContactId: string
- OrganizationContactId: string
- FormTypeId: string
- TotalRecordAvailable: integer
- Matched: boolean
- InfoFrom: string
- OrganizationDisplayName: string
- CreatedDate: string
- SubmitedOn: string
- Actions: string
Example
{
"FormId": "integer",
"FormResponseId": "integer",
"ContactId": "string",
"OrganizationContactId": "string",
"FormTypeId": "string",
"TotalRecordAvailable": "integer",
"Matched": "boolean",
"InfoFrom": "string",
"OrganizationDisplayName": "string",
"CreatedDate": "string",
"SubmitedOn": "string",
"Actions": "string"
}
FormSoftwareTrialSetup: object
- CurrentContactId: integer
- CurrentOrganizationContactId: integer
- FirstName: string
- LastName: string
- Email: string
- OrganizationName: string
- NotEnoughIndividualData: boolean
- IndividualNotMatchedYet: boolean
- NotEnoughOrganizationData: boolean
- OrganizationNotMatchedYet: boolean
- ShowPotentialMatchSection: boolean
- ContactId: string
- OrganizationContactId: string
- HideOrgUseSuggested: boolean
- ContactMatchType: string
- PotentialMatches: string
- Contact: string
- OrganizationMatchType: string
- PotentialOrganizations: string
- Organization: string
- FormResponseId: integer
- AuditId: integer
- InfoForm: string
- MembershipTypeId: string
- EndDate: string
Example
{
"CurrentContactId": "integer",
"CurrentOrganizationContactId": "integer",
"FirstName": "string",
"LastName": "string",
"Email": "string",
"OrganizationName": "string",
"NotEnoughIndividualData": "boolean",
"IndividualNotMatchedYet": "boolean",
"NotEnoughOrganizationData": "boolean",
"OrganizationNotMatchedYet": "boolean",
"ShowPotentialMatchSection": "boolean",
"ContactId": "string",
"OrganizationContactId": "string",
"HideOrgUseSuggested": "boolean",
"ContactMatchType": "string",
"PotentialMatches": "string",
"Contact": "string",
"OrganizationMatchType": "string",
"PotentialOrganizations": "string",
"Organization": "string",
"FormResponseId": "integer",
"AuditId": "integer",
"InfoForm": "string",
"MembershipTypeId": "string",
"EndDate": "string"
}
FormResponseValuesModel: object
- FormResponseId: integer
- FormId: string
- PublicFields: string
- Fields: string
Example
{
"FormResponseId": "integer",
"FormId": "string",
"PublicFields": "string",
"Fields": "string"
}
HttpResponseMessage: object
- Version: string
- Content: string
- StatusCode: string
- ReasonPhrase: string
- Headers: string
- RequestMessage: string
- IsSuccessStatusCode: boolean
Example
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}