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

Overview

This web service deletes a specified client (PwsClientRef). The service will return the identity (PwsClientRef) of the deleted client.

PwsDeleteClient
  • serviceRequest: PwsDeleteClientRq
    • RequestID: Int32
    • SessionTicket: String
    • CascadeDeleteFlag: Boolean
    • ClientIdentity: PwsClientRef [1]

Request Elements

ElementData TypeRequired?DefaultDescription
RequestIDInt32No
The caller may supply any desired value here. The value supplied will be echoed back in the response as the ResponseId.
SessionTicketStringYes
This field is required. The session ticket is generated by the web service PwsAuthenticate.
CascadeDeleteFlagBooleanNo"false"


This flag is set to "true" when the user wants to delete the client and, all of the client's children

  • If set to "false", an attempt to delete a client that has one more children will fail
  • If set to "true", and the client and all of its children can be deleted, all clients are deleted
  • If set to "true", and the InactivateIfInUseFlag is also set to true, the client and its children will be deleted if possible, otherwise they will be marked inactive. A client can be deleted if it is not in use elsewhere and all its children (if any) can be deleted. Otherwise, it must be inactivated
  • If set to "true", and the InactivateIfInUseFlag is set to false, an error is returned (because at least one client cannot be deleted, per bullet 2 above)
ClientIdentityPwsClientRef [1]

This is the identity of the client to be deleted
InactivateIfInuseFlagBooleanNo"false"If set to true, a client that cannot be deleted because it is in use will be set to inactive, otherwise the request will fail.

Usage Example(s) (Request)

Request 01 
      <PwsDeleteClient>
         <serviceRequest>
            <RequestId>1</RequestId>
            <SessionTicket>AVWN2cthcvkr13Vtxbkl4Q==</SessionTicket>
            <CascadeDeleteFlag>true</CascadeDeleteFlag>
            <ClientIdentity>
               <!--com:ClientId>?</com:ClientId-->
               <com:ClientNumber>C000117</com:ClientNumber>
               <!--com:ClientUid>?</com:ClientUid-->
            </ClientIdentity>
            <InactivateIfInuseFlag>true</InactivateIfInuseFlag>
         </serviceRequest>
      </PwsDeleteClient>


Response Format


PwsDeleteClientResponse
  • servicerequest: PwsDeleteClientRs
    • ClientID: Int32
    • ClientNumber: String
    • ClientUID: Int64


Response Elements

ElementData TypeDescription
ResponseIDInt32Echoes the supplied request ID
StatusStringStatus of the request
ServerTimestampUTCdatetimeThe request completion date and time stamp expressed in UTC (Coordinated Universal Time)
ClientIdentityPwsClientRef




  • No labels