Cloud Fax and Notifications Account API 2.6 Documentation
Common Types and Elements
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  Common Elements  

3.1 StatusType

A Status element is returned in most Cloud Fax and Notifications API result messages.


Tag Name
& type
#Description
StatusType    
   StatusCode
xs:integer
1Contents will be an integer value. The value 0 indicates successful processing of the message, and any non-zero value indicates something less than complete successful processing.

In general, a value of 1 indicates a failure or problem. An overall request StatusCode of 2 indicates partial success. For multi-part results, the status of each part must be examined.

   StatusMessage
xs:string
0-1If present, this will contain a text message associated with the StatusCode. This is intended as an aid only - users should rely only on the StatusCode, and should not count on any particular text string or pattern in StatusMessage.
   ErrorList0-1If present, this will contain one or more Error elements with more information about errors that were encountered. In general this information should be considered merely advisory or diagnostic.
   Error1-Contains error information.
   ErrorCode
xs:integer
1An integer value associated with the particular error.
   ErrorMessage
xs:string
1Text relating to the error.
   SubmissionTime
xs:dateTime
1The time the request (or relevant part of the request) was received for processing.
   CompletionTime
xs:dateTime
1The time that processing of the request (or part of the request was completed. Note that there may be a delay in communicating the result of the task back to the user.
 
    prev  next        Table of Contents  Common Elements  
© 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