Exigo Web Services API v2022.12.19.1

 Search

GetCustomerExtended

Returns extended properties setup for a customer.

Input Properties

GetCustomerExtendedRequest
PropertyData TypeNotes
ExtendedGroupIDInt32Unique ID of data set.
CustomerIDInt32Optional. Optionally supply if getting data for just one customer.
CustomerExtendedIDInt32Optional. Optionally supply if getting a single record.
Field1StringOptional. Optionally search Field1.
Field2StringOptional. Optionally search Field2.
Field3StringOptional. Optionally search Field3.
Field4StringOptional. Optionally search Field4.
Field5StringOptional. Optionally search Field5.
Field6StringOptional. Optionally search Field6.
Field7StringOptional. Optionally search Field7.
Field8StringOptional. Optionally search Field8.
Field9StringOptional. Optionally search Field9.
Field10StringOptional. Optionally search Field10.
Field11StringOptional. Optionally search Field11.
Field12StringOptional. Optionally search Field12.
Field13StringOptional. Optionally search Field13.
Field14StringOptional. Optionally search Field14.
Field15StringOptional. Optionally search Field15.
Field16StringOptional. Optionally search Field16.
Field17StringOptional. Optionally search Field17.
Field18StringOptional. Optionally search Field18.
Field19StringOptional. Optionally search Field19.
Field20StringOptional. Optionally search Field20.
Field21StringOptional. Optionally search Field21.
Field22StringOptional. Optionally search Field22.
Field23StringOptional. Optionally search Field23.
Field24StringOptional. Optionally search Field24.
Field25StringOptional. Optionally search Field25.
Field26StringOptional. Optionally search Field26.
Field27StringOptional. Optionally search Field27.
Field28StringOptional. Optionally search Field28.
Field29StringOptional. Optionally search Field29.
Field30StringOptional. Optionally search Field30.
GreaterThanCustomerExtendedIDInt32Optional. Use when pulling data in chunks.
GreaterThanModifiedDateDateTimeOptional. Use when pulling data in chunks.
BatchSizeInt32Optional. Defaults to 100 at a time.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

GetCustomerExtendedResponse
PropertyData TypeNotes
ItemsCustomerExtendedResponse[]
CustomerExtendedResponse
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
ExtendedGroupID Int32
CustomerExtendedIDInt32
Field1 String
Field2 String
Field3 String
Field4 String
Field5 String
Field6 String
Field7 String
Field8 String
Field9 String
Field10 String
Field11 String
Field12 String
Field13 String
Field14 String
Field15 String
Field16String
Field17String
Field18String
Field19String
Field20String
Field21String
Field22String
Field23String
Field24String
Field25String
Field26String
Field27String
Field28String
Field29String
Field30String
ModifiedDateDateTime
CustomerKeyStringUnique alpha numeric identifier for customer record .

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: totallife-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());

}

CSV

This method does not support csv output.