Not logged in - Login
< back

API Transaction Searches

Transaction Searches

There are 5 types of transactions that can be searched in the system:

1.) Check Ins
2.) Check Outs
3.) Transfers
4.) Moves
5.) Disposals

SEARCH BASICS

  • All searches are done as POST requests to the API.
  • Search parameters are sent in the body of a request in a JSON format.
  • All search request bodies must contain a "StaticFields" array, an "OfficeIds" array, and also paging parameters properties "PageSize" and "PageNumber".
  • "OfficeIds" must be included in the request and allows a search to filter by Office.
  • As options, the request can also include "orderBy" which will be a field name and "orderByAsc" which can be either true or false.

SEARCH CRITERIA

The body of a search request must include a search criteria. These criteria Ids are used in the "searchCriteria" property of the request body. The criteria are different depending on the field. For easier reference, the search criteria can be broken down into the following groups:

Group 1 - TEXT FIELDS

Text Fields can be searched with the following criteria:

- Equals, Not Equals, Starts With, Text Search
These criteria are represented as follows:
Equals:
{
"id": 0,
},
Not Equals
{
"id": 1,
},
Starts With
{
"id": 2,
},
Text Search
{
"id": 25,
}

Group 2 - DATE FIELDS

Date Fields can be searched with the following criteria:
( Note - X is number of days)
- Before, After, Between, Exactly, Newer than X, Older than X, Between X and Y, Current Week, Last Week, Month To Date, Last Month, Year To Date, Last Year
These criteria are represented as follows:
Before
{
"id": 6,
},
After
{
"id": 7,
},
Between
{
"id": 8,
},
Exactly
{
"id": 13,
},
Newer Than
{
"id": 12,
},
Older Than
{
"id": 11,
},
Between X and Y
{
"id": 18,
},
Current Week
{
"id": 19,
},
LastWeek
{
"id": 20,
},
Month To Date
{
"id": 21,
},
Last Month
{
"id": 22,
},
Year To Date
{
"id": 23,
},
Last Year
{
"id": 24,
}

Group 3 - DROPDOWN FIELDS

Dropdown fields can be searched with the following criteria:
- Equals, Not Equals, Select All
These criteria are represented as follows
Equals
{
"id": 0,
},
Not Equals
{
"id": 1,
},
Select All is the default and does not need to be specified in the search request body.

Group 4 - BOOLEAN FIELDS

Boolean fields (true or false) can be searched with the following criteria:
- Equals, Not Equals
These criteria are represented as follows:
Equals
{
"id": 0,
},
Not Equals
{
"id": 1,
},

Field Types

Field Types are specified using Ids, and are included in the body as "typeId"
These are the field types and their Ids:

  • TEXTFIELD: 0,
  • TEXTAREA: 1,
  • DATE: 2,
  • DROPDOWN: 3,
  • BOOLEAN: 4,
  • TYPEAHEAD: 5,
  • LOCATION: 6,
  • MULTIPLECHECKBOX: 7,
  • NUMBER: 8

Search Criteria Types

Search Criteria Types are specified using Ids, and are included in the body as "searchCriteriasType"
These are the search criteria types and their Ids:

  • boolean: 1,
  • date: 2,
  • default: 3,
  • number : 4,
  • equals: 5,
  • contains: 6,