AddApplicationData

Description

The AddApplicationData method links the integrated software to the security token within the EBizCharge Platform.

Syntax

ApplicationDataResponse AddApplicationData(SecurityToken securityToken, string applicationId, string lookupKey, string base64String)

Arguments

Type	Name	Req.	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
string	applicationId	R	Unique ID tied to the integrated software and`securityToken` assigned by EBizCharge.
string	lookupKey	R	User defined key. Note: This can only be assigned once.
string	base64String	R	User defined `lookupKey` encoded into a base-64 string. Note: This can only be assigned once.

Return Value

Type	Description
ApplicationDataResponse	Indicates whether the ApplicationData was added successfully. If successful, the response includes the assigned `ApplicationDataInternalId`. Otherwise, returns error information.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:AddApplicationData>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-55ee-434c-b126-********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:applicationId>********-55ee-434c-b126-********</ebiz:applicationId>
         <ebiz:lookupKey>****abc****</ebiz:lookupKey>
         <ebiz:base64String>***********324-4110551111>***********</ebiz:base64String>
      </ebiz:AddApplicationData>
   </soapenv:Body>
</soapenv:Envelope>

public void AddApplicationData()
{
  eBizService apiClient = new eBizService();
  SecurityToken securityToken = new SecurityToken
  {
    SecurityId = "*******-c870-41b8-aa5c-********",
    UserId = "",
    Password = ""
  };
  var applicationId = "********-c2d7-4c37-80c7-********";
  var lookupKey = "***abc****";
  var base64String = "****dfhkjdfhkj*****"; //Base64  encoded string
  var response = apiClient.AddApplicationData(securityToken,applicationId,lookupKey,base64String);
  Console.WriteLine(response.Status);
  Console.WriteLine(response.StatusCode);
  Console.WriteLine(response.Error);
  Console.WriteLine(response.ErrorCode);
  Console.ReadLine();
}

public function AddApplicationData()
{
    $client = new SoapClient('End point URL');
    $securityToken = array(
        'SecurityId' => '******-454757-4567457-********',
        'UserId' => 'merchant1',
        'Password' => 'merchant1'
    );
    $response = $this->soapClient->AddApplicationData(array(
        'securityToken' => $securityToken,
        'applicationId' => '********fhkdj-4354-fhkhf******',
        'lookupKey' => '****-4354-4354-3454',
        'base64String' => '*********555555555********',
    ));
    $result = $response->AddApplicationDataResult;
}

Example Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <AddApplicationDataResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <AddApplicationDataResult>
            <ApplicationDataInternalId>***********-4a09-bce3->***********-</ApplicationDataInternalId>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </AddApplicationDataResult>
      </AddApplicationDataResponse>
   </s:Body>
</s:Envelope>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <AddApplicationDataResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <AddApplicationDataResult>
            <Status>Error</Status>
            <StatusCode>0</StatusCode>
            <Error>Invalid applicationId</Error>
            <ErrorCode>3</ErrorCode>
         </AddApplicationDataResult>
      </AddApplicationDataResponse>
   </s:Body>
</s:Envelope>