POST {version}/GetContactFilters

Get Contact Filters

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

None.

Response Information

Resource Description

List of Contact Filters

Collection of Filter

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
ExpressionId	globally unique identifier	None.
Description	string	None.
Internal	boolean	None.
Inactive	boolean	None.
CreatedOn	date	None.
UpdatedOn	date	None.
LastModifiedOn	date	None.
ToBeDeleted	boolean	None.
SubOptions	Collection of FilterOptionDefinitionSubOption	None.
Columns	Collection of FilterColumnAssociation	None.
DataFilter	string	None.
SortCol	string	None.
SortAsc	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "ce6e5e3b-4fd7-4eb6-b807-9aed52f1dd05",
    "Name": "sample string 2",
    "ExpressionId": "9025fbbb-a7c2-4a8b-9a85-bad6c8dabcb7",
    "Description": "sample string 3",
    "Internal": true,
    "Inactive": true,
    "CreatedOn": "04/03/2025",
    "UpdatedOn": "04/03/2025",
    "LastModifiedOn": "04/03/2025",
    "ToBeDeleted": true,
    "SubOptions": [
      {
        "Id": "f9c82c03-a373-4c4a-b8ae-460a19051e79",
        "DefId": "d1224af7-30e9-46bf-8853-5f822cab1843",
        "Type": "sample string 3",
        "Text": "sample string 4",
        "SelectedValue": "sample string 5",
        "Order": 6
      },
      {
        "Id": "f9c82c03-a373-4c4a-b8ae-460a19051e79",
        "DefId": "d1224af7-30e9-46bf-8853-5f822cab1843",
        "Type": "sample string 3",
        "Text": "sample string 4",
        "SelectedValue": "sample string 5",
        "Order": 6
      }
    ],
    "Columns": [
      {
        "Id": "7b527d5b-1b9a-4d25-8f25-24b34bc3359d",
        "FilterId": "50e20f9b-8f19-4ba8-affc-7149c01758db",
        "ColumnId": "1cd378f9-4e93-4b49-a9ef-460260cfee13",
        "Order": 4,
        "DynamicId": "sample string 5"
      },
      {
        "Id": "7b527d5b-1b9a-4d25-8f25-24b34bc3359d",
        "FilterId": "50e20f9b-8f19-4ba8-affc-7149c01758db",
        "ColumnId": "1cd378f9-4e93-4b49-a9ef-460260cfee13",
        "Order": 4,
        "DynamicId": "sample string 5"
      }
    ],
    "DataFilter": "sample string 8",
    "SortCol": "sample string 9",
    "SortAsc": true
  },
  {
    "Id": "ce6e5e3b-4fd7-4eb6-b807-9aed52f1dd05",
    "Name": "sample string 2",
    "ExpressionId": "9025fbbb-a7c2-4a8b-9a85-bad6c8dabcb7",
    "Description": "sample string 3",
    "Internal": true,
    "Inactive": true,
    "CreatedOn": "04/03/2025",
    "UpdatedOn": "04/03/2025",
    "LastModifiedOn": "04/03/2025",
    "ToBeDeleted": true,
    "SubOptions": [
      {
        "Id": "f9c82c03-a373-4c4a-b8ae-460a19051e79",
        "DefId": "d1224af7-30e9-46bf-8853-5f822cab1843",
        "Type": "sample string 3",
        "Text": "sample string 4",
        "SelectedValue": "sample string 5",
        "Order": 6
      },
      {
        "Id": "f9c82c03-a373-4c4a-b8ae-460a19051e79",
        "DefId": "d1224af7-30e9-46bf-8853-5f822cab1843",
        "Type": "sample string 3",
        "Text": "sample string 4",
        "SelectedValue": "sample string 5",
        "Order": 6
      }
    ],
    "Columns": [
      {
        "Id": "7b527d5b-1b9a-4d25-8f25-24b34bc3359d",
        "FilterId": "50e20f9b-8f19-4ba8-affc-7149c01758db",
        "ColumnId": "1cd378f9-4e93-4b49-a9ef-460260cfee13",
        "Order": 4,
        "DynamicId": "sample string 5"
      },
      {
        "Id": "7b527d5b-1b9a-4d25-8f25-24b34bc3359d",
        "FilterId": "50e20f9b-8f19-4ba8-affc-7149c01758db",
        "ColumnId": "1cd378f9-4e93-4b49-a9ef-460260cfee13",
        "Order": 4,
        "DynamicId": "sample string 5"
      }
    ],
    "DataFilter": "sample string 8",
    "SortCol": "sample string 9",
    "SortAsc": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact">
  <Filter>
    <Columns>
      <FilterColumnAssociation>
        <ColumnId>1cd378f9-4e93-4b49-a9ef-460260cfee13</ColumnId>
        <DynamicId>sample string 5</DynamicId>
        <FilterId>50e20f9b-8f19-4ba8-affc-7149c01758db</FilterId>
        <Id>7b527d5b-1b9a-4d25-8f25-24b34bc3359d</Id>
        <Order>4</Order>
      </FilterColumnAssociation>
      <FilterColumnAssociation>
        <ColumnId>1cd378f9-4e93-4b49-a9ef-460260cfee13</ColumnId>
        <DynamicId>sample string 5</DynamicId>
        <FilterId>50e20f9b-8f19-4ba8-affc-7149c01758db</FilterId>
        <Id>7b527d5b-1b9a-4d25-8f25-24b34bc3359d</Id>
        <Order>4</Order>
      </FilterColumnAssociation>
    </Columns>
    <CreatedOn>2025-04-03T05:00:48.2691805-04:00</CreatedOn>
    <DataFilter>sample string 8</DataFilter>
    <Description>sample string 3</Description>
    <ExpressionId>9025fbbb-a7c2-4a8b-9a85-bad6c8dabcb7</ExpressionId>
    <Id>ce6e5e3b-4fd7-4eb6-b807-9aed52f1dd05</Id>
    <Inactive>true</Inactive>
    <Internal>true</Internal>
    <Name>sample string 2</Name>
    <SortAsc>true</SortAsc>
    <SortCol>sample string 9</SortCol>
    <SubOptions>
      <FilterOptionDefinitionSubOption>
        <DefId>d1224af7-30e9-46bf-8853-5f822cab1843</DefId>
        <Id>f9c82c03-a373-4c4a-b8ae-460a19051e79</Id>
        <Order>6</Order>
        <SelectedValue>sample string 5</SelectedValue>
        <Text>sample string 4</Text>
        <Type>sample string 3</Type>
      </FilterOptionDefinitionSubOption>
      <FilterOptionDefinitionSubOption>
        <DefId>d1224af7-30e9-46bf-8853-5f822cab1843</DefId>
        <Id>f9c82c03-a373-4c4a-b8ae-460a19051e79</Id>
        <Order>6</Order>
        <SelectedValue>sample string 5</SelectedValue>
        <Text>sample string 4</Text>
        <Type>sample string 3</Type>
      </FilterOptionDefinitionSubOption>
    </SubOptions>
    <ToBeDeleted>true</ToBeDeleted>
    <UpdatedOn>2025-04-03T05:00:48.2691805-04:00</UpdatedOn>
  </Filter>
  <Filter>
    <Columns>
      <FilterColumnAssociation>
        <ColumnId>1cd378f9-4e93-4b49-a9ef-460260cfee13</ColumnId>
        <DynamicId>sample string 5</DynamicId>
        <FilterId>50e20f9b-8f19-4ba8-affc-7149c01758db</FilterId>
        <Id>7b527d5b-1b9a-4d25-8f25-24b34bc3359d</Id>
        <Order>4</Order>
      </FilterColumnAssociation>
      <FilterColumnAssociation>
        <ColumnId>1cd378f9-4e93-4b49-a9ef-460260cfee13</ColumnId>
        <DynamicId>sample string 5</DynamicId>
        <FilterId>50e20f9b-8f19-4ba8-affc-7149c01758db</FilterId>
        <Id>7b527d5b-1b9a-4d25-8f25-24b34bc3359d</Id>
        <Order>4</Order>
      </FilterColumnAssociation>
    </Columns>
    <CreatedOn>2025-04-03T05:00:48.2691805-04:00</CreatedOn>
    <DataFilter>sample string 8</DataFilter>
    <Description>sample string 3</Description>
    <ExpressionId>9025fbbb-a7c2-4a8b-9a85-bad6c8dabcb7</ExpressionId>
    <Id>ce6e5e3b-4fd7-4eb6-b807-9aed52f1dd05</Id>
    <Inactive>true</Inactive>
    <Internal>true</Internal>
    <Name>sample string 2</Name>
    <SortAsc>true</SortAsc>
    <SortCol>sample string 9</SortCol>
    <SubOptions>
      <FilterOptionDefinitionSubOption>
        <DefId>d1224af7-30e9-46bf-8853-5f822cab1843</DefId>
        <Id>f9c82c03-a373-4c4a-b8ae-460a19051e79</Id>
        <Order>6</Order>
        <SelectedValue>sample string 5</SelectedValue>
        <Text>sample string 4</Text>
        <Type>sample string 3</Type>
      </FilterOptionDefinitionSubOption>
      <FilterOptionDefinitionSubOption>
        <DefId>d1224af7-30e9-46bf-8853-5f822cab1843</DefId>
        <Id>f9c82c03-a373-4c4a-b8ae-460a19051e79</Id>
        <Order>6</Order>
        <SelectedValue>sample string 5</SelectedValue>
        <Text>sample string 4</Text>
        <Type>sample string 3</Type>
      </FilterOptionDefinitionSubOption>
    </SubOptions>
    <ToBeDeleted>true</ToBeDeleted>
    <UpdatedOn>2025-04-03T05:00:48.2691805-04:00</UpdatedOn>
  </Filter>
</ArrayOfFilter>