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

Overview


The web service takes identifying keys of a document (PwsDocumentRef) and returns detailed document information (PwsDocument). 

Request Format


PwsGetDocumentDetails Request

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

ATtU220EvBSE2+GCN9U58g==

DocumentIdentity

PwsDocumentRef

Yes


The identity of the document whose detailed information is retrieved. Click here for more information.


Request Usage Example(s)


Example 01 - Receipt on a cost card 
<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:PwsGetDocumentDetails>
         <pws:serviceRequest>
            <req:SessionTicket>AR1y0tla07GdSuw83u1Fvg==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607655224</com:DocumentRefUid>
            </doc:DocumentIdentity>
         </pws:serviceRequest>
      </pws:PwsGetDocumentDetails>
   </soapenv:Body>
</soapenv:Envelope>
Example 02 - Receipt on an expense report 
<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:PwsGetDocumentDetails>
         <pws:serviceRequest>
            <req:SessionTicket>AR1y0tla07GdSuw83u1Fvg==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607655227</com:DocumentRefUid>
            </doc:DocumentIdentity>
         </pws:serviceRequest>
      </pws:PwsGetDocumentDetails>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetDocumentDetails 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.

0

StatusRequestStatusClick here for more informationOk

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-13T15:50:50.198383Z

Document

PwsDocument

Detailed information on a document. Click here for more information.


Response Usage Example(s)


Example 01 - Receipt on a cost card 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetDocumentDetailsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetDocumentDetailsResult 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-19T18:46:11.9819778Z</ServerTimestampUtc>
            <a:Document>
               <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607655224</DocumentRefUid>
               <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </a:CreatedByUserIdentity>
               <a:CreatedTimestamp>2018-03-19T14:42:05.167Z</a:CreatedTimestamp>
               <a:CurrentVersion>
                  <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607659447</DocumentVersionUid>
                  <a:Comments i:nil="true"/>
                  <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606950320</b:UserUid>
                  </a:CreatedByUserIdentity>
                  <a:CreatedTimestamp>2018-03-19T14:42:05.167Z</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>Receipt on CC.jpg</a:DocumentName>
               <a:DocumentSize>72403</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>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </a:ModifiedByUserIdentity>
               <a:ModifiedTimestamp>2018-03-19T14:42:05.167Z</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>1152921504614018558</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>Mar  1 2018</b:Value>
                                 <b:Values/>
                              </b:PwsValue>
                              <b:PwsValue>
                                 <b:ColumnType>V</b:ColumnType>
                                 <b:Tag>Expense Type</b:Tag>
                                 <b:Value>Personal Auto Mileage</b:Value>
                                 <b:Values/>
                              </b:PwsValue>
                              <b:PwsValue>
                                 <b:ColumnType>M</b:ColumnType>
                                 <b:Tag>Disbursed Amount</b:Tag>
                                 <b:Value>12.00</b:Value>
                                 <b:Values/>
                              </b:PwsValue>
                              <b:PwsValue>
                                 <b:ColumnType>V</b:ColumnType>
                                 <b:Tag>Disbursed Currency Code</b:Tag>
                                 <b:Value>CAD</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>1152921504607636703</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>1152921504614018558</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:Document>
         </PwsGetDocumentDetailsResult>
      </PwsGetDocumentDetailsResponse>
   </s:Body>
</s:Envelope>
Example 02 - Receipt on an expense report 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetDocumentDetailsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetDocumentDetailsResult 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-19T19:03:25.1413351Z</ServerTimestampUtc>
            <a:Document>
               <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607655227</DocumentRefUid>
               <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </a:CreatedByUserIdentity>
               <a:CreatedTimestamp>2018-03-19T14:44:09.65Z</a:CreatedTimestamp>
               <a:CurrentVersion>
                  <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607659450</DocumentVersionUid>
                  <a:Comments i:nil="true"/>
                  <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606950320</b:UserUid>
                  </a:CreatedByUserIdentity>
                  <a:CreatedTimestamp>2018-03-19T14:44:09.65Z</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>Receipt on ER.jpg</a:DocumentName>
               <a:DocumentSize>24380</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>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </a:ModifiedByUserIdentity>
               <a:ModifiedTimestamp>2018-03-19T14:44:09.65Z</a:ModifiedTimestamp>
               <a:SupportPreviewFlag>true</a:SupportPreviewFlag>
               <a:SupportThumbnailFlag>true</a:SupportThumbnailFlag>
               <a:DocumentData>
                  <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>1152921504607636703</b:ItemUid>
                        <b:ReferenceType i:nil="true"/>
                     </a:AssociatedItemIdentity>
                     <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:Document>
         </PwsGetDocumentDetailsResult>
      </PwsGetDocumentDetailsResponse>
   </s:Body>
</s:Envelope>

PwsGetDocumentDetails - Common Errors and Warnings

ErrorNumberErrorCodeErrorText
21033DocumentRequiredForGetDocumentA document identity must be specified.
75199DocumentNotFoundDocument not found
  • No labels