Versions Compared

Old Version 1

changes.mady.by.user Min Zeng

Saved on

compared with

New Version Current

changes.mady.by.user Min Zeng

Saved on

Key

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

Overview

...

Overview

This structure is part of PwsProjectElement, and it represents a note associated with a project. 

Format

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


Elements

Element

Data Type

Required?

Default

Description

Sample Data

AdditionalErrorText

CreatedByUserIdentity

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

Int32n/an/aIn 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

PwsUserRef

**deprecated** It is replaced by element CreatedByUser.


CreatedTimestamp

DateTime

The UTC time of when the project note is created.

2018-02-08T11:15:22.443

Note

String (1024)

The content of the project note.

Tony delivered set design first draft on 01/27

CreatedByUser

PwsUserSummary

The user that created the project note. This structure contains the key information of a user. Click here for more information.


ReadFlagBooleanIf set to "true", this project note has been marked as read.false
ReadTimestampStringThe timestamp for when the note is set to have been read.
2018-11-12T15:57:03.727
NoteIdInt32A unique identifier for a project note. For internal use only.
NoteUidInt64A unique and immutable identifier for a project note.

Usage Example(s)

Code Block
languagexml
titleExample 01 - Warning
collapsetrue
                      <b:PwsProjectNote>
                   <b:PwsMessage>     <b:CreatedByUserIdentity>
                           <b:UserDisplayName>Larry Krakauer</b:UserDisplayName>
                           <b:AdditionalErrorTextUserId i:nil="true"/>
                  <b:ErrorCode>AtLeastOneItemNotFound</b:ErrorCode>         <b:UserReferenceSystemId>ID-LK</b:UserReferenceSystemId>
                           <b:UserUid>1152921504606944254</b:UserUid>
                        </b:CreatedByUserIdentity>
                        <b:ErrorNumber>105<CreatedTimestamp>2020-03-05T19:00:14.363Z</b:ErrorNumber>CreatedTimestamp>
                        <b:ErrorText>AtNote>Don Carlo leastis one of requestedVerdi's itembest wasoperas. not found.Italian Theversion remainingis items,better ifthan any,the werefrench returnedone.</b:ErrorText>Note>
                        <b:CreatedByUser>
                           <b:Type>Warning<UserDisplayName>Larry Krakauer</b:Type>UserDisplayName>
                           <b:ReferenceId1UserId i:nil="true"/>
                           <b:ReferenceId2 i:nil="true"/>:UserReferenceSystemId>ID-LK</b:UserReferenceSystemId>
                           <b:UserUid>1152921504606944254</b:UserUid>
                           <<b:EmailAddress>Larry@revcorp.min</b:PwsMessage>
Code Block
languagexml
titleExample 02 - Error
collapsetrue
EmailAddress>
                 <PwsMessage>          <b:FirstName>Larry</b:FirstName>
       <AdditionalErrorText>Error 10004: InvalidSessionTicket</AdditionalErrorText>                  <ErrorCode>InvalidSessionTicket</ErrorCode><b:LastName>Krakauer</b:LastName>
                           <ErrorNumber>10004</ErrorNumber><b:MiddleName>A</b:MiddleName>
                        </b:CreatedByUser>
      <ErrorText>The specified session ticket is invalid. Please verify you are issuing this request against the correct instance of Projector.</ErrorText> <b:ReadFlag>true</b:ReadFlag>
                        <Type>Error</Type><b:ReadTimestamp>2020-03-05T14:00:14.363</b:ReadTimestamp>
                        <ReferenceId1<b:NoteId i:nil="true"/>
                       <ReferenceId2 i:nil="true"/><b:NoteUid>1152921504606942419</b:NoteUid>
                     </PwsMessage>
b:PwsProjectNote>