PwsDeleteVendor
Overview
This web service deletes a specified vendor (PwsVendorRef). The service will return the identity of the deleted vendor (PwsVendorRef).
Rate Limiting
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
- PwsDeleteVendor
- serviceRequest: PwsDeleteVendorRq
- RequestId: Int32
- SessionTicket: String
- InactivateIfInuseFlag: Boolean
- VendorIdentity: PwsVendorRef
- serviceRequest: PwsDeleteVendorRq
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)
Response Format
- PwsDeleteVendorResponse
- PwsDeleteVendorResult: PwsDeleteVendorRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- VendorIdentity: PwsVendorRef
- PwsDeleteVendorResult: PwsDeleteVendorRs
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)
PwsDeleteVendor - Common Errors and Warnings
- 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}. |