Form Response

FormResponseBase

Base model for a form response.

Table

Property	Type	Required	Description
id	uuid	Yes	The unique identifier for the form response
formId	uuid	Yes	The form being responded to
response	record	Yes	The response to the form
status	FormResponseStatus	Yes	The status of the form response
validationErrors	array<unknown>	No	The validation errors for the form response
customFields	record<CustomField>	No	Custom attributes about the form response
createdAt	utcDateTime	Yes	The timestamp (in UTC) at which the record was created.
lastModifiedAt	utcDateTime	Yes	The timestamp (in UTC) at which the record was last modified.

Formats

Example

A JSON example of this model.

{
  "id": "083b4567-e89d-42c8-a439-6c1234567890",
  "form": {
    "id": "b7c1e2f4-8a3d-4e2a-9c5b-1f2e3d4c5b6a",
    "name": "Form A",
    "description": "Form A description"
  },
  "response": {
    "name": {
      "first": "John",
      "last": "Doe"
    },
    "email": "john.doe@example.com",
    "phone": "555-123-4567"
  },
  "status": {
    "value": "complete",
    "description": "The form response is complete"
  },
  "validationErrors": [],
  "createdAt": "2024-01-01T00:00:00Z",
  "lastModifiedAt": "2024-01-01T00:00:00Z"
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: FormResponseBase.yaml
type: object
properties:
  id:
    $ref: uuid.yaml
    description: The unique identifier for the form response
  formId:
    $ref: uuid.yaml
    description: The form being responded to
  response:
    $ref: "#/$defs/RecordUnknown"
    description: The response to the form
  status:
    $ref: FormResponseStatus.yaml
    description: The status of the form response
  validationErrors:
    type: array
    items: {}
    description: The validation errors for the form response
  customFields:
    $ref: "#/$defs/RecordCustomField"
    description: Custom attributes about the form response
  createdAt:
    type: string
    format: date-time
    description: The timestamp (in UTC) at which the record was created.
  lastModifiedAt:
    type: string
    format: date-time
    description: The timestamp (in UTC) at which the record was last modified.
required:
  - id
  - formId
  - response
  - status
  - createdAt
  - lastModifiedAt
unevaluatedProperties:
  not: {}
examples:
  - id: 123e4567-e89b-12d3-a456-426614174000
    formId: 123e4567-e89b-12d3-a456-426614174000
    response:
      firstName: John
      lastName: Doe
      email: john.doe@example.com
      phone: 123-456-7890
      address:
        street: 123 Main St
        city: Anytown
        state: CA
        zip: "12345"
        country: null
    status:
      value: inProgress
      description: The form response is in progress
    validationErrors:
      - field: address.country
        message: Country is required
    createdAt: 2021-01-01T00:00:00Z
    lastModifiedAt: 2021-01-01T00:00:00Z
description: The base model for a form response
$defs:
  RecordUnknown:
    type: object
    properties: {}
    unevaluatedProperties: {}
  RecordCustomField:
    type: object
    properties: {}
    unevaluatedProperties:
      $ref: CustomField.yaml

TypeSpec

The TypeSpec code for this model.

/** The base model for a form response */
@example(Examples.FormResponse.formResponse)
@Versioning.added(CommonGrants.Versions.v0_2)
model FormResponseBase {
  /** The unique identifier for the form response */
  id: Types.uuid;

  /** The form being responded to */
  formId: Types.uuid;

  /** The response to the form */
  response: Record<unknown>;

  /** The status of the form response */
  status: FormResponseStatus;

  /** The validation errors for the form response */
  validationErrors?: Array<unknown>;

  /** Custom attributes about the form response */
  customFields?: Record<Fields.CustomField>;

  /** The system metadata for the form response */
  ...Fields.SystemMetadata;
}

Changelog

Version	Changes	Schema
0.2.0	Added FormResponseBase model	FormResponseBase.yaml

FormResponseStatus

The status of a form response.

Table

Property	Type	Required	Description
value	FormResponseStatusOptions	Yes	The status of the form response, from a predefined set of options
customValue	string	No	A custom value for the status
description	string	No	A human-readable description of the status

Formats

Example

A JSON example of this model.

{
  "value": "complete",
  "description": "The form response is complete"
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: FormResponseStatus.yaml
type: object
properties:
  value:
    $ref: FormResponseStatusOptions.yaml
    description: The status of the form response, from a predefined set of options
  customValue:
    type: string
    description: A custom value for the status
  description:
    type: string
    description: A human-readable description of the status
required:
  - value
unevaluatedProperties:
  not: {}
examples:
  - value: inProgress
    description: The form response is in progress
description: The status of the form response

TypeSpec

The TypeSpec code for this model.

/** The status of the form response */
@example(Examples.FormResponse.inProgressStatus)
@Versioning.added(CommonGrants.Versions.v0_2)
model FormResponseStatus {
  /** The status of the form response, from a predefined set of options */
  value: FormResponseStatusOptions;

  /** A custom value for the status */
  customValue?: string;

  /** A human-readable description of the status */
  description?: string;
}

Changelog

Version	Changes	Schema
0.2.0	Added FormResponseStatus model	FormResponseStatus.yaml

FormResponseStatusOptions

The options for the status of a form response.

Table

Value	Description
notStarted	The form response has not been started
inProgress	The form response is in progress
complete	The form response is complete, meaning all required fields have been filled out and there are no validation errors

Formats

Example

A JSON example of this model.

"inProgress"

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: FormResponseStatusOptions.yaml
type: string
enum:
  - notStarted
  - inProgress
  - complete
description: |-
  The set of values accepted for form response status:
  - `notStarted`: The form response has not been started
  - `inProgress`: The form response is in progress
  - `complete`: The form response is complete, meaning all required fields have been filled out and there are no validation errors
  - `custom`: A custom status

TypeSpec

The TypeSpec code for this model.

/** The set of values accepted for form response status:
 * - `notStarted`: The form response has not been started
 * - `inProgress`: The form response is in progress
 * - `complete`: The form response is complete, meaning all required fields have been filled out and there are no validation errors
 * - `custom`: A custom status
 */
@Versioning.added(CommonGrants.Versions.v0_2)
enum FormResponseStatusOptions {
  notStarted,
  inProgress,
  complete,
}

Changelog

Version	Changes	Schema
0.2.0	Added FormResponseStatusOptions enum	FormResponseStatusOptions.yaml