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

48.2 ReportRequest

Report Overview   ReportResult

Tag Name
& type		#Description
ReportRequest   Namespace of this element is http://ws.easylink.com/Report/2011/01
   SubmitId
xs:string		0-1Optional string identifying request, which will be echoed in result.
   RemovalReport
RemovalReportType		1This choice is used when requesting a report of blocked addresses.
   Domain
xs:string		1EasyLink switch domain to be searched. The two distinct switch type (XDDS and MR) have different blocked address databases. The Domain value can be a specific EasyLink "domain" name, but using the generic system type "XDDS" or "MR" allows the Cloud Fax and Notifications API to choose the most appropriate available switch.
   ReportTemplate
xs:string		0-1The value must be the name of a previously established report template.
   DateRange
DateRangeType		0-1Specifies the date range to be searched for added entries.
   StartDate
xs:dateTime		1Start date/time of retrieval range.
   EndDate
xs:dateTime		1End date/time of retrieval range.
   ReportAddress
DeliveryItemListType		1Destination to which the report will be sent. This element is of type DeliveryItemListType, which means it contains one or more destinations.
   AddressTypeList
AddressType		0-If present, only those address types listed will be included in the report. See DestinationType.
JobReports1This choice is used when requesting job-related reports.
   Report
JobReportType		1-Multiple job-related reports can be requested in a single ReportRequest.
   @reportOption
ReportOptionEnum		0-1The only legal value is "sent-to-friend". By default, an ordinary delivery report is requested.
   ReportJobId
JobIdType		1The job for which the report is to be generated.
   ReportType
AllReportTypeEnum		1Specifies the type of report to be generated. Legal values are:
  • none
  • summary
  • detail
  • exception
  • conditional
  • pull
  • enhanced
  • badaddress
Note that the enhanced option is only processable for jobs handled by messageREACH®. "none" report type does not generate any report and returns an error in the result for the specific job.
   ReportTemplate
xs:string		0-1The value must be the name of a previously established report template. The name should not include the internally applied prefix "report_".
Note that templates for enhanced reports are stored differently and the template name should include an ownership character prefix, and a format suffix. For example, one of the system-wide templates available is "$enhancedposting.pdf".
   ReportAddress
DeliveryItemListType		1Destination to which the report will be sent. This element is of type DeliveryItemListType, which means it contains one or more destinations.
   ReportReason0-1States the purpose of the report, and is used by templates to perform tasks specific to the reason of the report. Possible values are:
  • Posting
  • Progress
  • Final
  • Archive
  • Pull
  • Bad_Address
  • Removal
 
    prev  next        Table of Contents  Report  
© 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