Versions Compared

Key

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

...

Element

Data Type

Description

Sample Data

DocumentRefId

Int32

The document ref Id is a unique identifier for a document. For internal use only.


DocumentRefUid

Int64

The document ref Uid is a unique identifier for a document.

1152921504607634579

CreatedByUserIdentity

PwsUserRef

The user that created this document. Click here for more information.


CreatedTimestamp

DateTime

The date time when this document was created

2018-02-05T20:23:46.55Z

CurrentVersion

PwsDocumentVersion

The current version of this document. Click here for more information.


DeletedByUserIdentity

PwsUserRef

The user that deleted this document. Click here for more information.


DeletedTimestamp

DateTime

The date time when this document was deleted


DocumentName

String

The name of the document

CFS poster.jpg

DocumentSize

Int64

The size of the document in bytes

92531

DocumentUri

String

The URL of the document


LockedByUserIdentity

PwsUserRef

The user that has this documented locked. Click here for more information.


LockedTimestamp

DateTime

The date time when this document was locked


MimeType

String

The file mime type of this document

image/jpeg

ModifiedByUserIdentity

PwsUserRef

The user that last modified this document. Click here for more information.


ModifiedTimestamp

DateTime

The date time when this document was modified


SupportPreviewFlag

Boolean

If set to 'true', this document can be previewed.

true

SupportThumbnailFlag

Boolean

If set to 'true', this document can support thumbnail display.

true

DocumentData

PwsDocumentDataElement

The data about the document. Click here for more information.


EditDeleteFlag

Boolean

???

true

NumberPages

Int16

The number of pages in this document

3

ArchiveIdentity

PwsDocumentArchiveRef

???


EditDeletePermissionFlag

Boolean

???

true

ReceiptLockedFlag

Boolean

Applies to a receipt document. If set to 'true', this document is locked and cannot be edited.

false


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
             <a:Document>
               <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607652810</DocumentRefUid>
               <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944261</b:UserUid>
               </a:CreatedByUserIdentity>
               <a:CreatedTimestamp>2018-03-13T17:09:19.637Z</a:CreatedTimestamp>
               <a:CurrentVersion>
                  <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607656916</DocumentVersionUid>
                  <a:Comments i:nil="true"/>
                  <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606944261</b:UserUid>
                  </a:CreatedByUserIdentity>
                  <a:CreatedTimestamp>2018-03-13T17:09:19.637Z</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>INV00088.pdf</a:DocumentName>
               <a:DocumentSize>209856</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>application/pdf</a:MimeType>
               <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944261</b:UserUid>
               </a:ModifiedByUserIdentity>
               <a:ModifiedTimestamp>2018-03-13T17:09:19.637Z</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>I</b:ItemType>
                        <b:ItemUid>1152921504607603784</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>3</a:NumberPages>
               <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>