Versions Compared

Old Version 9

changes.mady.by.user Min Zeng

Saved on

compared with

New Version 10

changes.mady.by.user Min Zeng

Saved on

Key

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

...

Code Block
languagexml
titleExample 01 - Receipt on a cost card
collapsetrue
<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>

Response Format

Panelcode

...

Document

...

PwsDocument

...

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

Response Usage Example(s)

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetDocumentDetailsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
Code Block
languagexml
titleExample 01 - Receipt on a cost card
collapsetrue
languagexml
titlePwsGetDocumentDetails 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

...

ServerTimestampUtc

...

DateTime

...

Click here for more information.

...

2018-03-13T15:50:50.198383Z

Example 02 - Receipt on an expense report
collapsetrue
<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

Panel
titlePwsGetDocumentDetails 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)


Code Block
languagexml
titleExample 01 - Receipt on a cost card
collapsetrue
<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>
             <PwsGetDocumentDetailsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">                  <Messages xmlns="http<b://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>Value>CostCard</b:Value>
                              <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>   <b:Values/>
               <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>             <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-19T18:46:11.9819778Z</ServerTimestampUtc></b:PwsValue>
            <a:Document>                <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>  <b:PwsValue>
               <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607655224</DocumentRefUid>                <a:CreatedByUserIdentity xmlns<b:ColumnType>D</b="http://projectorpsa.com/DataContracts/Shared/Common/">:ColumnType>
                                 <b:UserDisplayName>BruceTag>Incurred Wayne<Date</b:UserDisplayName>Tag>
                  <b:UserId i:nil="true"/>              <b:Value>Mar     <b:UserReferenceSystemId>BW-01<1 2018</b:UserReferenceSystemId>Value>
                                 <b:UserUid>1152921504606950320</b:UserUid>
Values/>
              </a:CreatedByUserIdentity>                <a:CreatedTimestamp>2018-03-19T14:42:05.167Z</a:CreatedTimestamp></b:PwsValue>
                <a:CurrentVersion>              <b:PwsValue>
    <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>                   <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607659447</DocumentVersionUid>       <b:ColumnType>V</b:ColumnType>
           <a:Comments i:nil="true"/>                      <a<b:CreatedByUserIdentityTag>Expense xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">Type</b:Tag>
                       <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>         <b:Value>Personal Auto Mileage</b:Value>
          <b:UserId i:nil="true"/>                      <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>Values/>
                              <b:UserUid>1152921504606950320<</b:UserUid>PwsValue>
                      </a:CreatedByUserIdentity>        <b:PwsValue>
          <a:CreatedTimestamp>2018-03-19T14:42:05.167Z</a:CreatedTimestamp>                     <a:DocumentArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <b:ColumnType>M</b:ColumnType>
                                 <a<b:VersionNumber>1<Tag>Disbursed Amount</ab:VersionNumber>Tag>
               </a:CurrentVersion>                <a:DeletedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <b:Value>12.00</b:Value>
                       <a:DeletedTimestamp i:nil="true"/>          <b:Values/>
        <a:DocumentName>Receipt on CC.jpg</a:DocumentName>                <a:DocumentSize>72403</a:DocumentSize>    </b:PwsValue>
           <a:DocumentUri i:nil="true"/>                <a:LockedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <b:PwsValue>
                <a:LockedTimestamp i:nil="true"/>                <a<b:MimeType>imageColumnType>V</jpeg</a:MimeType>b:ColumnType>
                                 <a<b:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">Tag>Disbursed Currency Code</b:Tag>
                                 <b:UserDisplayName>Bruce Wayne<Value>CAD</b:UserDisplayName>Value>
                     <b:UserId i:nil="true"/>           <b:Values/>
       <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>                   <b:UserUid>1152921504606950320</b:UserUid>    </b:PwsValue>
           </a:ModifiedByUserIdentity>                <a:ModifiedTimestamp>2018-03-19T14:42:05.167Z<</a:ModifiedTimestamp>
Values>
              <a:SupportPreviewFlag>true</a:SupportPreviewFlag>          </a:Data>
     <a:SupportThumbnailFlag>true</a:SupportThumbnailFlag>                <a</a:DocumentData>PwsDocumentDataItems>
                  <a</a:DataItems>
                     <a:PwsDocumentDataItems>DocumentDataDetail>
                        <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">

                          <b:ItemId i:nil="true"/>
                           <b:ItemType>CCD<ItemType>ED</b:ItemType>
                           <b:ItemUid>1152921504614018558<ItemUid>1152921504607636703</b:ItemUid>
                           <b:ReferenceType i:nil="true"/>
                     </a:AssociatedItemIdentity>
                       </a:AssociatedItemIdentity><a:Associations>
                        <a:Data>PwsDocumentAssociation>
                           <a:ValuesAssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:PwsValue>
 ItemId i:nil="true"/>
                               <b:ColumnType>V<ItemType>CCD</b:ColumnType>ItemType>
                                 <b:Tag>Type<ItemUid>1152921504614018558</b:Tag>ItemUid>
                              <b:ReferenceType i:nil="true"/>
                              <b:Value>CostCard</b:Value></a:AssociatedItemIdentity>
                                 <b:Values<a:ReferenceNumber i:nil="true"/>
                           <a:ReferenceNumberClearFlag>false</a:ReferenceNumberClearFlag>
    </b:PwsValue>                    </a:PwsDocumentAssociation>
          <b:PwsValue>           </a:Associations>
                     <a:Notes <b:ColumnType>D</b:ColumnType>i:nil="true"/>
                  </a:DocumentDataDetail>
                <b:Tag>Incurred Date</b:Tag></a:DocumentData>
               <a:EditDeleteFlag>true</a:EditDeleteFlag>
               <a:NumberPages  <b:Value>Mar  1 2018</b:Value>i:nil="true"/>
               <a:ArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <b<a:ValuesEditDeletePermissionFlag>true</>a:EditDeletePermissionFlag>
                <a:ReceiptLockedFlag>false</a:ReceiptLockedFlag>
             </ba:PwsValue>Document>
         </PwsGetDocumentDetailsResult>
      </PwsGetDocumentDetailsResponse>
   </s:Body>
  </s:Envelope>
Code Block
languagexml
titleExample 02 - Receipt on an expense report
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
      <b:PwsValue><s:Body>
      <PwsGetDocumentDetailsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetDocumentDetailsResult                <b:ColumnType>V</b:ColumnType>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/"/>
                  <b:Tag>Expense Type</b:Tag>
    <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
              <b:Value>Personal Auto Mileage</b:Value><ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-19T19:03:25.1413351Z</ServerTimestampUtc>
            <a:Document>
               <DocumentRefId     <b:Valuesi:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                              </b:PwsValue><DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607655227</DocumentRefUid>
                   <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
          <b:PwsValue>        <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
    <b:ColumnType>M</b:ColumnType>              <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                   <b:Tag>Disbursed Amount<UserUid>1152921504606950320</b:Tag>UserUid>
               </a:CreatedByUserIdentity>
                 <b:Value>12.00</b:Value>
     <a:CreatedTimestamp>2018-03-19T14:44:09.65Z</a:CreatedTimestamp>
               <a:CurrentVersion>
           <b:Values/>       <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     </b:PwsValue><DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607659450</DocumentVersionUid>
                    <a:Comments i:nil="true"/>
         <b:PwsValue>         <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                       <b:ColumnType>V<UserDisplayName>Bruce Wayne</b:ColumnType>
 UserDisplayName>
                               <b:Tag>Disbursed Currency Code</b:Tag>UserId i:nil="true"/>
                         <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
       <b:Value>CAD</b:Value>              <b:UserUid>1152921504606950320</b:UserUid>
                   <b:Values/></a:CreatedByUserIdentity>
                  <a:CreatedTimestamp>2018-03-19T14:44:09.65Z</a:CreatedTimestamp>
           </b:PwsValue>       <a:DocumentArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <<a:VersionNumber>1</a:Values>VersionNumber>
               </a:CurrentVersion>
        </a:Data>       <a:DeletedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            </a:PwsDocumentDataItems>
   <a:DeletedTimestamp i:nil="true"/>
               <a:DocumentName>Receipt on <ER.jpg</a:DataItems>
:DocumentName>
                 <a:DocumentDataDetail>
     :DocumentSize>24380</a:DocumentSize>
               <a:AssociatedItemIdentityDocumentUri xmlnsi:bnil="http://projectorpsa.com/DataContracts/Shared/Common/"true"/>
                        <b:ItemId<a:LockedByUserIdentity i:nil="true"/>
     xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                   <b:ItemType>ED</b:ItemType><a:LockedTimestamp i:nil="true"/>
               <a:MimeType>image/jpeg</a:MimeType>
        <b:ItemUid>1152921504607636703</b:ItemUid>            <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
            <b:ReferenceType i:nil="true"/>      <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
              </a:AssociatedItemIdentity>    <b:UserId i:nil="true"/>
                <a:Associations>  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
   <a:PwsDocumentAssociation>            </a:ModifiedByUserIdentity>
               <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">ModifiedTimestamp>2018-03-19T14:44:09.65Z</a:ModifiedTimestamp>
               <a:SupportPreviewFlag>true</a:SupportPreviewFlag>
              <b:ItemId i:nil="true"/><a:SupportThumbnailFlag>true</a:SupportThumbnailFlag>
               <a:DocumentData>
                  <b<a:ItemType>CCD</b:ItemType>DataItems/>
                  <a:DocumentDataDetail>
                      <b:ItemUid>1152921504614018558</b:ItemUid>
  <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ReferenceTypeItemId i:nil="true"/>
                           </a:AssociatedItemIdentity><b:ItemType>ED</b:ItemType>
                           <a:ReferenceNumber i:nil="true"/><b:ItemUid>1152921504607636703</b:ItemUid>
                           <a:ReferenceNumberClearFlag>false</a:ReferenceNumberClearFlag>
<b:ReferenceType i:nil="true"/>
                       </a:PwsDocumentAssociation>AssociatedItemIdentity>
                     </a:Associations><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>

Common Errors and Warnings

...