Exigo Web Services API v2024.9.6.6

 Search

GetFilterGroup

Gets a filter group. Filtering MUST be enabled first.

Input Properties

GetFilterGroupRequest
PropertyData TypeNotes
DestinationIDInt32
FilterGroupsTableGroupID[]
TableGroupID
PropertyData TypeNotes

Output Properties

GetFilterGroupResponse
PropertyData TypeNotes
FilterGroupsFilterGroup[]
FilterGroup
PropertyData TypeNotes
TableGroupIdInt32
EnabledBoolean
TrueUpBoolean
TablesTableName[]
TableFilterSettingsTableFilterSetting[]
TableName
PropertyData TypeNotes
SchemaNameString
NameString
TableFilterSetting
PropertyData TypeNotes
SchemaNameString
TableNameString
ColumnNameString
FilterType FilterType
FilterValueString
IsKeyBoolean

Http Request

GET https://yourcompany-api.exigo.com/3.0/filtergroupAuthorization: Basic base64Encoded

Http Response

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


{
  "filterGroups": 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: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetFilterGroup"

<?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>
    <GetFilterGroupRequest xmlns="http://api.exigo.com/">
      <DestinationID>int</DestinationID>
      <FilterGroups>
        <TableGroupID>Misc or AutoOrder or Core or Commission or Customer or CustomersExtended or Item or Log or Messaging or Order or Payout or Tree or User or Image</TableGroupID>
      </FilterGroups>
    </GetFilterGroupRequest>
  </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>
    <GetFilterGroupResult xmlns="http://api.exigo.com/">
      <FilterGroups>
        <FilterGroup>
          <TableGroupId>int</TableGroupId>
          <Enabled>boolean</Enabled>
          <TrueUp>boolean</TrueUp>
          <Tables>
            <TableName>
              <SchemaName>string</SchemaName>
              <Name>string</Name>
            </TableName>
          </Tables>
          <TableFilterSettings>
            <TableFilterSetting>
              <SchemaName>string</SchemaName>
              <TableName>string</TableName>
              <ColumnName>string</ColumnName>
              <FilterType>MaxDays or InList</FilterType>
              <FilterValue>string</FilterValue>
              <IsKey>boolean</IsKey>
            </TableFilterSetting>
          </TableFilterSettings>
        </FilterGroup>
      </FilterGroups>
    </GetFilterGroupResult>
  </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 GetFilterGroupRequest();

 

 

    //Send Request to Server and Get Response

    var res = await api.GetFilterGroupAsync(req);

 

    //Now examine the results:

 

    foreach (var filterGroup in res.FilterGroups)

    {

        Console.WriteLine("TableGroupId: {0}", filterGroup.TableGroupId);

        Console.WriteLine("Enabled: {0}", filterGroup.Enabled);

        Console.WriteLine("TrueUp: {0}", filterGroup.TrueUp);

 

        foreach (var tableName in filterGroup.Tables)

        {

            Console.WriteLine("SchemaName: {0}", tableName.SchemaName);

            Console.WriteLine("Name: {0}", tableName.Name);

        }

 

        foreach (var tableFilterSetting in filterGroup.TableFilterSettings)

        {

            Console.WriteLine("SchemaName: {0}", tableFilterSetting.SchemaName);

            Console.WriteLine("TableName: {0}", tableFilterSetting.TableName);

            Console.WriteLine("ColumnName: {0}", tableFilterSetting.ColumnName);

            Console.WriteLine("FilterType: {0}", tableFilterSetting.FilterType);

            Console.WriteLine("FilterValue: {0}", tableFilterSetting.FilterValue);

            Console.WriteLine("IsKey: {0}", tableFilterSetting.IsKey);

        }

    }

}

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

    GetFilterGroupRequest req = new GetFilterGroupRequest();

 

 

    //Send Request to Server and Get Response

    GetFilterGroupResponse res = api.GetFilterGroup(req);

 

    //Now examine the results:

 

    foreach (FilterGroup filterGroup in res.FilterGroups)

    {

        Console.WriteLine("TableGroupId: {0}", filterGroup.TableGroupId);

        Console.WriteLine("Enabled: {0}", filterGroup.Enabled);

        Console.WriteLine("TrueUp: {0}", filterGroup.TrueUp);

 

        foreach (TableName tableName in filterGroup.Tables)

        {

            Console.WriteLine("SchemaName: {0}", tableName.SchemaName);

            Console.WriteLine("Name: {0}", tableName.Name);

        }

 

        foreach (TableFilterSetting tableFilterSetting in filterGroup.TableFilterSettings)

        {

            Console.WriteLine("SchemaName: {0}", tableFilterSetting.SchemaName);

            Console.WriteLine("TableName: {0}", tableFilterSetting.TableName);

            Console.WriteLine("ColumnName: {0}", tableFilterSetting.ColumnName);

            Console.WriteLine("FilterType: {0}", tableFilterSetting.FilterType);

            Console.WriteLine("FilterValue: {0}", tableFilterSetting.FilterValue);

            Console.WriteLine("IsKey: {0}", tableFilterSetting.IsKey);

        }

    }

}

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 GetFilterGroupRequest()

 

 

    'Send Request to Server and Get Response

    Dim res As GetFilterGroupResponse = api.GetFilterGroup(req)

 

    'Now examine the results:

 

    For Each filterGroup As FilterGroup In res.FilterGroups

        Console.WriteLine("TableGroupId: {0}", filterGroup.TableGroupId)

        Console.WriteLine("Enabled: {0}", filterGroup.Enabled)

        Console.WriteLine("TrueUp: {0}", filterGroup.TrueUp)

 

        For Each tableName As TableName In filterGroup.Tables

            Console.WriteLine("SchemaName: {0}", tableName.SchemaName)

            Console.WriteLine("Name: {0}", tableName.Name)

        Next

 

        For Each tableFilterSetting As TableFilterSetting In filterGroup.TableFilterSettings

            Console.WriteLine("SchemaName: {0}", tableFilterSetting.SchemaName)

            Console.WriteLine("TableName: {0}", tableFilterSetting.TableName)

            Console.WriteLine("ColumnName: {0}", tableFilterSetting.ColumnName)

            Console.WriteLine("FilterType: {0}", tableFilterSetting.FilterType)

            Console.WriteLine("FilterValue: {0}", tableFilterSetting.FilterValue)

            Console.WriteLine("IsKey: {0}", tableFilterSetting.IsKey)

        Next

    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

 

 

    //Send Request to Server and Get Response

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

    GetFilterGroupRequest req = new GetFilterGroupRequest();

 

 

    //Send Request to Server and Get Response

    GetFilterGroupResponse res = api.getExigoApiSoap().getFilterGroup(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.