Exigo Web Services API v3.4.244

CreatePointTransaction

Create a transaction that adjusts or redeems points from a customer's point account.

Input Properties

CreatePointTransactionRequest
PropertyData TypeNotes
PointAccountID Int32
CustomerIDInt32Unique identifier for a customer entity.
AmountDecimalThe amount to apply to the point account. A positive amount will add points while a negative amount will subtract points from the account.
ReferenceStringOptional.
TransactionType PointTransactionTypeThe type of point transaction. This property is for logging purposes only and has no bearing on how the points are applied to the point account.

Output Properties

CreatePointTransactionResponse
PropertyData TypeNotes

SOAP Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/CreatePointTransaction"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <CreatePointTransactionRequest xmlns="http://api.exigo.com/"> <PointAccountID>int</PointAccountID> <CustomerID>int</CustomerID> <Amount>decimal</Amount> <Reference>string</Reference> <TransactionType>Redemption or Adjustment</TransactionType> </CreatePointTransactionRequest> </soap:Body> </soap:Envelope>

SOAP Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CreatePointTransactionResult xmlns="http://api.exigo.com/" /> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    CreatePointTransactionRequest req = new CreatePointTransactionRequest();

 

    req.PointAccountID = 1;

    req.CustomerID = 1;             //Unique identifier for a customer entity.

    req.Amount = 1;                 //The amount to apply to the point account. A positive amount will add points while a negative amount will subtract points from the account.

    req.Reference = "1";

    req.TransactionType = PointTransactionType.Redemption;        //The type of point transaction. This property is for logging purposes only and has no bearing on how the points are applied to the point account.

 

    //Send Request to Server and Get Response

    CreatePointTransactionResponse res = api.CreatePointTransaction(req);

 

    //Now examine the results:

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new CreatePointTransactionRequest()

 

    req.PointAccountID = 1

    req.CustomerID = 1

    req.Amount = 1

    req.Reference = "1"

    req.TransactionType = PointTransactionType.Redemption

 

    'Send Request to Server and Get Response

    Dim res As CreatePointTransactionResponse = api.CreatePointTransaction(req)

 

    'Now examine the results:

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->PointAccountID = 1;

    $req->CustomerID = 1;

    $req->Amount = 1;

    $req->Reference = "1";

    $req->TransactionType = 1;

 

    //Send Request to Server and Get Response

    $res = $api.CreatePointTransaction($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    CreatePointTransactionRequest req = new CreatePointTransactionRequest();

 

    req.setPointAccountID(1);

    req.setCustomerID(1);

    req.setAmount(1);

    req.setReference("1");

    req.setTransactionType(1);

 

    //Send Request to Server and Get Response

    CreatePointTransactionResponse res = api.getExigoApiSoap().createPointTransaction(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.