Cloud Fax and Notifications API 2.5 - DocumentTransmit

Cloud Fax and Notifications API 2.5 Documentation
DocumentTransmit

Cloud Fax and Notifications API Forums Home

prev next Table of Contents DocumentTransmit

These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.

17.3 DocumentTransmitResult

DocumentTransmit Overview DocumentTransmitRequest

Tag Name & type					#	Description
DocumentTransmitResult						Namespace of this element is http://ws.easylink.com/DocumentTransmit/2011/01
	Status StatusType				1	Status of processing. See StatusType.
	SubmitId xs:string				0-1	Echoes the SubmitId in the request, if one was provided, and if possible.
	DocumentData				0-	Information about document. Normally, a DocumentData is present for each DocumentNumber in the request.
		RecStatus RecStatusType			1	The processing status for this particular DocumentData. See RecStatusType.
		DocumentNumber DocumentId			1	This will echo the DocumentNumber present in request.
		JobId JobIdType			0-1	This will contain JobId the document is associated with. See JobIdType.
		UserId xs:string			0-1	User id associated with the job. %USER:USER_ID value from job header
		ServiceType xs:string			0-1	The EasyLink system will attempt to associate jobs with various types of service, reflecting the general nature of the job (fax, email, voice, fax-to-mail, etc.). Possible values (case insensitive) include but are not limited to: F2M M2F FR MR VR SR %USER:SERVICE_TYPE value, possibly overridden by %FAX2MAIL:SVC value when present.
		CustomerRef EncodableStringType			0-1	The customer reference value %USER:CREF value from job header.
		BillingCode EncodableStringType			0-1	The billing code %USER:BC value from job header
		TransactionInfo TransactionInfoType			0-1	Contains the transaction information of the document. See TransactionInfoType.
		DocumentDataExtension SegmentType			0-	Additional information, corresponding to information requested using DocumentTransmitRequestExtension. If no value is found for a requested property, no Property for that name will be included in the result.
			@name xs:string		0-1	The name of the segment. No name is equivalent to the default (USER) segment. In general, the value is case-insensitive.
			Property		1-	This element will contain the specific value
				@name xs:string	1	The name of the property (keyword). In general, the value is case-insensitive.
				@b64charset xs:string	0-1	The value may be base64 encoded to convey data in a particular character set. If this is done, the character set is named in this attribute. See EncodableStringType.
		DocumentInfo JobDocumentInfoType			0-1	Contains the document content and information. See JobDocumentInfoType.

prev next Table of Contents DocumentTransmit

This information is subject to change. Please check frequently for updates.
Modified October 06, 2020