PwsSaveTaskNoteResult

Overview


This structure represents the results of a project task note insert. Multiple project task notes can be submitted for insert in a single request to PwsSaveTimeCards. This operation can partially succeed, meaning some notes were successfully saved while others triggered errors and could not be saved. The web service will report back details about each note, whether it succeeded or failed, by returning a collection of these structures. For failed notes, ErrorDetail will provide more details about the nature of the failure.

Format


PwsSaveTaskNoteResult

Elements


Element

Data Type

Description

Sample Data

ErrorDetail

PwsErrorDetail

The error detail regarding a failed project task note insert.


ReferenceId

String

Reference id (used to affiliate PwsSaveTaskNoteResult records with associated PwsProjectTaskNote records).


TaskNotes

PwsProjectTaskNoteHistory []

The project task note history.


Usage Example(s)


Example 01 - successful response
               <a:PwsSaveTaskNoteResult>
                  <a:ErrorDetail i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:ReferenceId i:nil="true"/>
                  <a:TaskNotes>
                     <a:PwsProjectTaskNoteHistory>
                        <a:CreatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607112369</b:UserUid>
                        </a:CreatedByUser>
                        <a:CreatedTimestamp>2018-03-09T21:12:16.373Z</a:CreatedTimestamp>
                        <a:ProjectTaskNotes>Added via the web service</a:ProjectTaskNotes>
                     </a:PwsProjectTaskNoteHistory>
                     <a:PwsProjectTaskNoteHistory>
                        <a:CreatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607112369</b:UserUid>
                        </a:CreatedByUser>
                        <a:CreatedTimestamp>2018-03-04T21:42:46.697Z</a:CreatedTimestamp>
                        <a:ProjectTaskNotes>Initial research document added to project workspace</a:ProjectTaskNotes>
                     </a:PwsProjectTaskNoteHistory>
                     <a:PwsProjectTaskNoteHistory>
                        <a:CreatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607112369</b:UserUid>
                        </a:CreatedByUser>
                        <a:CreatedTimestamp>2018-03-09T21:43:18.02Z</a:CreatedTimestamp>
                        <a:ProjectTaskNotes>Please see Jack for more information regarding this task</a:ProjectTaskNotes>
                     </a:PwsProjectTaskNoteHistory>
                  </a:TaskNotes>
               </a:PwsSaveTaskNoteResult>
Example 02 - unsuccessful response
            <a:TaskNoteResults>
               <a:PwsSaveTaskNoteResult>
                  <a:ErrorDetail xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ErrorCode>ProjectTaskNotFound</b:ErrorCode>
                     <b:ErrorNumber>54207</b:ErrorNumber>
                     <b:ErrorText>The specified project task does not exist.</b:ErrorText>
                  </a:ErrorDetail>
                  <a:ReferenceId i:nil="true"/>
                  <a:TaskNotes i:nil="true"/>
               </a:PwsSaveTaskNoteResult>
            </a:TaskNoteResults>