Review Applications

Submit a new application for review (website intake)

Changed on

Called by the hf_appcollector Cloud Function with the raw website form payload. Requires a Google-signed service-account ID token whose email is listed in REVIEW_INTAKE_SERVICE_ACCOUNTS. Legacy credential fields (cburi, cbusr, cbpwd) and full_message are stripped before storage. The application is stored with app_status "New". Intake is permissive: only type (VeteranApp or GuardianApp) is required; incomplete form payloads are stored as-is for reviewers to fix in the UI. Logistics model validation runs only on accept.

post/review/applications

Request

  • Base URL: https://sshf-api-330507742215.us-central1.run.app
  • URL: https://sshf-api-330507742215.us-central1.run.app/review/applications
  • Auth: HTTP bearer

Request body

type'VeteranApp' | 'GuardianApp' required

Application type

date_timestring

Submission timestamp (defaults to now if omitted)

ip_addressstring

Submitter IP address

First-Namestring required

First name

Middle-Namestring

Middle name

Last-Namestring required

Last name

Nicknamestring

Nickname

Streetstring

Street address

Citystring

City

Countystring

County

Statestring

State (two-letter code; upper-cased on storage)

Zipstring

ZIP code

Primary-Phonestring

Primary/day phone

Mobile-Phonestring

Mobile phone

from_emailstring

Email address

Date-Of-Birthstring

Birth date (MM/DD/YYYY)

Gender'Male' | 'Female'

Gender

Shirt-Sizestring

Shirt size

Conflictstring

War/conflict served (VeteranApp only; maps to vet_type)

Branch-of-Servicestring

Military branch (VeteranApp only)

Service-Datesstring

Service dates (VeteranApp only)

Rankstring

Rank at discharge (VeteranApp only)

Emergency-Contact-Namestring

Emergency contact name

Emergency-Contact-Phonestring

Emergency contact phone

Emergency-Contact-Emailstring

Emergency contact email

medical-wheelchair'Yes' | 'No'

Uses wheelchair (VeteranApp only)

medical-oxygen'Yes' | 'No'

Requires oxygen (VeteranApp only)

Guardian-Preferencestring

Preferred guardian notes (VeteranApp only)

Preferred-Guardian-Phone-Numberstring

Preferred guardian phone (VeteranApp only)

Preferred-Guardian-Emailstring

Preferred guardian email (VeteranApp only)

Veteran-Preferencestring

Veteran preference notes (GuardianApp only)

Example request

{
  "type": "VeteranApp",
  "date_time": "2024-03-05 14:22:01",
  "ip_address": "203.0.113.9",
  "First-Name": "John",
  "Middle-Name": "Q",
  "Last-Name": "Public",
  "Nickname": "Jack",
  "Street": "123 Main St",
  "City": "Madison",
  "County": "Dane",
  "State": "wi",
  "Zip": "53703",
  "Primary-Phone": "(608) 555-1234",
  "Mobile-Phone": "6085555678",
  "from_email": "john@example.com",
  "Date-Of-Birth": "05/17/1948",
  "Gender": "Male",
  "Shirt-Size": "XL",
  "Conflict": "Vietnam",
  "Branch-of-Service": "Army",
  "Service-Dates": "1966-1968",
  "Rank": "SGT",
  "Emergency-Contact-Name": "Jane Public",
  "Emergency-Contact-Phone": "608-555-9999",
  "Emergency-Contact-Email": "jane@example.com",
  "medical-wheelchair": "Yes",
  "medical-oxygen": "No",
  "Guardian-Preference": "Son Bob",
  "Preferred-Guardian-Phone-Number": "6085550000",
  "Preferred-Guardian-Email": "bob@example.com",
  "app_status": "New",
  "app_status_note": "",
  "full_message": "raw text"
}

Response

Application stored for review

_idstring

Document ID

_revstring

Document revision

type'VeteranApp' | 'GuardianApp' required

Application type

app_status'New' | 'Hold' | 'Accepted' | 'Rejected' | 'Trash'

Review workflow status

app_status_notestring

Optional note about the current status

date_timestring

Submission timestamp from the online form

app_datestring

Application date derived from date_time (YYYY-MM-DD)

ip_addressstring

Submitter IP address

accepted_as_revstring

Logistics database _rev when the application was last accepted

birth_datestring date

Birth date (YYYY-MM-DD)

gender'M' | 'F'

Gender

vet_type'WWII' | 'Korea' | 'Vietnam' | 'Afghanistan' | 'Iraq' | 'Other'

War/conflict served (VeteranApp only)

Example response

{
  "_id": "a1b2c3",
  "_rev": "3-xyz",
  "type": "VeteranApp",
  "app_status": "New",
  "app_status_note": "",
  "date_time": "2024-03-05 14:22:01",
  "app_date": "2024-03-05",
  "ip_address": "203.0.113.9",
  "accepted_as_rev": "",
  "name": {
    "first": "John",
    "middle": "Q",
    "last": "Public",
    "nickname": "Jack"
  },
  "address": {
    "street": "123 Main St",
    "city": "Madison",
    "county": "Dane",
    "state": "WI",
    "zip": "53703",
    "phone_day": "608-555-1234",
    "phone_mbl": "608-555-5678",
    "email": "john@example.com"
  },
  "birth_date": "1948-05-17",
  "gender": "M",
  "shirt": {
    "size": "XL"
  },
  "emerg_contact": {
    "name": "Jane Public",
    "address": {
      "phone": "608-555-9999",
      "email": "jane@example.com"
    }
  },
  "metadata": {
    "created_at": "2024-03-05T14:22:01Z",
    "created_by": "Online App",
    "updated_at": "2024-03-05T14:22:01Z",
    "updated_by": "Online App"
  },
  "vet_type": "Vietnam",
  "service": {
    "branch": "Army",
    "dates": "1966-1968",
    "rank": "SGT"
  },
  "guardian": {
    "pref_notes": "Son Bob",
    "pref_phone": "608-555-0000",
    "pref_email": "bob@example.com"
  },
  "medical": {
    "usesWheelchair": true,
    "requiresOxygen": false
  }
}

Changes