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 5
Next »
Overview
The web service takes identifying keys of a document (PwsDocumentRef) and returns detailed document information (PwsDocument).
- PwsGetDocumentDetails
- serviceRequest: PwsGetDocumentDetailsRq
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 |
|
Request Usage Example(s)
<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>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
<doc:DocumentIdentity>
<com:DocumentRefUid>1152921504607652810</com:DocumentRefUid>
</doc:DocumentIdentity>
</pws:serviceRequest>
</pws:PwsGetDocumentDetails>
</soapenv:Body>
</soapenv:Envelope>
- PwsGetDocumentDetailsResponse
- PwsGetDocumentDetailsResult: PwsGetDocumentDetailsRs
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 |
Status | RequestStatus | Click here for more information | Ok |
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)
<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-13T17:09:59.4421639Z</ServerTimestampUtc>
<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>
</PwsGetDocumentDetailsResult>
</PwsGetDocumentDetailsResponse>
</s:Body>
</s:Envelope>
Common Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|
21033 | DocumentRequiredForGetDocument | A document identity must be specified. |