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 22 Next »

Overview


This represents the web service response status and message

Format


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


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

The error code associated with the message

AtLeastOneItemNotFound

ErrorNumber

Int32

n/a

n/a

The error number associated with the message

105

ErrorText

String

n/a

n/a

The error text associated with the message

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

Type

MessageType

n/a

n/a

The error type associated with the message

"Warning" or "Error"
ReferenceId1Int32n/an/a

In some cases these reference ids are used to correlate error message to specific items specified in the web service inputs (for example, these are used to correlate errors to time cards or time off cards specified as inputs to PwsSaveTimeCardsAndRto. The meaning of each value is specific to the particular context.


ReferenceId2Int32n/an/a

In some cases these reference ids are used to correlate error message to specific items specified in the web service inputs (for example, these are used to correlate errors to time cards or time off cards specified as inputs to PwsSaveTimeCardsAndRto. The meaning of each value is specific to the particular context.


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