Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This represents the web service response status and message.


Format


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


Elements


Element

Data Type

Description

Required?

Default

(on insert/update)

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

Text

Number

105

ErrorText

String

Error Text

 

 

 Error

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

Type

MessageType

 

String

 

Error

 Error Type

"Warning" or "Error"
ReferenceId1Int32ReferenceId2Int32

Usage Example(s)


Code Block
languagexml
titleExample 01 - Warning
collapsetrue
              <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>

...