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

Overview


This web service deletes a specified resource (PwsResourceRef). The service will return the identity of the resource that was deleted.

Request Format


PwsDeleteResourceRq
  • PwsDeleteResourceRq

Request Elements


Element

Data Type

Required?

Default

Description

RequestId

Int32

No


Click here for more information

SessionTicket

String

Yes

Click here for more information

Click here for more information

PurgeFutureResourceHistoryFlag

Boolean

No

false

If set to true, the resource's history record will be purged from the database

ResourceIdentity

PwsResourceRef

Yes


The unique key fields associated with identifying a resource

ResourceTimestamp

String

No


This is a Base64 encoded timestamp optionally utilized for resource locking

TerminationDateIfInUse

DateTime

No


The termination date of the resource

Request Usage Example(s)


Example 01
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDeleteResource>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWeOOZxrFCHSwxj9X5YBug==</req:SessionTicket>
            <req:PurgeFutureResourceHistoryFlag>true</req:PurgeFutureResourceHistoryFlag>
            <req:ResourceIdentity>
               <com:ResourceReferenceSystemId>temporary_resource</com:ResourceReferenceSystemId>
            </req:ResourceIdentity>
            <!--req:ResourceTimestamp>?</req:ResourceTimestamp-->
            <!--req:TerminationDateIfInUse>?</req:TerminationDateIfInUse-->
         </pws:serviceRequest>
      </pws:PwsDeleteResource>
   </soapenv:Body>
</soapenv:Envelope>


Response Format

Response Elements

Response Usage Example(s)

PwsDeleteResource - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

54059EngagementNotSpecifiedA specified engagement identity was incomplete. Each engagement identity must specify either an engagement id, and engagement uid or an engagement code.
54061EngagementNotFoundThe specified engagement does not exist.
  • No labels