GetCustomerExtended
Returns extended properties setup for a customer.Input Properties
GetCustomerExtendedRequest
Output Properties
GetCustomerExtendedResponse
CustomerExtendedResponse
Http Request
GET https://yourcompany-api.exigo.com/3.0/customers/extended?extendedGroupID=1 &customerID=1 &customerKey=1 Authorization: Basic base64Encoded
Http Response
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: length{ "items": null, "result": null }
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: lifewave-api.exigo.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.exigo.com/GetCustomerExtended" <?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> <GetCustomerExtendedRequest xmlns="http://api.exigo.com/"> <ExtendedGroupID>int</ExtendedGroupID> <CustomerID>int</CustomerID> <CustomerExtendedID>int</CustomerExtendedID> <Field1>string</Field1> <Field2>string</Field2> <Field3>string</Field3> <Field4>string</Field4> <Field5>string</Field5> <Field6>string</Field6> <Field7>string</Field7> <Field8>string</Field8> <Field9>string</Field9> <Field10>string</Field10> <Field11>string</Field11> <Field12>string</Field12> <Field13>string</Field13> <Field14>string</Field14> <Field15>string</Field15> <Field16>string</Field16> <Field17>string</Field17> <Field18>string</Field18> <Field19>string</Field19> <Field20>string</Field20> <Field21>string</Field21> <Field22>string</Field22> <Field23>string</Field23> <Field24>string</Field24> <Field25>string</Field25> <Field26>string</Field26> <Field27>string</Field27> <Field28>string</Field28> <Field29>string</Field29> <Field30>string</Field30> <GreaterThanCustomerExtendedID>int</GreaterThanCustomerExtendedID> <GreaterThanModifiedDate>dateTime</GreaterThanModifiedDate> <BatchSize>int</BatchSize> <CustomerKey>string</CustomerKey> </GetCustomerExtendedRequest> </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> <GetCustomerExtendedResult xmlns="http://api.exigo.com/"> <Items> <CustomerExtendedResponse> <CustomerID>int</CustomerID> <ExtendedGroupID>int</ExtendedGroupID> <CustomerExtendedID>int</CustomerExtendedID> <Field1>string</Field1> <Field2>string</Field2> <Field3>string</Field3> <Field4>string</Field4> <Field5>string</Field5> <Field6>string</Field6> <Field7>string</Field7> <Field8>string</Field8> <Field9>string</Field9> <Field10>string</Field10> <Field11>string</Field11> <Field12>string</Field12> <Field13>string</Field13> <Field14>string</Field14> <Field15>string</Field15> <Field16>string</Field16> <Field17>string</Field17> <Field18>string</Field18> <Field19>string</Field19> <Field20>string</Field20> <Field21>string</Field21> <Field22>string</Field22> <Field23>string</Field23> <Field24>string</Field24> <Field25>string</Field25> <Field26>string</Field26> <Field27>string</Field27> <Field28>string</Field28> <Field29>string</Field29> <Field30>string</Field30> <ModifiedDate>dateTime</ModifiedDate> <CustomerKey>string</CustomerKey> </CustomerExtendedResponse> </Items> </GetCustomerExtendedResult> </soap:Body> </soap:Envelope>
C# Rest Client
Install Nuget package Exigo.Api.Client
try
{
//Create Api Client
var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");
//Create Request
var req = new GetCustomerExtendedRequest();
req.ExtendedGroupID = 1; //Unique ID of data set
req.CustomerID = 1; //Optionally supply if getting data for just one customer
req.CustomerKey = "1"; //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
//Send Request to Server and Get Response
var res = await api.GetCustomerExtendedAsync(req);
//Now examine the results:
foreach (var customerExtended in res.Items)
{
Console.WriteLine("CustomerID: {0}", customerExtended.CustomerID);
Console.WriteLine("ExtendedGroupID: {0}", customerExtended.ExtendedGroupID);
Console.WriteLine("CustomerExtendedID: {0}", customerExtended.CustomerExtendedID);
Console.WriteLine("Field16: {0}", customerExtended.Field16);
Console.WriteLine("Field17: {0}", customerExtended.Field17);
Console.WriteLine("Field18: {0}", customerExtended.Field18);
Console.WriteLine("Field19: {0}", customerExtended.Field19);
Console.WriteLine("Field20: {0}", customerExtended.Field20);
Console.WriteLine("Field21: {0}", customerExtended.Field21);
Console.WriteLine("Field22: {0}", customerExtended.Field22);
Console.WriteLine("Field23: {0}", customerExtended.Field23);
Console.WriteLine("Field24: {0}", customerExtended.Field24);
Console.WriteLine("Field25: {0}", customerExtended.Field25);
Console.WriteLine("Field26: {0}", customerExtended.Field26);
Console.WriteLine("Field27: {0}", customerExtended.Field27);
Console.WriteLine("Field28: {0}", customerExtended.Field28);
Console.WriteLine("Field29: {0}", customerExtended.Field29);
Console.WriteLine("Field30: {0}", customerExtended.Field30);
Console.WriteLine("ModifiedDate: {0}", customerExtended.ModifiedDate);
Console.WriteLine("CustomerKey: {0}", customerExtended.CustomerKey);
}
}
catch (Exception ex)
{
Console.WriteLine("Error: " + ex.Message);
}
C# Soap Client
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
GetCustomerExtendedRequest req = new GetCustomerExtendedRequest();
req.ExtendedGroupID = 1; //Unique ID of data set
req.CustomerID = 1; //Optionally supply if getting data for just one customer
req.CustomerKey = "1"; //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
//Send Request to Server and Get Response
GetCustomerExtendedResponse res = api.GetCustomerExtended(req);
//Now examine the results:
foreach (CustomerExtendedResponse customerExtended in res.Items)
{
Console.WriteLine("CustomerID: {0}", customerExtended.CustomerID);
Console.WriteLine("ExtendedGroupID: {0}", customerExtended.ExtendedGroupID);
Console.WriteLine("CustomerExtendedID: {0}", customerExtended.CustomerExtendedID);
Console.WriteLine("Field16: {0}", customerExtended.Field16);
Console.WriteLine("Field17: {0}", customerExtended.Field17);
Console.WriteLine("Field18: {0}", customerExtended.Field18);
Console.WriteLine("Field19: {0}", customerExtended.Field19);
Console.WriteLine("Field20: {0}", customerExtended.Field20);
Console.WriteLine("Field21: {0}", customerExtended.Field21);
Console.WriteLine("Field22: {0}", customerExtended.Field22);
Console.WriteLine("Field23: {0}", customerExtended.Field23);
Console.WriteLine("Field24: {0}", customerExtended.Field24);
Console.WriteLine("Field25: {0}", customerExtended.Field25);
Console.WriteLine("Field26: {0}", customerExtended.Field26);
Console.WriteLine("Field27: {0}", customerExtended.Field27);
Console.WriteLine("Field28: {0}", customerExtended.Field28);
Console.WriteLine("Field29: {0}", customerExtended.Field29);
Console.WriteLine("Field30: {0}", customerExtended.Field30);
Console.WriteLine("ModifiedDate: {0}", customerExtended.ModifiedDate);
Console.WriteLine("CustomerKey: {0}", customerExtended.CustomerKey);
}
}
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 GetCustomerExtendedRequest()
req.ExtendedGroupID = 1
req.CustomerID = 1
req.CustomerKey = "1"
'Send Request to Server and Get Response
Dim res As GetCustomerExtendedResponse = api.GetCustomerExtended(req)
'Now examine the results:
For Each customerExtended As CustomerExtendedResponse In res.Items
Console.WriteLine("CustomerID: {0}", customerExtended.CustomerID)
Console.WriteLine("ExtendedGroupID: {0}", customerExtended.ExtendedGroupID)
Console.WriteLine("CustomerExtendedID: {0}", customerExtended.CustomerExtendedID)
Console.WriteLine("Field16: {0}", customerExtended.Field16)
Console.WriteLine("Field17: {0}", customerExtended.Field17)
Console.WriteLine("Field18: {0}", customerExtended.Field18)
Console.WriteLine("Field19: {0}", customerExtended.Field19)
Console.WriteLine("Field20: {0}", customerExtended.Field20)
Console.WriteLine("Field21: {0}", customerExtended.Field21)
Console.WriteLine("Field22: {0}", customerExtended.Field22)
Console.WriteLine("Field23: {0}", customerExtended.Field23)
Console.WriteLine("Field24: {0}", customerExtended.Field24)
Console.WriteLine("Field25: {0}", customerExtended.Field25)
Console.WriteLine("Field26: {0}", customerExtended.Field26)
Console.WriteLine("Field27: {0}", customerExtended.Field27)
Console.WriteLine("Field28: {0}", customerExtended.Field28)
Console.WriteLine("Field29: {0}", customerExtended.Field29)
Console.WriteLine("Field30: {0}", customerExtended.Field30)
Console.WriteLine("ModifiedDate: {0}", customerExtended.ModifiedDate)
Console.WriteLine("CustomerKey: {0}", customerExtended.CustomerKey)
Next
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->ExtendedGroupID = 1;
$req->CustomerID = 1;
$req->CustomerKey = "1";
//Send Request to Server and Get Response
$res = $api.GetCustomerExtended($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
GetCustomerExtendedRequest req = new GetCustomerExtendedRequest();
req.setExtendedGroupID(1);
req.setCustomerID(1);
req.setCustomerKey("1");
//Send Request to Server and Get Response
GetCustomerExtendedResponse res = api.getExigoApiSoap().getCustomerExtended(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}