Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

Overview


This represents the web service response status and message.


Format


PwsMessage
  • PwsMessage
    • AdditionalErrorText: String
    • ErrorCode: String
    • ErrorNumber: Int32
    • ErrorText: String
    • Type: MessageType


Elements


Element

Data Type

Required?

Default

Description

Sample Data

AdditionalErrorText

String

 

 

If the Status is "OkWithWarnings" or "Fail", this will contain one or more warning or error messages. It may also contain (even when Status is Ok) informational messages.

Warning 105

ErrorCode

String

 

 

Error Code

AtLeastOneItemNotFound

ErrorNumber

Int32

 

 

Error Number

105

ErrorText

String

 

 

 Error

At least one requested item was not found. The remaining items, if any, were returned.

Type

MessageType

 

 

 Error Type

"Warning" or "Error"

Usage Example(s)


Example 01 - Warning
              <b:PwsMessage>
                  <b:AdditionalErrorText i:nil="true"/>
                  <b:ErrorCode>AtLeastOneItemNotFound</b:ErrorCode>
                  <b:ErrorNumber>105</b:ErrorNumber>
                  <b:ErrorText>At least one requested item was not found. The remaining items, if any, were returned.</b:ErrorText>
                  <b:Type>Warning</b:Type>
                  <b:ReferenceId1 i:nil="true"/>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>

Example 02 - Error
              <PwsMessage>
                     <AdditionalErrorText>Error 10004: InvalidSessionTicket</AdditionalErrorText>
                     <ErrorCode>InvalidSessionTicket</ErrorCode>
                     <ErrorNumber>10004</ErrorNumber>
                     <ErrorText>The specified session ticket is invalid. Please verify you are issuing this request against the correct instance of Projector.</ErrorText>
                     <Type>Error</Type>
                     <ReferenceId1 i:nil="true"/>
                     <ReferenceId2 i:nil="true"/>
                  </PwsMessage>

  • No labels