Versions Compared

Key

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

Overview

This structure represents the unique key fields associated with identifying a document archive. Document archives can be identified by DocumentArchiveName or DocumentArchiveUid. When specifying a PwsDocumentArchiveRef as an input to a web service, you may specify one or both the DocumentArchiveName and/or DocumentArchiveUid. However, if you do specify both, they must both refer to the same document archive or the document archive reference will not be considered valid. When a PwsDocumentArchiveRef is returned in the response to a web service, both the DocumentArchiveName and DocumentArchiveUid will be populated, and guaranteed to refer to a single document archive.

Format

Panel
titlePwsDocumentArchiveRef
  • PwsDocumentArchiveRef
    • DocumentArchiveId: Int32
    • DocumentArchiveName: String (255)
    • DocumentArchiveUid: Int64

Elements

Element

Data Type

Description

Sample Data

DocumentArchiveId

Int32

 

 
The document archive Uid is a unique identifier for a document archive


DocumentArchiveName

String

 

  

(255)

The document archive name is a unique identifier for a document archive

archive_20180313134130_revcorp-doc

DocumentArchiveUid

Int64

 

The document archive Uid is a unique identifier for a document archive

1152921504606847216

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
               <a:ArchiveIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:DocumentArchiveId i:nil="true"/>
                  <b:DocumentArchiveName>archive_20180313134130_revcorp-doc</b:DocumentArchiveName>
                  <b:DocumentArchiveUid>1152921504606847216</b:DocumentArchiveUid>
               </a:ArchiveIdentity>