Cloud Fax and Notifications API 2.6 Documentation
FormData
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  FormData  

20.2 FormDataRequest

FormData Overview   FormDataResult

Tag Name
& type
#Description
FormDataRequest   Namespace of this element is http://ws.easylink.com/FormData/2011/01
   SubmitId
xs:string
0-1Optional string identifying request, which will be echoed in result.
   Domain
xs:string
1The EasyLink switch where the form data resides. Possible values are XDDS or MR, or the actual name of a domain. Using an actual domain name is discouraged, since using the generic values allows EasyLink to consider all currently accessible switches.
   NumToRetrieve
xs:unsignedInt
0-1Maximum number of responses to be retrieved.
   DateRange
DateRangeType
0-1The time window for which the responses are to be retrieved.
   StartDate
xs:dateTime
1Retrieve responses newer than this date.
   EndDate
xs:dateTime
1Retrieve responses older than this date.
   StartSequence
xs:unsignedInt
0-1This element specifies the minimum sequence number of the responses to be retrieved.
If this element is present, the DateRange filter (if present) is ignored.
   EndSequence
xs:unsignedInt
0-1This element specifies the maximum sequence number of the responses to be retrieved.
If this element is present, the DateRange filter (if present) is ignored.
   ResponseFilter1This element specifies the type of data to be retrieved based on the status of the records.
The retrieval can simultaneously adjust the status. For example, "new" responses can be marked as "deleted", so that they will not be included in the next request for "new" responses.
The above filters (StartSequence, EndSequence, DateRange, NumToRetrieve) will be applied to the responses with the requested status to determine those ultimately returned in the result.
   New1If this choice is used, only "new" responses will be retrieved.
   @markAsDeleted
xs:boolean
1If this attribute is true, the status in the form database for the retrieved responses will be changed to "old" (or "deleted").
Old1If this choice is used, only "old" responses will be retrieved.
   @markAsNew
xs:boolean
1If this attribute is true, the status in the form database for the retrieved responses will be changed to "new".
All1If this choice is used, all responses will be retrieved.
   @action
FilterActionType
1Legal values and their effect are listed here:
markNewThe status for retrieved responses is set to "new".
markDeletedThe status for retrieved responses is set to "old" ("deleted").
leaveAsItIsNo changes are made to status values.
   CampaignName
xs:string
1Name of the Campaign which contains the form whose responses are to be retrieved.
   FormName
xs:string
1Name of form whose responses are to be retrieved.
 
    prev  next        Table of Contents  FormData  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified October 06, 2020