Overview

A collection of zero or more PwsMessage structures is included in the response of every PWS web service request. If the RequestStatus of the request is "OkWithWarnings" or "Fail", this will contain one or more warning and/or error messages. It may also contain (even when Status is Ok) informational messages.

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	This string may contain additional details about the error or warning, depending on the specific condition.
ErrorCode	String	n/a	n/a	This is a mnemonic 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. The possible values, in increasing order of severity, are Information, Warning or Error.	Warning
ReferenceId1 ReferenceId2	Int32	n/a	n/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>