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

22.2 ItemLevelQueryRequest

ItemLevelQuery Overview   ItemLevelQueryResult

Tag Name
& type		#Description
ItemLevelQueryRequest   Namespace of this element is http://ws.easylink.com/ItemLevelQuery/2011/01
   SubmitId
xs:string		0-1Optional string identifying request, which will be echoed in result.
   Domain
xs:string		0-1If this element is not present, then all of the EasyLink switch "domains" that are assigned to the requester will be queried.
If this element is present, then the search will be restricted to the domain named by the element's value. The special values "XDDS" and "MR" can be used to restrict the search to the assigned domain(s) of the appropriate type.
   StartDateTime
xs:dateTime		1Start time of the window to be searched.
   EndDateTime
xs:dateTime		1End time of the window to be searched.
   UseBase64
xs:boolean		0-1This affects the way data will be returned. See Character Sets.
   UseBinary
xs:boolean		0-1This affects the way data will be returned. See Character Sets.
   EntityId
EntityIdType		0-1This identifies an entity - user, group or customer - that the delivery is associated with through job ownership.
For the user level, this must be the User Account Number. For the group level, this must be the group number. For the customer level, this must be the customer number.
   @type
EntityLevel		1Type of owner entity. The value can be:
  • user
  • customer
  • group
   NumToRetrieve
xs:unsignedInt		0-1If present, the result will contain no more than this number of records for each domain queried. It may contain fewer, or none. For example, if the value 100 is provided and no Domain is specified, then at most 100 items each domain assigned to the user, will be returned
   ItemState
JobStateType		0-1When present, this selects items based on their delivery state. For this purpose, the states are categorized as either Delivered or Undelivered. These "states" are intended to offer a useful set of user-friendly values, although they actually represent combinations of a number of internal state and error data.
   Delivered
xs:string		1Legal values are:
  • All
  • LiveAnswer
  • AnsweringMachine
  • NotClassified
  • TransferRecipient
  • TransferCenter
  • TransferUnanswer
  • TransferFailed
  • TransferBusy
  • PartialDelivery
Undelivered
xs:string		1Legal values are:
  • All
  • Busy
  • Invalid
  • NoAnswer
  • Disconnect
  • Blackout
  • TooManyDigits
  • TooFewDigits
  • BadCountryCode
  • NoService
  • BadExtension
  • DuplicateNumber
  • Blocked
  • JobExpired
  • Dead
   StartJobFilter
ILStartJobFilter		0-1The NumToRetrieve value may limit the number of records returned for this request. If further records from the same set of items is desired, then information from the last item in the first request can be set here, so that that is used as the starting point for the next request. Since this can be ambiguous if multiple domains are queried, it may be desirable to set the Domain field as well for subsequent queries.
   StartJobId
JobIdType		1JobId after which items are to be retrieved. See JobIdType.
   BillingSubJobNo
xs:long		1A delivery item is uniquely identified by the combination of JobId, BillingSubJobNo, and XQN.
   XQN
xs:long		1A delivery item is uniquely identified by the combination of JobId, BillingSubJobNo, and XQN.
   ItemLevelFilter
ILItemQueryFilter		0-1If present, items (within the specified time window) will be selected if they match the value provided here.
   ItemRef
EncodableStringType		0-1If this choice is used, only items with this ItemRef ("ref") will be returned. See EncodableStringType.
DestinationAddress
DestinationType		0-1If this choice is used, only items with this destination address will be returned. This may be a leading substring of phone-type addresses, or a substring for email addresses. See DestinationType.
ItemLevelQuery actually operates on the destination string alone. The destination type is used as a hint to properly format the destination for the search, but matching destinations of any type will be returned. In particular, fax, voice and sms destinations are all phone-type addresses, so a request for any of these may result in destinations of the other types being returned.
   JobLevelFilter
ILJobQueryFilter		0-1If present, items (within the specified time window) will be selected if they belong to jobs whose BillingCode or CustomerReference match the value provided here.
   BillingCode
EncodableStringType		0-1If this choice is used, only items from jobs with this BillingCode will be returned. See EncodableStringType.
CustomerReference
EncodableStringType		0-1If this choice is used, only items from jobs with this CustomerReference will be returned. See EncodableStringType.
   ExtendedFilter
ExtDataFilterType		0-1Not currently used.
   IncludeExtendedJobData
ExtDataFilterType		0-1If present, this requests extended data at the job level.
   ExtSegmentFilter0-Contains the requested fields in a particular segment.
   @name
xs:string		0-1Name of the segment
   ExtPropFilter0-Identifies a requested field. Must have either the name or idnum attribute
   @name
xs:string		0-1Name of the requested field.
   @idnum
xs:string		0-1Identifying number of the request field.
 
    prev  next        Table of Contents  ItemLevelQuery  
© 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