Review Applications

Edit an application under review

Changed on

Replaces the editable (normalized) fields of the application. Submission metadata (date_time, ip_address, accepted_as_rev, created_*) is preserved and unknown legacy fields in the stored document are kept. Setting app_status to "Accepted" is rejected; use the accept endpoint instead.

put/review/applications/{id}

Request

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

Path parameters

idstring required

Review application document ID

Request body

_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 request

{
  "_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
  }
}

Response

Application updated

_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