DeletePurchases


 

Overview

Quick Links

Deletes a set of Purchases from the system.


Resource Information



Request FormatXML
Response FormatXML

Request Header

NameTypeDescription
StringStringAuthentication Token

Request Body

NameTypeDescription
reason
StringThe reason for the deletion
purchaseReferences
List of StringsList of purchase references for purchases that should be deleted

Response

NameTypeDescription
ResultBulkDeleteResult
A complex type containing a list of errors and a list of purchaseReferences marked for deletion. The errors will consist of a description, an error, and the purchaseReference to which it pertains.
ResultCodeStringString indicating the result. Either "Success" or "Error".
ResultMessageStringEmpty when call successful, error message otherwise.

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Header xmlns:s="System"><s:String>4f370cf7-00cd-45f0-9a5f-1de05550fb20</s:String></Header>
  <Body>
    <DeletePurchases xmlns="api.billing.inter8.V1_3_2">
      <reason>Reason for deletion</reason>
      <purchaseReferences xmlns:s="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <s:string>PR1</s:string>
        <s:string>PR2</s:string>
      </purchaseReferences>
    </DeletePurchases>
  </Body>
</Envelope>

Response


<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <DeletePurchasesResponse xmlns="api.billing.inter8.V1_3_2">
      <DeletePurchasesResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_3_2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Result>
          <a:Errors>
            <a:BulkDeleteError>
              <a:Description>Purchase with reference PR1 was not found.</a:Description>
              <a:Error>ReferenceNotFound</a:Error>
              <a:Reference>PR1</a:Reference>
            </a:BulkDeleteError>
          </a:Errors>
          <a:MarkedDelete xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <b:string>PR2</b:string>
          </a:MarkedDelete>
        </a:Result>
        <a:ResultCode>Success</a:ResultCode>
        <a:ResultMessage/>
      </DeletePurchasesResult>
    </DeletePurchasesResponse>
  </s:Body>
</s:Envelope>