Guardians

Update a guardian record

Changed on
put/guardians/{id}

Request

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

Path parameters

idstring required

Guardian record ID

Request body

_idstring

Document ID

_revstring

Document revision

type'Guardian' required

Document type, must be "Guardian"

birth_datestring

Birth date in YYYY-MM-DD format

gender'M' | 'F'

Guardian gender

app_datestring

Application date

weightstring

Weight in pounds (60-450)

occupationstring

Guardian occupation

Response

Guardian record updated successfully. When veteran.pairings array is modified, the affected veteran records are automatically updated to reflect the pairing changes. History entries are added to both guardian and veteran records.

_idstring

Document ID

_revstring

Document revision

type'Guardian' required

Document type, must be "Guardian"

birth_datestring

Birth date in YYYY-MM-DD format

gender'M' | 'F'

Guardian gender

app_datestring

Application date

weightstring

Weight in pounds (60-450)

occupationstring

Guardian occupation

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status