Versions Compared

Key

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

...

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

Required?

Default

Description

Sample Data

AdditionalErrorText

String

n/a

n/a

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

n/a

n/a

Error Code

AtLeastOneItemNotFound

ErrorNumber

Int32

n/a

n/a

Error Number

105

ErrorText

String

 Error

n/a

n/a

Error

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

Type

MessageType

 Error

n/a

n/a

Error Type

"Warning" or "Error"

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>

...