Overview
This web service deletes a specified vendor (PwsVendorRef). The service will return the identity of the deleted vendor (PwsClientRefPwsVendorRef).
| Info | ||
|---|---|---|
| ||
In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior. |
Request Format
| Panel | ||
|---|---|---|
| ||
|
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 | Yes |
The identity of the vendor to be deleted |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information |
ResponseId | Int32 | Click here for more information |
1 | ||
Status | Click here for more information |
Ok | ||
ServerTimestampUtc | DateTime | Click here for more information |
2018-03-06T14:12:01.9936315Z | ||
VendorIdentity | The identity of the deleted vendor |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|
| 160 |
| VendorInactivated | The |
| vendor could not be deleted and instead it was marked inactive. | ||
| 27002 | VendorNotSpecified | Vendor Not Specified |
| 59918 | VendorNotFound | Vendor not found. Another user may have deleted it. |
| 59938 | VendorDeletionFailed | Vendor could not be deleted because it exists in at least one {entity}. |