MENU

📢 March Release Updates coming soon!

    Clear_Data API
    • 1 Minute to read
    • Dark
    • PDF

    Clear_Data API

    • Dark
    • PDF

    Article summary

    Usage

    Clears the staging table data based on the rule code supplied.

    Use the Clear_Data call to delete the staging data loaded into Planful. Upon invocation, the Web Service accepts the rule code, clears the data available in the staging table for the rule code, and returns an operation result object, which contains the status and status message of the operation. The Client application can then use methods for the operation result objects and retrieve information.

    Client application must be logged in with sufficient access rights to clear the staging data.

    Request 

    Shell Syntax

    OperationResult = api.Clear_Data(String RuleCode)
    Shell

    XML

    <?xml version='1.0' encoding='UTF-8'?>
    <ns1:Envelope xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/">
      <ns1:Body>
    	<ns2:ClearDataWithLogin xmlns:ns2="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
      	<ns2:LoginName> 	</ns2:LoginName>
      	<ns2:Password>	</ns2:Password>
      	<ns2:TenantCode>  </ns2:TenantCode>
      	<ns2:Rule>   </ns2:Rule>
    	</ns2:ClearDataWithLogin>
      </ns1:Body>
    </ns1:Envelope>
    Markup

    Arguments List

    The following table provides a list of arguments that are required for the Clear_Data method call:

    NameType

    Description

    RuleCode

    String

    The name of the rule that is configured in the Data Load Rules of the Planful application.

    Response

    The Clear_Data method call returns the OperationResult object which contains status and the status message of the Clear_Data method call.

    Shell

    Private Sub ClearData()
    Dim api As New HostAPI()
    Dim strRuleCode As String ="", objResult As OperationResult
    Try
    		objResult = New OperationResult
    'Call the web method with the rule code created in Planful
    		ojbResult = api.Clear_Data("WS - Loading Accounts")
    		Console.WriteLine(objResult.message)
    		Console.ReadLine()
    Catch ex As Exception
    End Try
    End Sub
    Shell

    XML

    <ClearDataWithLoginResponse xmlns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
       <ClearDataWithLoginResult>
         <Success>true</Success>
         <message>Data clearing successfully.</message>
       </ClearDataWithLoginResult>
     </ClearDataWithLoginResponse>
    Markup

    Was this article helpful?