Skip to content
HallifyDevelopersSearch documentation
Open Hallify
Sections

Guest portal

List own original QR order receipts

GET/guest-portal/qr-visits/{associationId}/order-requests

Filters by exact original TablePublicOrderRequest.membershipId, session and seat before the bounded query. Reads frozen documents only; it neither follows moved Orders nor expires native demand on read.

Authentication

x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>

Guest-owned portal session token.

Connection guide

Parameters

associationIdPath · Required

Immutable original QR association owned by the authenticated Portal subject.

string · uuid
Full definition
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}
limitQuery · Optional

Maximum own-membership order receipts on this page.

integer
Full definition
{
  "minimum": 1,
  "maximum": 50,
  "default": 20,
  "type": "integer",
  "example": 20
}
cursorQuery · Optional

Last request UUID from the preceding page in this exact original membership scope.

string · uuid
Full definition
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}

Responses

200Bounded own-request page with explicit unavailable legacy witnesses.
GuestPortalQrOwnOrderRequestsPageDto
Full definition
{
  "$ref": "#/components/schemas/GuestPortalQrOwnOrderRequestsPageDto"
}
Example response · 200 · application/json
{
  "items": [
    {
      "availability": "LEGACY_UNAVAILABLE",
      "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "nextCursor": null
}
400Malformed input, changed statement, or invalid target proof/OTP. Wrong OTP attempts are committed.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401The original QR bearer/actual Origin or current Portal session is unavailable.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
403Private history needs current contact assurance. Consent withdrawal does not need fresh OTP.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 403 · application/json
{
  "statusCode": 403,
  "error": "errors:http.forbidden",
  "code": "HTTP_FORBIDDEN",
  "message": "errors:http.forbidden",
  "translationKey": "errors:http.forbidden"
}
404The exact owned association or eligible original request is unavailable.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
429The canonical contact-verification attempt budget is exhausted.

Response headers

Retry-After

Whole seconds the client must wait before retrying the rejected request.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "example": 60
}
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 429 · application/json
{
  "statusCode": 429,
  "error": "errors:http.tooManyRequests",
  "code": "HTTP_TOO_MANY_REQUESTS",
  "message": "errors:http.tooManyRequests",
  "translationKey": "errors:http.tooManyRequests"
}
503Protected-data policy or command encryption keys are unavailable.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Schemas

GuestPortalQrOwnOrderRequestsPageDto

Bounded original QR membership request history, retaining unavailable legacy witnesses.

itemsRequired

Only requests of the original associated membership, session and seat.

array
Full definition
{
  "type": "array",
  "maxItems": 50,
  "description": "Only requests of the original associated membership, session and seat.",
  "items": {
    "oneOf": [
      {
        "type": "object",
        "description": "Scoped original request whose retained frozen witness cannot be read safely.",
        "additionalProperties": false,
        "required": [
          "availability",
          "id",
          "createdAt"
        ],
        "properties": {
          "availability": {
            "type": "string",
            "enum": [
              "LEGACY_UNAVAILABLE"
            ],
            "description": "Original frozen witness is unavailable or corrupt; no ownership or bill amount is inferred.",
            "example": "LEGACY_UNAVAILABLE"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Original scoped order request UUID.",
            "example": "a42073ae-5313-4ace-86d8-86fb33fde1a9"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Original scoped request timestamp.",
            "example": "2026-01-15T10:00:00.000Z"
          }
        },
        "example": {
          "availability": "LEGACY_UNAVAILABLE",
          "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
          "createdAt": "2026-01-15T10:00:00.000Z"
        }
      },
      {
        "allOf": [
          {
            "$ref": "#/components/schemas/TablePublicOrderCommandDto"
          },
          {
            "type": "object",
            "description": "Availability marker for an integrity-checked original frozen request.",
            "required": [
              "availability"
            ],
            "properties": {
              "availability": {
                "type": "string",
                "enum": [
                  "AVAILABLE"
                ],
                "description": "Canonical frozen request witness is readable and integrity checked.",
                "example": "AVAILABLE"
              }
            },
            "example": {
              "availability": "AVAILABLE"
            }
          }
        ],
        "example": {
          "id": "fada03e2-505e-4bb9-80a9-716350866411",
          "tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
          "revision": 1,
          "mode": "DIRECT",
          "status": "PENDING",
          "orderId": null,
          "decisionReason": null,
          "decidedAt": null,
          "createdAt": "2026-01-15T10:00:00.000Z",
          "expiresAt": "2026-12-31T18:00:00.000Z",
          "availability": "AVAILABLE"
        }
      }
    ],
    "example": {
      "availability": "LEGACY_UNAVAILABLE",
      "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  },
  "example": [
    {
      "availability": "LEGACY_UNAVAILABLE",
      "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  ]
}
nextCursorRequired

Last scoped request UUID for the next page; null at the end.

string · uuid · null
Full definition
{
  "type": "string",
  "format": "uuid",
  "nullable": true,
  "description": "Last scoped request UUID for the next page; null at the end.",
  "example": "2117e111-06c9-477b-8d9a-3fb4313e8d93"
}
Full definition
{
  "type": "object",
  "description": "Bounded original QR membership request history, retaining unavailable legacy witnesses.",
  "additionalProperties": false,
  "required": [
    "items",
    "nextCursor"
  ],
  "properties": {
    "items": {
      "type": "array",
      "maxItems": 50,
      "description": "Only requests of the original associated membership, session and seat.",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "description": "Scoped original request whose retained frozen witness cannot be read safely.",
            "additionalProperties": false,
            "required": [
              "availability",
              "id",
              "createdAt"
            ],
            "properties": {
              "availability": {
                "type": "string",
                "enum": [
                  "LEGACY_UNAVAILABLE"
                ],
                "description": "Original frozen witness is unavailable or corrupt; no ownership or bill amount is inferred.",
                "example": "LEGACY_UNAVAILABLE"
              },
              "id": {
                "type": "string",
                "format": "uuid",
                "description": "Original scoped order request UUID.",
                "example": "a42073ae-5313-4ace-86d8-86fb33fde1a9"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "description": "Original scoped request timestamp.",
                "example": "2026-01-15T10:00:00.000Z"
              }
            },
            "example": {
              "availability": "LEGACY_UNAVAILABLE",
              "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
              "createdAt": "2026-01-15T10:00:00.000Z"
            }
          },
          {
            "allOf": [
              {
                "$ref": "#/components/schemas/TablePublicOrderCommandDto"
              },
              {
                "type": "object",
                "description": "Availability marker for an integrity-checked original frozen request.",
                "required": [
                  "availability"
                ],
                "properties": {
                  "availability": {
                    "type": "string",
                    "enum": [
                      "AVAILABLE"
                    ],
                    "description": "Canonical frozen request witness is readable and integrity checked.",
                    "example": "AVAILABLE"
                  }
                },
                "example": {
                  "availability": "AVAILABLE"
                }
              }
            ],
            "example": {
              "id": "fada03e2-505e-4bb9-80a9-716350866411",
              "tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
              "revision": 1,
              "mode": "DIRECT",
              "status": "PENDING",
              "orderId": null,
              "decisionReason": null,
              "decidedAt": null,
              "createdAt": "2026-01-15T10:00:00.000Z",
              "expiresAt": "2026-12-31T18:00:00.000Z",
              "availability": "AVAILABLE"
            }
          }
        ],
        "example": {
          "availability": "LEGACY_UNAVAILABLE",
          "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
          "createdAt": "2026-01-15T10:00:00.000Z"
        }
      },
      "example": [
        {
          "availability": "LEGACY_UNAVAILABLE",
          "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
          "createdAt": "2026-01-15T10:00:00.000Z"
        }
      ]
    },
    "nextCursor": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "Last scoped request UUID for the next page; null at the end.",
      "example": "2117e111-06c9-477b-8d9a-3fb4313e8d93"
    }
  },
  "example": {
    "items": [
      {
        "availability": "LEGACY_UNAVAILABLE",
        "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
        "createdAt": "2026-01-15T10:00:00.000Z"
      }
    ],
    "nextCursor": null
  }
}
TablePublicOrderCommandDto

Compact frozen original order-command receipt or current safe request summary; contains no membership credential.

idRequired

Immutable guest order request identifier, also used as the native admission correlation.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Immutable guest order request identifier, also used as the native admission correlation.",
  "example": "fada03e2-505e-4bb9-80a9-716350866411"
}
tableSessionIdRequired

Original native table-service session owning this request and any admitted batch.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Original native table-service session owning this request and any admitted batch.",
  "example": "9b456a94-f735-466f-84ba-67aa863b2905"
}
revisionRequired

Current request revision. Staff decisions require the exact PENDING revision and advance it once.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current request revision. Staff decisions require the exact PENDING revision and advance it once.",
  "example": 1
}
modeRequired

Admission mode captured immutably when this request was submitted.

string
Full definition
{
  "type": "string",
  "enum": [
    "DIRECT",
    "STAFF_CONFIRM"
  ],
  "description": "Admission mode captured immutably when this request was submitted.",
  "example": "DIRECT"
}
statusRequired

Persisted request lifecycle state. PENDING has no native Order; terminal states never transition again.

string
Full definition
{
  "type": "string",
  "enum": [
    "PENDING",
    "ACCEPTED",
    "REJECTED",
    "INVALIDATED"
  ],
  "description": "Persisted request lifecycle state. PENDING has no native Order; terminal states never transition again.",
  "example": "PENDING"
}
orderIdRequired

Canonical native batch Order created by ACCEPTED admission, or null before admission and for rejected or invalidated requests.

string · uuid · null
Full definition
{
  "type": "string",
  "format": "uuid",
  "nullable": true,
  "description": "Canonical native batch Order created by ACCEPTED admission, or null before admission and for rejected or invalidated requests.",
  "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
}
decisionReasonRequired

Stable rejection or invalidation reason; null for PENDING and ACCEPTED. Contains no staff note or credential.

string · null
Full definition
{
  "type": "string",
  "nullable": true,
  "maxLength": 64,
  "description": "Stable rejection or invalidation reason; null for PENDING and ACCEPTED. Contains no staff note or credential.",
  "example": "synthetic-example-credential"
}
decidedAtRequired

Persisted terminal decision time, or null while the request is PENDING.

string · date-time · null
Full definition
{
  "type": "string",
  "format": "date-time",
  "nullable": true,
  "description": "Persisted terminal decision time, or null while the request is PENDING.",
  "example": "2026-01-15T12:00:00.000Z"
}
createdAtRequired

Immutable server creation time used with the request UUID for cursor ordering.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Immutable server creation time used with the request UUID for cursor ordering.",
  "example": "2026-01-15T10:00:00.000Z"
}
expiresAtRequired

Original effective source and quote deadline. Expired pending demand cannot be admitted.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Original effective source and quote deadline. Expired pending demand cannot be admitted.",
  "example": "2026-12-31T18:00:00.000Z"
}
Full definition
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Immutable guest order request identifier, also used as the native admission correlation.",
      "example": "fada03e2-505e-4bb9-80a9-716350866411"
    },
    "tableSessionId": {
      "type": "string",
      "format": "uuid",
      "description": "Original native table-service session owning this request and any admitted batch.",
      "example": "9b456a94-f735-466f-84ba-67aa863b2905"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Current request revision. Staff decisions require the exact PENDING revision and advance it once.",
      "example": 1
    },
    "mode": {
      "type": "string",
      "enum": [
        "DIRECT",
        "STAFF_CONFIRM"
      ],
      "description": "Admission mode captured immutably when this request was submitted.",
      "example": "DIRECT"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "ACCEPTED",
        "REJECTED",
        "INVALIDATED"
      ],
      "description": "Persisted request lifecycle state. PENDING has no native Order; terminal states never transition again.",
      "example": "PENDING"
    },
    "orderId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "Canonical native batch Order created by ACCEPTED admission, or null before admission and for rejected or invalidated requests.",
      "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
    },
    "decisionReason": {
      "type": "string",
      "nullable": true,
      "maxLength": 64,
      "description": "Stable rejection or invalidation reason; null for PENDING and ACCEPTED. Contains no staff note or credential.",
      "example": "synthetic-example-credential"
    },
    "decidedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Persisted terminal decision time, or null while the request is PENDING.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Immutable server creation time used with the request UUID for cursor ordering.",
      "example": "2026-01-15T10:00:00.000Z"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Original effective source and quote deadline. Expired pending demand cannot be admitted.",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "description": "Compact frozen original order-command receipt or current safe request summary; contains no membership credential.",
  "required": [
    "id",
    "tableSessionId",
    "revision",
    "mode",
    "status",
    "orderId",
    "decisionReason",
    "decidedAt",
    "createdAt",
    "expiresAt"
  ],
  "example": {
    "id": "fada03e2-505e-4bb9-80a9-716350866411",
    "tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
    "revision": 1,
    "mode": "DIRECT",
    "status": "PENDING",
    "orderId": null,
    "decisionReason": null,
    "decidedAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  }
}
TranslatedErrorDto

Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.

statusCodeRequired

HTTP status code repeated from the response.

integer
Full definition
{
  "type": "integer",
  "description": "HTTP status code repeated from the response.",
  "example": 400
}
errorRequired

Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.

string
Full definition
{
  "type": "string",
  "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
  "example": "errors.request.invalid"
}
codeRequired

Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.

string
Full definition
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
}
messageRequired

Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
}
translationKeyRequired

Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsOptional

Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.

array
Full definition
{
  "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsOptional

Optional domain-specific blocker or validation details

oneOf
Full definition
{
  "description": "Optional domain-specific blocker or validation details",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "example": [
    "example"
  ]
}
Full definition
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP status code repeated from the response.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Optional domain-specific blocker or validation details",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": [
            "example"
          ]
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": {
            "exampleKey": "example"
          }
        }
      ],
      "example": [
        "example"
      ]
    }
  },
  "required": [
    "statusCode",
    "error",
    "code",
    "message",
    "translationKey"
  ],
  "description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.

fieldRequired

Public field path. Nested properties and array indices are separated by dots.

string
Full definition
{
  "type": "string",
  "example": "email",
  "description": "Public field path. Nested properties and array indices are separated by dots."
}
translationKeyRequired

Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
}
codeRequired

Stable validator identifier for this field failure. Custom validators may define additional identifiers.

string
Full definition
{
  "type": "string",
  "example": "isEmail",
  "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
}
messageRequired

Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
Full definition
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Public field path. Nested properties and array indices are separated by dots."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}
JsonValue

Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.

Full definition
{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
  "example": "example"
}

Hallify uses essential cookies and optional analytics.

Essential cookies keep sign-in, locale, and theme preferences working. Analytics is off until you choose to allow it.