Exigo Web Services API v2018.11.7.5

PlaceBinaryNode

Inserts/Moves a customer within the Binary Tree.

Input Properties

PlaceBinaryNodeRequest
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
ToParentIDInt32Unique numeric identifier for transfer to customer record.
PlacementType BinaryPlacementType
ReasonStringOptional.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
ToParentKeyStringOptional. Unique alpha numeric identifier for transfer to customer record. Exeption will occur if ToParentID & ToParentKey are provided.

Output Properties

PlaceBinaryNodeResponse
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/PlaceBinaryNode"

<?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> <PlaceBinaryNodeRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <ToParentID>int</ToParentID> <PlacementType>StrategicPlacement or BuildLeft or BuildRight or BalancedBuild or EvenFill or WeakLeg or EnrollerPreference or LeftEvenFill or RightEvenFill or LesserVolumeLeg or LesserVolumeLegOutside or StrongLegOutside or LesserVolumeLegEvenFill or GreaterVolumeLegEvenFill or InsertRightMoveDownline or InsertLeftMoveDownline or BuildTeamLeg</PlacementType> <Reason>string</Reason> <CustomerKey>string</CustomerKey> <ToParentKey>string</ToParentKey> </PlaceBinaryNodeRequest> </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> <PlaceBinaryNodeResult 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

    PlaceBinaryNodeRequest req = new PlaceBinaryNodeRequest();

 

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.ToParentID = 1;             //Unique numeric identifier for transfer to customer record.

    req.PlacementType = BinaryPlacementType.StrategicPlacement;

    req.Reason = "1";

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

    req.ToParentKey = "1";          //Unique alpha numeric identifier for transfer to customer record. Exeption will occur if ToParentID & ToParentKey are provided.

 

    //Send Request to Server and Get Response

    PlaceBinaryNodeResponse res = api.PlaceBinaryNode(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 PlaceBinaryNodeRequest()

 

    req.CustomerID = 1

    req.ToParentID = 1

    req.PlacementType = BinaryPlacementType.StrategicPlacement

    req.Reason = "1"

    req.CustomerKey = "1"

    req.ToParentKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As PlaceBinaryNodeResponse = api.PlaceBinaryNode(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->CustomerID = 1;

    $req->ToParentID = 1;

    $req->PlacementType = 1;

    $req->Reason = "1";

    $req->CustomerKey = "1";

    $req->ToParentKey = "1";

 

    //Send Request to Server and Get Response

    $res = $api.PlaceBinaryNode($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

    PlaceBinaryNodeRequest req = new PlaceBinaryNodeRequest();

 

    req.setCustomerID(1);

    req.setToParentID(1);

    req.setPlacementType(1);

    req.setReason("1");

    req.setCustomerKey("1");

    req.setToParentKey("1");

 

    //Send Request to Server and Get Response

    PlaceBinaryNodeResponse res = api.getExigoApiSoap().placeBinaryNode(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.