Overview

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

Request Format

PwsDeleteVendor Request

PwsDeleteVendor
- serviceRequest: PwsDeleteVendorRq
  - RequestId: Int32
  - SessionTicket: String
  - InactivateIfInuseFlag: Boolean
  - VendorIdentity: PwsVendorRef

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.	1
SessionTicket	String	Yes		Click here for more information.	AaNO7kKwfPfmXiw5wd7KdQ==
InactivateIfInuseFlag	Boolean	No	false	If set to 'true', a vendor that cannot be deleted because it is in use will be set to inactive, otherwise the request will fail	true
VendorIdentity	PwsVendorRef	Yes		The identity of the vendor to be deleted

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:PwsDeleteVendor>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AaNO7kKwfPfmXiw5wd7KdQ==</req:SessionTicket>
            <req:InactivateIfInuseFlag>true</req:InactivateIfInuseFlag>
            <req:VendorIdentity>
               <com:VendorName>Vendor 01</com:VendorName>
               <com:VendorNumber>V01</com:VendorNumber>
            </req:VendorIdentity>
         </pws:serviceRequest>
      </pws:PwsDeleteVendor>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteVendor Response

PwsDeleteVendorResponse
- PwsDeleteVendorResult: PwsDeleteVendorRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - VendorIdentity: PwsVendorRef

Response Elements

Element	Data Type	Description
Messages	PwsMessage	The web service response status and message. Click here for more information
ResponseId	Int32	Click here for more information
Status	RequestStatus	Click here for more information
ServerTimestampUtc	DateTime	Click here for more information
VendorIdentity	PwsVendorRef	The identity of the deleted vendor

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteVendorResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteVendorResult 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-03-06T14:12:01.9936315Z</ServerTimestampUtc>
            <a:VendorIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:VendorId i:nil="true"/>
               <b:VendorName>Vendor 01</b:VendorName>
               <b:VendorUid>1152921504607055890</b:VendorUid>
               <b:VendorNumber>V01</b:VendorNumber>
            </a:VendorIdentity>
         </PwsDeleteVendorResult>
      </PwsDeleteVendorResponse>
   </s:Body>
</s:Envelope>

PwsDeleteVendor - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
101	ClientInactivated	The client could not be deleted and instead it was marked inactive