API New Beta Lookup Update

Item Lookup API Update

• Description: 
  • stored-query-id: Instead of criteria, the user may input a stored query id to search preloaded criteria. If provided, will take priority over criteria.
  • results-id: Can be entered for a groupset that already exists. If provided, will take priority over criteria and stored query id.
  • NOTE: A query using this API outputs a result set id if one was generated using this call. To iterate through the same set, use the same output resulted when paging. When using a results-id, a row-total MUST be included so the total number of rows can be tracked.
  • NOTE: When the last record is read, the result set will be cleared from access, and a new set must be created if more paging is needed.
  • row-total: Only needs to be included when a results-id is included. This field keeps a total of the number of rows in a results set for lookup/paging use.
  • active-status: Set the status of the records a user wishes to return. Currently accepts ACTIVE, INACTIVE, or EITHER.
  • condition: Determine how many of the conditions must be satisfied in the criteria, can set to ANY or ALL.
  • start-row: Determine which row the query will start reading records. Is used in paging, but can also specify results. Must be a valid number within the set.
  • page-size: Determine how many records will be shown at once. Number must be within the range of 1-500 or will default to 500.
  • criteria: Updated to add more functionality when creating criteria:
    • NOTE: When ‘value-2’ is entered, the system will automatically use this over ‘value’ when searching. It is best to either use ‘value’ to search or ‘value-2’ separately.
    • NOTE: When choosing operators associated with ‘value-2’, the only operators allowed are GreatherThan (exact spelling) or LessThan.
    • NOTE: Only ONE operator is allowed per criteria.
  • value-2: Only dates in UTC format are allowed here. This field allows users to search by date.
  • operator: Includes new functionality to allow operators when searching. Only VALID operators for each search type is allowed.
• Changes to our lookup API. When looking up a record or any information about a record, the user now has the option to page their data (maximum of 100 records at a time) and search by date.
• Users who are using the API to lookup items had trouble looking up anything other than the first 100 entries of their search via strict criteria. Now, users who wish to page their data, start at a certain entry, or search by date are now able to do so.
• Here are the new fields included:

(Pictures below are from Insomnia)

• Above is an example query made in Insomnia. The result is below:

• Help Labels
• More details in ‘Centerbase Develeper’s API’
• Help Search Terms 
• API
• Item Lookups