GET api/clientfilters/id/{filterId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
filterId

integer

Required

Body Parameters

None.

Response Information

Resource Description

ClientFilterModel
NameDescriptionTypeAdditional information
Id

integer

None.

ClientId

integer

None.

FilterName

string

None.

Client

ClientModel

None.

ClientFilter_Detail

Collection of ClientFilterDetailModel

None.

ValidationErrors

string

None.

SaveState

enuState

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ClientId": 2,
  "FilterName": "sample string 3",
  "Client": {
    "Id": 1,
    "Name": "sample string 2",
    "Phone": "sample string 3",
    "Fax": "sample string 4",
    "Address": "sample string 5",
    "Address2": "sample string 6",
    "Address3": "sample string 7",
    "City": "sample string 8",
    "Apartment": "sample string 9",
    "State": "sample string 10",
    "Country": "sample string 11",
    "PostalCode": "sample string 12",
    "DateCreated": "2025-10-14T08:15:14.8673476+00:00",
    "ManagerId": 1,
    "Email": "sample string 14",
    "Archived": true,
    "Comments": "sample string 16",
    "Logo": "sample string 17",
    "SalesRepId": 1,
    "QuoteClient": true,
    "TotalShipments": 19,
    "ExternalRef": "sample string 20",
    "ClientIdCopy": 1,
    "TotalNotifications": 21,
    "Manager": {
      "SelectedClients": [
        1,
        2
      ],
      "ValidationErrors": "sample string 1",
      "Id": 2,
      "Username": "sample string 3",
      "Email": "sample string 4",
      "IsLocked": true,
      "DateCreated": "2025-10-14T08:15:14.8673476+00:00",
      "Name": "sample string 7",
      "IsClient": true,
      "AllClients": true,
      "RoleId": 10,
      "FilterAllClient": true,
      "FilterArchived": true,
      "EmailSignature": "sample string 13",
      "AccessQuotes": true,
      "StationID": "sample string 15",
      "LastLoginDate": "2025-10-14T08:15:14.8673476+00:00",
      "Office365": true,
      "UseEmailSignature": true,
      "StationIdList": [
        "sample string 15"
      ],
      "SelectedManagers": [
        1,
        2
      ],
      "RoleName": "sample string 18",
      "EmailPasswordSet": true,
      "UserClientAccess": [
        {
          "Id": 1,
          "UserId": 2,
          "ClientId": 3
        },
        {
          "Id": 1,
          "UserId": 2,
          "ClientId": 3
        }
      ],
      "UserManagerFilter": [
        {
          "Id": 1,
          "UserId": 2,
          "ManagerId": 3
        },
        {
          "Id": 1,
          "UserId": 2,
          "ManagerId": 3
        }
      ],
      "SaveState": 0
    },
    "ValidationErrors": "sample string 22",
    "SaveState": 0
  },
  "ClientFilter_Detail": [
    {
      "Id": 1,
      "ClientFilterId": 2,
      "ClientSettingId": 3,
      "Condition": "sample string 4",
      "Value": "sample string 5",
      "ClientSetting": {
        "Id": 1,
        "ClientId": 2,
        "FieldName": "sample string 3",
        "ColumnName": "sample string 4",
        "ColumnType": "sample string 5",
        "ColumnWidth": 6,
        "ValueList": "sample string 7",
        "OrderIdx": 8,
        "ClientHidden": true,
        "ClientEditable": true,
        "IdMasterList": 1,
        "ExtShipFieldId": 1,
        "CombineNotif": true,
        "ListOfValues": [
          "sample string 1",
          "sample string 2"
        ],
        "ListOfValuesML": [
          "sample string 1",
          "sample string 2"
        ],
        "MasterList": {
          "Id": 1,
          "Name": "sample string 2",
          "ListOfValues": [
            "sample string 1",
            "sample string 2"
          ],
          "Delete": true,
          "SaveState": 0
        },
        "State": "sample string 12",
        "ValidationErrors": "sample string 13",
        "SaveState": 0
      },
      "ValidationErrors": "sample string 6",
      "SaveState": 0
    },
    {
      "Id": 1,
      "ClientFilterId": 2,
      "ClientSettingId": 3,
      "Condition": "sample string 4",
      "Value": "sample string 5",
      "ClientSetting": {
        "Id": 1,
        "ClientId": 2,
        "FieldName": "sample string 3",
        "ColumnName": "sample string 4",
        "ColumnType": "sample string 5",
        "ColumnWidth": 6,
        "ValueList": "sample string 7",
        "OrderIdx": 8,
        "ClientHidden": true,
        "ClientEditable": true,
        "IdMasterList": 1,
        "ExtShipFieldId": 1,
        "CombineNotif": true,
        "ListOfValues": [
          "sample string 1",
          "sample string 2"
        ],
        "ListOfValuesML": [
          "sample string 1",
          "sample string 2"
        ],
        "MasterList": {
          "Id": 1,
          "Name": "sample string 2",
          "ListOfValues": [
            "sample string 1",
            "sample string 2"
          ],
          "Delete": true,
          "SaveState": 0
        },
        "State": "sample string 12",
        "ValidationErrors": "sample string 13",
        "SaveState": 0
      },
      "ValidationErrors": "sample string 6",
      "SaveState": 0
    }
  ],
  "ValidationErrors": "sample string 4",
  "SaveState": 0
}

application/xml, text/xml

Sample:
<ClientFilterModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SaveState>Unchanged</SaveState>
  <Id>1</Id>
  <ClientId>2</ClientId>
  <FilterName>sample string 3</FilterName>
  <Client>
    <SaveState>Unchanged</SaveState>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Phone>sample string 3</Phone>
    <Fax>sample string 4</Fax>
    <Address>sample string 5</Address>
    <Address2>sample string 6</Address2>
    <Address3>sample string 7</Address3>
    <City>sample string 8</City>
    <Apartment>sample string 9</Apartment>
    <State>sample string 10</State>
    <Country>sample string 11</Country>
    <PostalCode>sample string 12</PostalCode>
    <DateCreated>2025-10-14T08:15:14.8673476+00:00</DateCreated>
    <ManagerId>1</ManagerId>
    <Email>sample string 14</Email>
    <Archived>true</Archived>
    <Comments>sample string 16</Comments>
    <Logo>sample string 17</Logo>
    <SalesRepId>1</SalesRepId>
    <QuoteClient>true</QuoteClient>
    <TotalShipments>19</TotalShipments>
    <ExternalRef>sample string 20</ExternalRef>
    <ClientIdCopy>1</ClientIdCopy>
    <TotalNotifications>21</TotalNotifications>
    <Manager>
      <SaveState>Unchanged</SaveState>
      <Id>2</Id>
      <Username>sample string 3</Username>
      <Email>sample string 4</Email>
      <IsLocked>true</IsLocked>
      <DateCreated>2025-10-14T08:15:14.8673476+00:00</DateCreated>
      <Name>sample string 7</Name>
      <IsClient>true</IsClient>
      <AllClients>true</AllClients>
      <RoleId>10</RoleId>
      <FilterAllClient>true</FilterAllClient>
      <FilterArchived>true</FilterArchived>
      <EmailSignature>sample string 13</EmailSignature>
      <AccessQuotes>true</AccessQuotes>
      <StationID>sample string 15</StationID>
      <LastLoginDate>2025-10-14T08:15:14.8673476+00:00</LastLoginDate>
      <Office365>true</Office365>
      <UseEmailSignature>true</UseEmailSignature>
      <StationIdList>
        <string>sample string 15</string>
      </StationIdList>
      <SelectedManagers>
        <int>1</int>
        <int>2</int>
      </SelectedManagers>
      <RoleName>sample string 18</RoleName>
      <EmailPasswordSet>true</EmailPasswordSet>
      <UserClientAccess>
        <UserClientAccessModel>
          <Id>1</Id>
          <UserId>2</UserId>
          <ClientId>3</ClientId>
        </UserClientAccessModel>
        <UserClientAccessModel>
          <Id>1</Id>
          <UserId>2</UserId>
          <ClientId>3</ClientId>
        </UserClientAccessModel>
      </UserClientAccess>
      <UserManagerFilter>
        <UserManagerFilterModel>
          <Id>1</Id>
          <UserId>2</UserId>
          <ManagerId>3</ManagerId>
        </UserManagerFilterModel>
        <UserManagerFilterModel>
          <Id>1</Id>
          <UserId>2</UserId>
          <ManagerId>3</ManagerId>
        </UserManagerFilterModel>
      </UserManagerFilter>
      <SelectedClients>
        <int>1</int>
        <int>2</int>
      </SelectedClients>
      <ValidationErrors>sample string 1</ValidationErrors>
    </Manager>
    <ValidationErrors>sample string 22</ValidationErrors>
  </Client>
  <ClientFilter_Detail>
    <ClientFilterDetailModel>
      <SaveState>Unchanged</SaveState>
      <Id>1</Id>
      <ClientFilterId>2</ClientFilterId>
      <ClientSettingId>3</ClientSettingId>
      <Condition>sample string 4</Condition>
      <Value>sample string 5</Value>
      <ClientSetting>
        <SaveState>Unchanged</SaveState>
        <Id>1</Id>
        <ClientId>2</ClientId>
        <FieldName>sample string 3</FieldName>
        <ColumnName>sample string 4</ColumnName>
        <ColumnType>sample string 5</ColumnType>
        <ColumnWidth>6</ColumnWidth>
        <ValueList>sample string 7</ValueList>
        <OrderIdx>8</OrderIdx>
        <ClientHidden>true</ClientHidden>
        <ClientEditable>true</ClientEditable>
        <IdMasterList>1</IdMasterList>
        <ExtShipFieldId>1</ExtShipFieldId>
        <CombineNotif>true</CombineNotif>
        <ListOfValues>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </ListOfValues>
        <ListOfValuesML>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </ListOfValuesML>
        <MasterList>
          <SaveState>Unchanged</SaveState>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <ListOfValues>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </ListOfValues>
          <Delete>true</Delete>
        </MasterList>
        <State>sample string 12</State>
        <ValidationErrors>sample string 13</ValidationErrors>
      </ClientSetting>
      <ValidationErrors>sample string 6</ValidationErrors>
    </ClientFilterDetailModel>
    <ClientFilterDetailModel>
      <SaveState>Unchanged</SaveState>
      <Id>1</Id>
      <ClientFilterId>2</ClientFilterId>
      <ClientSettingId>3</ClientSettingId>
      <Condition>sample string 4</Condition>
      <Value>sample string 5</Value>
      <ClientSetting>
        <SaveState>Unchanged</SaveState>
        <Id>1</Id>
        <ClientId>2</ClientId>
        <FieldName>sample string 3</FieldName>
        <ColumnName>sample string 4</ColumnName>
        <ColumnType>sample string 5</ColumnType>
        <ColumnWidth>6</ColumnWidth>
        <ValueList>sample string 7</ValueList>
        <OrderIdx>8</OrderIdx>
        <ClientHidden>true</ClientHidden>
        <ClientEditable>true</ClientEditable>
        <IdMasterList>1</IdMasterList>
        <ExtShipFieldId>1</ExtShipFieldId>
        <CombineNotif>true</CombineNotif>
        <ListOfValues>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </ListOfValues>
        <ListOfValuesML>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </ListOfValuesML>
        <MasterList>
          <SaveState>Unchanged</SaveState>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <ListOfValues>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </ListOfValues>
          <Delete>true</Delete>
        </MasterList>
        <State>sample string 12</State>
        <ValidationErrors>sample string 13</ValidationErrors>
      </ClientSetting>
      <ValidationErrors>sample string 6</ValidationErrors>
    </ClientFilterDetailModel>
  </ClientFilter_Detail>
  <ValidationErrors>sample string 4</ValidationErrors>
</ClientFilterModel>