Transfer_Data API

Usage

Transfers the staging table data to the destination table in Planful based on the rule code.

Use the Transfer_Data call to load the staging data to the destination tables in Planful. Upon invocation, the Web Service accepts the rule code and transfers the data available in the staging table for the rule code to the corresponding destination table and returns an operation result object, which contains the status and status message of the operation. The Client application can then use methods on the operation result objects and retrieve information. The Client application must be logged in with sufficient access rights to transfer the staging data to the destination tables.

Request

Shell Syntax

OperationResult = api.Transfer_Data(String RuleCode)

XML

<?xml version='1.0' encoding='UTF-8'?>
<ns1:Envelope xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/">
  <ns1:Body>
	<ns2:TransferDataWithLogin xmlns:ns2="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
      <ns2:LoginName>profracholdingsiillc_api@planful.com</ns2:LoginName>
      <ns2:Password>HaBoomi1!</ns2:Password>
      <ns2:TenantCode>SF233986CFL</ns2:TenantCode>
  	<ns2:Rule>WS - Transaction Detail</ns2:Rule>
	</ns2:TransferDataWithLogin>
  </ns1:Body>
</ns1:Envelope>

Arguments List

The following table provides a list of arguments that are required for the Transfer_Data method

call:

Response

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

Shell Syntax

Private Sub TransferData()
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.Transfer_Data("WS - Loading Accounts")
		Console.WriteLine(objResult.message)
		Console.ReadLine()
Catch ex As Exception
End Try
End Sub

XML

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
		<TransferDataWithLoginResponse xmlns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
  <TransferDataWithLoginResult>
    <Success>true</Success>
    <message>Transfer data request submitted. Email notification will be sent after successfull of transfer data.</message>
  </TransferDataWithLoginResult>
</TransferDataWithLoginResponse>
 </soap:Body>
</soap:Envelope>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
		<TransferDataWithLoginResponse
xmlns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
		<TransferDataWithLoginResult>
			<Success>true</Success>
			<message>Data loaded successfully.</message>
		</TransferDataWithLoginResult>
	</TransferDataWithLoginResponse>
</soap:Body>
</soap:Envelope>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
		<TransferDataWithLoginResponse
xmlns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
		<TransferDataWithLoginResult>
			<Success>false</Success>
			<message>Data load failed due to exceptions. The exceptions are emailed.</message>
			<ErrorCode>Err_InvalidData or  Err_DeadLock</ErrorCode>
		</TransferDataWithLoginResult>
	    </TransferDataWithLoginResponse>
	</soap:Body>
</soap:Envelope>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
		<TransferDataWithLoginResponse
xmlns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
		<TransferDataWithLoginResult>
			<Success>false</Success>
			<message>Data load failed due to exceptions. The exceptions are emailed.</message>
		</TransferDataWithLoginResult>
	</TransferDataWithLoginResponse>
 </soap:Body>
</soap:Envelope>