GET API/Item/GetByFilter

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ListId	Unique Id of the list	integer	None.
SearchFor	Search title and description of an for this anywhere in it	string	None.
SearchCustomFieldId	Specifies the Field ID to search using the value in	integer	None.
SearchCustomFieldFor	Value to search for looking only at . The search can be contained anywhere in the value.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "listId": 1,
  "searchFor": "sample string 2",
  "searchCustomFieldId": 1,
  "searchCustomFieldFor": "sample string 3"
}

application/xml, text/xml

Sample:

<ListSearchFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.List">
  <ListId>1</ListId>
  <SearchCustomFieldFor>sample string 3</SearchCustomFieldFor>
  <SearchCustomFieldId>1</SearchCustomFieldId>
  <SearchFor>sample string 2</SearchFor>
</ListSearchFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Item

Name	Description	Type	Additional information
ItemId	The unique id for the item	integer	None.
ListId	The unique id of the the item belongs to	integer	None.
Title	A title to display as a summary	string	None.
Description	Detailed description	string	None.
Active	True if the item is active (equivalent of not deleted)	boolean	None.
CustomFields	The custom fields that belong to this	Collection of CustomField	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "itemId": 1,
    "listId": 2,
    "title": "sample string 3",
    "description": "sample string 4",
    "active": true,
    "customFields": [
      {
        "customFieldId": 1,
        "listId": 2,
        "itemId": 3,
        "title": "sample string 4",
        "value": "sample string 5"
      },
      {
        "customFieldId": 1,
        "listId": 2,
        "itemId": 3,
        "title": "sample string 4",
        "value": "sample string 5"
      }
    ]
  },
  {
    "itemId": 1,
    "listId": 2,
    "title": "sample string 3",
    "description": "sample string 4",
    "active": true,
    "customFields": [
      {
        "customFieldId": 1,
        "listId": 2,
        "itemId": 3,
        "title": "sample string 4",
        "value": "sample string 5"
      },
      {
        "customFieldId": 1,
        "listId": 2,
        "itemId": 3,
        "title": "sample string 4",
        "value": "sample string 5"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.List">
  <Item>
    <Active>true</Active>
    <CustomFields>
      <CustomField>
        <CustomFieldId>1</CustomFieldId>
        <ItemId>3</ItemId>
        <ListId>2</ListId>
        <Title>sample string 4</Title>
        <Value>sample string 5</Value>
      </CustomField>
      <CustomField>
        <CustomFieldId>1</CustomFieldId>
        <ItemId>3</ItemId>
        <ListId>2</ListId>
        <Title>sample string 4</Title>
        <Value>sample string 5</Value>
      </CustomField>
    </CustomFields>
    <Description>sample string 4</Description>
    <ItemId>1</ItemId>
    <ListId>2</ListId>
    <Title>sample string 3</Title>
  </Item>
  <Item>
    <Active>true</Active>
    <CustomFields>
      <CustomField>
        <CustomFieldId>1</CustomFieldId>
        <ItemId>3</ItemId>
        <ListId>2</ListId>
        <Title>sample string 4</Title>
        <Value>sample string 5</Value>
      </CustomField>
      <CustomField>
        <CustomFieldId>1</CustomFieldId>
        <ItemId>3</ItemId>
        <ListId>2</ListId>
        <Title>sample string 4</Title>
        <Value>sample string 5</Value>
      </CustomField>
    </CustomFields>
    <Description>sample string 4</Description>
    <ItemId>1</ItemId>
    <ListId>2</ListId>
    <Title>sample string 3</Title>
  </Item>
</ArrayOfItem>