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

Overview


This web service retrieves a specified document folder's contents

Request Format


PwsGetFolderContents Request
  • PwsGetFolderContents

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.

1

SessionTicket

String

Yes 


Click here for more information.

AZZNMfO8vxeYuc3WXDkixw==

FolderIdentity

PwsFolderRef

Yes 


The folder identity


IncludeDeletedDocumentsFlag

Boolean

No 

 false

If set to 'true', documents that have been deleted will be included in the response 

true

IncludeNotesFlag

Boolean

No 

false 

If set to 'true', notes will be included in the response

true

Request Usage Example(s)


Example 01 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:doc="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetFolderContents>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AZZNMfO8vxeYuc3WXDkixw==</req:SessionTicket>
            <doc:FolderIdentity>
               <com:FolderUid>1152921504607349085</com:FolderUid>
            </doc:FolderIdentity>
            <doc:IncludeDeletedDocumentsFlag>true</doc:IncludeDeletedDocumentsFlag>
            <doc:IncludeNotesFlag>true</doc:IncludeNotesFlag>
         </pws:serviceRequest>
      </pws:PwsGetFolderContents>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetFolderContents Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information

1

Status

RequestStatus

Click here for more information


ServerTimestampUtc

DateTime

Click here for more information

2018-03-16T17:37:44.8271491Z

Folder

PwsFolder

The complete details of the folder and the folder contents


Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetFolderContentsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetFolderContentsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-16T17:37:44.8271491Z</ServerTimestampUtc>
            <a:Folder>
               <FolderId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <FolderUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607349085</FolderUid>
               <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607011056</b:UserUid>
               </a:CreatedByUserIdentity>
               <a:CreatedTimestamp>2018-03-16T16:07:37.2Z</a:CreatedTimestamp>
               <a:DeletedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <a:DeletedTimestamp i:nil="true"/>
               <a:Documents>
                  <a:PwsDocument>
                     <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607571587</DocumentRefUid>
                     <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607011056</b:UserUid>
                     </a:CreatedByUserIdentity>
                     <a:CreatedTimestamp>2018-03-16T16:07:33.117Z</a:CreatedTimestamp>
                     <a:CurrentVersion>
                        <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607572684</DocumentVersionUid>
                        <a:Comments i:nil="true"/>
                        <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607011056</b:UserUid>
                        </a:CreatedByUserIdentity>
                        <a:CreatedTimestamp>2018-03-16T16:07:33.117Z</a:CreatedTimestamp>
                        <a:DocumentArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:VersionNumber>1</a:VersionNumber>
                     </a:CurrentVersion>
                     <a:DeletedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:DeletedTimestamp i:nil="true"/>
                     <a:DocumentName>01_Scan_1.jpeg</a:DocumentName>
                     <a:DocumentSize>28613</a:DocumentSize>
                     <a:DocumentUri i:nil="true"/>
                     <a:LockedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:LockedTimestamp i:nil="true"/>
                     <a:MimeType>image/jpeg</a:MimeType>
                     <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607011056</b:UserUid>
                     </a:ModifiedByUserIdentity>
                     <a:ModifiedTimestamp>2018-03-16T16:07:33.117Z</a:ModifiedTimestamp>
                     <a:SupportPreviewFlag>true</a:SupportPreviewFlag>
                     <a:SupportThumbnailFlag>true</a:SupportThumbnailFlag>
                     <a:DocumentData>
                        <a:DataItems>
                           <a:PwsDocumentDataItems>
                              <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                 <b:ItemId i:nil="true"/>
                                 <b:ItemType>CCD</b:ItemType>
                                 <b:ItemUid>1152921504614515297</b:ItemUid>
                                 <b:ReferenceType i:nil="true"/>
                              </a:AssociatedItemIdentity>
                              <a:Data>
                                 <a:Values xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Type</b:Tag>
                                       <b:Value>CostCard</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>D</b:ColumnType>
                                       <b:Tag>Incurred Date</b:Tag>
                                       <b:Value>Feb 27 2018</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Expense Type</b:Tag>
                                       <b:Value>Other/Misc Billable</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>M</b:ColumnType>
                                       <b:Tag>Disbursed Amount</b:Tag>
                                       <b:Value>21.75</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Disbursed Currency Code</b:Tag>
                                       <b:Value>USD</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                 </a:Values>
                              </a:Data>
                           </a:PwsDocumentDataItems>
                        </a:DataItems>
                        <a:DocumentDataDetail>
                           <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:ItemId i:nil="true"/>
                              <b:ItemType>ED</b:ItemType>
                              <b:ItemUid>1152921504607683575</b:ItemUid>
                              <b:ReferenceType i:nil="true"/>
                           </a:AssociatedItemIdentity>
                           <a:Associations>
                              <a:PwsDocumentAssociation>
                                 <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                    <b:ItemId i:nil="true"/>
                                    <b:ItemType>CCD</b:ItemType>
                                    <b:ItemUid>1152921504614515297</b:ItemUid>
                                    <b:ReferenceType i:nil="true"/>
                                 </a:AssociatedItemIdentity>
                                 <a:ReferenceNumber i:nil="true"/>
                                 <a:ReferenceNumberClearFlag>false</a:ReferenceNumberClearFlag>
                              </a:PwsDocumentAssociation>
                           </a:Associations>
                           <a:Notes i:nil="true"/>
                        </a:DocumentDataDetail>
                     </a:DocumentData>
                     <a:EditDeleteFlag>true</a:EditDeleteFlag>
                     <a:NumberPages i:nil="true"/>
                     <a:ArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:EditDeletePermissionFlag>true</a:EditDeletePermissionFlag>
                     <a:ReceiptLockedFlag>false</a:ReceiptLockedFlag>
                  </a:PwsDocument>
               </a:Documents>
               <a:FolderName>Expense report created 27 Feb 2018 - A</a:FolderName>
               <a:FolderTypeCode>ExpenseReportFolder</a:FolderTypeCode>
               <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607011056</b:UserUid>
               </a:ModifiedByUserIdentity>
               <a:ModifiedTimestamp>2018-03-16T16:07:37.2Z</a:ModifiedTimestamp>
               <a:AttachmentNotes/>
               <a:CanAddAssociationsFlag>true</a:CanAddAssociationsFlag>
               <a:CanAddDocumentsFlag>true</a:CanAddDocumentsFlag>
               <a:CanAddLinksFlag>false</a:CanAddLinksFlag>
               <a:CanAddNotesFlag>true</a:CanAddNotesFlag>
               <a:CanAddVersionsFlag>false</a:CanAddVersionsFlag>
               <a:CanSearchDocumentsFlag>false</a:CanSearchDocumentsFlag>
               <a:RequireDocumentDataFlag>true</a:RequireDocumentDataFlag>
               <a:RequireUniqueFilenamesFlag>false</a:RequireUniqueFilenamesFlag>
               <a:UploadFolderIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:FolderId i:nil="true"/>
                  <b:FolderUid>1152921504607349076</b:FolderUid>
               </a:UploadFolderIdentity>
            </a:Folder>
         </PwsGetFolderContentsResult>
      </PwsGetFolderContentsResponse>
   </s:Body>
</s:Envelope>

PwsGetFolderContents - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

21001FolderRequiredForGetFolderContentsA folder identity must be specified.
75205FolderNotFoundFolder not found.
  • No labels