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 messagesstructure that contains the complete information of a web service error. It consists of an error code, an error number and error text. This structure is used by various services that operate on a set of items in such a fashion where some of the items may fail to be processed without causing the entire operation to fail. For example, when saving time cards, one or more time cards may fail to save while others are saved. In these cases, this structure is included in the web service response to provide details on the specific error that occurred for each failed item.
Format
Panel | ||
---|---|---|
| ||
|
Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
ErrorCode | String | The code of the web service error. | DescriptionRequiredForSaveProjectIssue |
ErrorNumber | Int32 | The number of the web service error. | 84018 |
ErrorText | String | The text message of the web service error. | Description is required. |
Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<a:ErrorDetail xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ErrorCode>DescriptionRequiredForSaveProjectIssue</b:ErrorCode> <b:ErrorNumber>84018</b:ErrorNumber> <b:ErrorText>Description is required.</b:ErrorText> </a:ErrorDetail> |
...