Sign in
Search

Search for veterans and guardians

Changed on

Searches for veterans and guardians based on provided criteria. The search can be filtered by status or flight, but not both simultaneously. If status is not 'All', flight filter will be ignored.

get/search

Request

  • Base URL: https://sshf-api-330507742215.us-central1.run.app
  • URL: https://sshf-api-330507742215.us-central1.run.app/search
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/v2/auth)

Query parameters

limitinteger

Maximum number of results to return

lastnamestring

Last name prefix to search for (partial match). Apostrophes, periods, and spaces are removed before querying so the term matches the name index. Case is unchanged. Ignored when phone_num is provided.

phone_numstring

Phone number search term. Non-digits are ignored; requires at least 3 numeric digits.

status'All' | 'Active' | 'Flown' | 'Deceased' | 'Removed' | 'Future-Spring' | 'Future-Fall' | 'Future-PostRestriction'

Status filter for the search

flightstring

Flight ID filter for the search (ignored if status is not 'All')

Response

Search completed successfully

total_rowsinteger

Total number of rows in the result set

offsetinteger

Starting offset of the result set

Changes

  • ac955cd62ce5Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 7965bd968789Revision changes
    • info

      added the new optional query request parameter phone_num

    • info

      added the optional property /// to the response with the status