 | Cloud Fax and Notifications API 2.6 Documentation SubmitToParser | Cloud Fax and Notifications API Forums Home |
55.2 SubmitToParserRequest | SubmitToParser Overview SubmitToParserResult |
| Tag Name & type | # | Description | ||||
|---|---|---|---|---|---|---|
| SubmitToParserRequest | Namespace of this element is http://ws.easylink.com/SubmitToParser/2011/01 | |||||
| SubmitId xs:string | 0-1 | Optional string identifying request, which will be echoed in result. | ||||
| MessageId xs:string | 0-1 | This is an optional user-supplied string that may be included to identify the particular request. The Cloud Fax and Notifications API will treat this value as opaque data and will return it in the results along with the result information for that particular message tag. The user may use this to relate particular results to parts of the request. If present, the MessageId (80 characters max) will be used by the Cloud Fax and Notifications API as a localid, which provides a way to avoid multiple submissions to the switch even if the the Cloud Fax and Notifications API request is repeated - the switch will not accept duplicate localids. | ||||
| Domain xs:string | 1 | This must be the name of the domain to which the document is to be submitted. Note that users may have different parsers in different domains. The generic system type "XDDS" or "MR" can be used to allow the Cloud Fax and Notifications API to choose the most appropriate available switch. | ||||
| Filename xs:string | 0-1 | Some parsers require a filename, and determine the type of data to be processed from the name or the extension. | ||||
| DocumentData DocDataType | 1 | This contains the actual document to be submitted. See DocumentType. | ||||
| ParserExtensions ParserExtensionsType | 0-1 | This element may be used to provide access to parser options not otherwise accessible through the Cloud Fax and Notifications API schema. Applicable options depend on the user's parser configuration. | ||||
| OptionSegment OptionSegmentType | 1- | ParserExtensions may be divided into categores, and the OptionSegment will indicate the category. | ||||
| @name xs:string | 0-1 | The name of the segment. No name will indicate the default ("USER") segment. | ||||
| OptionProperty | 1- | This element contains the specific extension value | ||||
| @name xs:string | 1 | The name of the extension. None are currently defined. | ||||
| © 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 |