Cloud Fax and Notifications API 2.5 Documentation
JobSummary
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  JobSummary  
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.
 

32.3 JobSummaryResult

JobSummary Overview   JobSummaryRequest

Tag Name
& type
#Description
JobSummaryResult   Namespace of this element is http://ws.easylink.com/JobSummary/2011/01
   Status
StatusType
1Status of processing. See StatusType.
   SubmitId
xs:string
0-1Echoes the SubmitId in the request, if one was provided, and if possible.
   JobSummaryData
JobSummaryDataType
0-There will ordinarily be one JobSummaryData element for each JobId in the original request. They will not necessarily be in the same order as in the request.
   @jobGroup
xs:boolean
0-1Boolean value (default is "false") which indicates whether this job is a job group or not.
   JobId
JobIdType
1Identifies the job whose data is in this JobSummaryData element.
   Status
StatusType
1Status of the attempt to retrieve data for this particular job. Note that each job summary attempt may succeed or fail independently of others. See StatusType.
   UserId
xs:string
0-1The user ID associated with this job.
   EntryTime
xs:dateTime
0-1Job's entry time.
   StartTime
xs:dateTime
0-1Job's start time.
   CompletionTime
xs:dateTime
0-1Job's completion time.
   BillingCode
EncodableStringType
0-1Job's billing code, if any. See EncodableStringType.
   CustomerReference
EncodableStringType
0-1Job's customer reference, if any. See EncodableStringType.
   DeliveryPriority
xs:string
0-1Indicates the scheduling used for the job. Valid values include:
  • express
  • offpeak
  • scheduled
Other values may occur, but are not typical.
   ListsUsed0-1Identifies the stored lists (if any) used with the job.
   ListId
ListIdType
1-List identifier
   DestinationCount
xs:integer
0-1The number of primary destinations for this job.
   PostedTime
xs:dateTime
0-1The time the job completed posting, i.e. all primary deliveries complete.
   ExpirationTime
xs:dateTime
0-1Job's expiration time. For enhanced email jobs this is the date/time at which EasyLink will stop collecting MDNs, DSN, HTML open and pull statistics.
   ServiceType
xs:string
0-1The EasyLink system will attempt to associate jobs with various service types, reflecting the general nature of the job (fax, email, voice, etc.). Possible values include but are not limited to:
  • FR
  • MR
  • VR
  • SR
   Fax2MailService
xs:string
0-1Indicates the type of fax2mail service: F2M or M2F (case insensitive)
   JobGroupStatus
JobGroupStatusTypeType
0-1If the job is associated with a job group, this will indicate whether it is the job group head ("parent") or a member of the group ("child")
   Preview
xs:boolean
0-1true if fax preview was requested for this job
   PreviewResult
xs:string
0-1Indicates the result of the preview process, if any. Possible values are:
  • accepted
  • rejected
  • timeout
   ComplianceResult
xs:string
0-1Indicates the result of the compliance process, if any.
   JobFlags
xs:integer
0-1integer representation of a 32-bit mask of job flags
   JobFlags2
xs:integer
0-1integer representation of extended bit mask of job flags (currently unused)
   JobWasPaused
xs:boolean
0-1boolean indicating whether job was paused at some point in processing
   FaxCoverSheet
xs:boolean
0-1boolean indicating whether a coversheet was requested for this job
   Att
EncodableStringType
0-1Job-level Att value (destination-level value may also exist). See EncodableStringType.
   FaxTo
EncodableStringType
0-1Job-level FaxTo value (destination-level value may also exist) See EncodableStringType.
   Subject
EncodableStringType
0-1Job-level subject value. See EncodableStringType.
   EmailFrom
EncodableStringType
0-1The "from" display name used in an enhanced email job. See EncodableStringType.
   Filename
EncodableStringType
0-1Filename associated with this job. See EncodableStringType.
This value will be base64-encoded (with "binary" b64charset) if the UseBinary option was specified, or if conversion to UTF-8 was unsuccessful.
   FaxMode
FaxModeType
0-1If applicable, the fax mode ("standard" or "fine") used for delivery
   Class
xs:string
0-1The EasyLink delivery class: bcast or p2p (case insensitive)
   GroupName
xs:string
0-1Specifies the user's primary Fax2Mail "group name"
   CharacterSet
xs:string
0-1Job-level default character set
   TransferNum
TransferNumType
0-Phone number and extension (if present) for a hot-key transfer
   @transferKey
xs:string
0-1Telephone key number associated with the transfer number
   Paced
xs:boolean
0-1Boolean indicating whether a voice job was paced
   DeliveryPaces
xs:string
0-1The name of the delivery paces associated with this job. (Not currently populated)
   FaxInFaxID
xs:string
0-1The TSID from the fax machine submitting an "instruction sheet" job
   FaxInDNIS
xs:string
0-1The fax number used for submission of an "instruction sheet" job
   FaxInConnectTime
xs:int
0-1The duration of an "instruction sheet" job submission in seconds
   FaxInPageCount
xs:int
0-1The number of fax pages received by EasyLink from an "instruction sheet" job submission
   AreaCodeRecipOmitted
xs:string
0-1The number of addresses from the original recipient list(s) that were not delivered due to area code filtering
   RetryAlgorithm
xs:string
0-1Name (usually numeric) of the retry pattern used for this job
   RecipientLocaleStartTime
xs:dateTime
0-1If the RecipientLocaleStartTime option was used for the job, this value represents the local clock time used as the start time for delivery. Note that this value will not have a "timezone" portion.
   DropCopyTo
EncodableStringType
0-1Specifies one of
  • fax:faxaddress
  • internet:internetaddress
  • list:listname
   DropCopyFrom
EncodableStringType
0-1The "from" value used for a drop copy message.
   ExtendedJobData
ExtDataType
0-1If "extended" data is available and requested, it will be returned in this element.
   ExtSegment1-Contains fields from a particular segment.
   @name
xs:string
0-1Name of the segment or data group of the data field being returned. (Optional - some data fields may not belong to a segment.)
   ExtProp
ExtPropType
1-Container for one data field value
   @name
xs:string
0-1Name of the extended data field.
   @idnum
xs:string
0-1Identifying number (if any) of the extended data field.
   ExtString
EncodableStringType
1Used if extended data is represented as a character string. See EncodableStringType.
ExtNumber
xs:decimal
1Used if extended data is known to be a number
ExtDateTime
xs:dateTime
1Used if extended data is known to be a date/time.
   JobState0-Contains the summary data associated with the relevant state. More than one state may be applicable to a job, so there may be more than one JobState child of JobSummaryData.
   @state
xs:string
1Indicates the state to which this data applies. Many of the elements possible in a JobState element only apply to specific states. Valid values are:
  • AwaitingSetup
  • Setup
  • Processing
  • AwaitingDelivery
  • Delivering
  • Posted
  • Delivered
  • Reporting
  • Complete
  • Error
  • Cancelled
  • Held
  • Preview
  • Paused
  • AwaitingCompliance
   ExpectedSetupStart
xs:dateTime
0-1Applies to AwaitingSetup state, and is the estimated time for the start of job setup, based on queue data.
   ItemsProcessed
xs:integer
0-1Applies to Setup state. For regular jobs, this is the number of destinations set up. For group jobs, this is the number of jobs in the group that have been set up.
   ExpectedDeliveryStart0-1Applies to Processing and AwaitingDelivery state. If the attribute offpeak is true, then this value may be empty, rather than specifying a time.
   @offpeak
xs:boolean
0-1Indicates if the expected start time is governed by offpeak delivery.
   ErrorInfo
ErrorInfoType
0-1Applies to Error state.
   ErrorCategory
xs:string
1Error category derived from error code (in switch error queue item). This is a single character.
   ErrorProcessingCode
xs:string
0-1Error code (from switch error queue item)
   ErrorDetail
xs:string
0-1Text description of error
   ReportType
xs:string
0-1Applies to Reporting state, and indicates the kind of report.
   ReportStarted
xs:dateTime
0-1Applies to Reporting state, and indicates the time report preparation began.
   JobSummaryCounts
JobSummaryCountsType
0-1Applies to Delivering, Delivered, and Complete states. The significance of the child elements differs between job groups and regular jobs.
   Total
xs:integer
0-1Total number of destinations.
   Pending
xs:integer
0-1Number of destinations still awaiting delivery.
This actually includes Pending, Submitted, In-progress, and Held items, as well as any that have not yet reported a state.
   Sent
xs:integer
0-1Number of destinations successfully sent by EasyLink.
   Error
xs:integer
0-1Number of destinations which could not be delivered due to problems (e.g. busy fax number) encountered while attempting delivery.
   Cancelled
xs:integer
0-1Number of destinations for which delivery was cancelled, or which have expired.
   TotalDSN
xs:integer
0-1Number of DSNs detected (MR jobs only)
   NegativeDSN
xs:integer
0-1Number of DSNs indicating non-delivery (MR jobs only)
   UnconfirmedDSN
xs:integer
0-1Number of DSNs not definitely indicating non-delivery (MR jobs only)
   Blocked
xs:integer
0-1Number of destinations blocked (status codes 6500, 6503, 6504, 6505) (MR jobs only)
   Read
xs:integer
0-1Detected number of read deliveries (MR jobs only)
   Pulls
xs:integer
0-1Number of file pulls (MR jobs only)
   TotalTransfers
xs:integer
0-1Total number of hotkey transfers (only applies to voice jobs). (VoiceStatistics TRANCRT)
   FailedTransfers
xs:integer
0-1Number of failed transfer attempts (only applies to voice jobs). (VoiceStatistics TRAN_FAIL)
   TransferPickupTime
xs:integer
0-1Total time from hotkey pressed to transfer complete (either picked up or errored) (only applies to voice jobs). (VoiceStatistics TRAN_DUR)
   TotalTransferTime
xs:integer
0-1Total time from hotkey pressed to termination of call (either picked up or errored) (only applies to voice jobs). (VoiceStatistics TOTAL_DUR1)
   LiveDeliveries
xs:integer
0-1Number of calls apparently answered by live person. (only applies to voice jobs). (VoiceStatistics FULLCTR)
   AnsweringMachineDeliveries
xs:integer
0-1Number of calls apparently answered by answering machines (only applies to voice jobs). (VoiceStatistics FULLMCTR)
   PartialLiveDeliveries
xs:integer
0-1Number of partial live deliveries (only applies to voice jobs) (VoiceStatistics PARTIALCTR)
   PartialAnsweringMachineDeliveries
xs:integer
0-1Number of partial answering machine deliveries (only applies to voice jobs) (VoiceStatistics PARTIALMCTR)
   NoAnswer
xs:integer
0-1Number of calls that were not answered (fax and voice jobs only) (sum of all delivery items with one of the following three posting status: 3070, 3912, 3935)
   Busy
xs:integer
0-1Number of calls that failed as the result of a "busy signal" (only applies to voice jobs) (VoiceStatistics BUSYCTR)
   Held
xs:integer
0-1Number of "held" items (fax and voice jobs only) (EventStatus2 ::getPostings(6))
   TotalCompletedDeliveryTime
xs:integer
0-1Total completed delivery time in seconds - (only applies to voice jobs) (EventStatus2::getPostingDuration())
   SummaryCount0-Additional counts may be defined in the future, and may appear in this element
   @countName
xs:string
1Name of the count value.
   AuxiliaryStatus0-This element may occur more than once and is intended to contain additional information about the job's circumstances. It is not currently actually used.
   @scope
StatusScopeType
0-1Indicates the processing scope of the status being provided. Legal values are:
  • System
  • Job
  • Subjob
Future development might, for example, use "System" to indicate some general adverse condition affecting many jobs, including this one.
   AuxCode
xs:string
0-1Short identifier of status condition
   AuxDetail
xs:string
0-1Description of status condition
   AttachmentInfo
AttachmentInfoType
0-Provides information about attachment documents used for the job.
   @attachmentNum
xs:int
1Numeric identifier assigned to each attachment. (For jobs that request HTML open tracking, the "clear GIF" attachment will always have an attachmentNum of "-1")
   FileName
xs:string
1Filename associated with this attachment
   Size
xs:integer
1Integer specifying the attachments file size in bytes
   AttachmentFlags
AttachmentFlagsType
0-Indicates how an attachment is used. Legal values are:
  • push
  • pull
  • clickto
  • trackable
  • untrackable
  • open
  • image
  • embedded
   Security
SecurityType
0-1Specifies the type of security associated with this attachment. Legal values are:
  • none
  • 40bit
  • 128bit
   ContentType
xs:string
0-1Specifies the MIME type for this attachment.
   TotalPulls
xs:integer
0-1Integer specifying the total number of pulls/opens for this attachment.
   DistinctPulls
xs:integer
0-1Integer specifying the total number of distinct pulls/opens for this attachment.
 
    prev  next        Table of Contents  JobSummary  
© 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