Overview

This web service deletes a specified user (PwsUserRef). The service will return the identity of the user (PwsUserRef).

Request Format

PwsDeleteUser Request

PwsDeleteUser
- serviceRequest: PwsDeleteUserRq
  - RequestId: Int32
  - SessionTicket: String
  - EndDateIfInUse: DateTime
  - UserIdentity: PwsUserRef
  - UserTimestamp: String

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.	1
SessionTicket	String	Yes	Click here for more information.	AYT2iwsWCxt78iwqu2y0/w==
EndDateIfInUse	DateTime	No	If a date is specified for EndDateIfInUse, and the user cannot be deleted because it is referenced elsewhere in the system, the user will be made inactive as of the specified date instead. If no date is specified here and the user could not be deleted, the request will simply fail.	2018-10-17T00:00:00.000Z
UserIdentity	PwsUserRef	Yes	The identity of the user to be deleted.
UserTimestamp	String	No	This is a Base64 encoded timestamp optionally utilized for user locking.

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:PwsDeleteUser>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AYT2iwsWCxt78iwqu2y0/w==</req:SessionTicket>
            <req:EndDateIfInUse>2018-10-17T00:00:00.000Z</req:EndDateIfInUse>
            <req:UserIdentity>
               <com:UserReferenceSystemId>temporary_resource</com:UserReferenceSystemId>
            </req:UserIdentity>
         </pws:serviceRequest>
      </pws:PwsDeleteUser>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteUser Response

PwsDeleteUserResponse
- PwsDeleteUserResult: PwsDeleteUserRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Timestamp: String
  - UserIdentity: PwsUserRef

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.	1
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-10-17T18:10:14.2345021Z
Timestamp	String	This is a Base64 encoded timestamp optionally utilized for user locking. This will be populated only if the request failed or the user was made inactive instead of deleted.
UserIdentity	PwsUserRef	The unique key fields associated with identifying a user.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteUserResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteUserResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-10-17T18:10:14.2345021Z</ServerTimestampUtc>
            <a:Timestamp>AAAAABCI7Dk=</a:Timestamp>
            <a:UserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:UserDisplayName>Temporary Resource</b:UserDisplayName>
               <b:UserId i:nil="true"/>
               <b:UserReferenceSystemId>temporary_resource</b:UserReferenceSystemId>
               <b:UserUid>1152921504607134367</b:UserUid>
            </a:UserIdentity>
         </PwsDeleteUserResult>
      </PwsDeleteUserResponse>
   </s:Body>
</s:Envelope>

PwsDeleteUser - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
50024	EntityNotFound	Entity PwsUserRef was not found.
50045	ViewPermissionDenied	You do not have permission to view this item.