Sustema

ENTITY developer reference

SearchResult

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

candidates

Listed in this schema’s required array.

Declared type
"array"
Reading definition for candidates
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Candidate"
  },
  "x-profile-maxItems": "candidate_count_max",
  "x-additional-profile-maxItems": "page_size_max"
}

page

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for page
{
  "$ref": "#/components/schemas/Page"
}

search_completed

Listed in this schema’s required array.

Declared type
"boolean"
Reading definition for search_completed
{
  "type": "boolean"
}

not_found_meaning

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for not_found_meaning
{
  "const": "no_candidate_in_qualified_search_not_legal_nonexistence"
}

normalisation

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for normalisation
{
  "$ref": "#/components/schemas/InputNormalisation"
}

recovery

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for recovery
{
  "$ref": "#/components/schemas/RecoveryGuidance"
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "candidates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Candidate"
      },
      "x-profile-maxItems": "candidate_count_max",
      "x-additional-profile-maxItems": "page_size_max"
    },
    "page": {
      "$ref": "#/components/schemas/Page"
    },
    "search_completed": {
      "type": "boolean"
    },
    "not_found_meaning": {
      "const": "no_candidate_in_qualified_search_not_legal_nonexistence"
    },
    "normalisation": {
      "$ref": "#/components/schemas/InputNormalisation"
    },
    "recovery": {
      "$ref": "#/components/schemas/RecoveryGuidance"
    }
  },
  "required": [
    "candidates",
    "page",
    "search_completed",
    "not_found_meaning",
    "normalisation",
    "recovery"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "search_completed": {
            "const": false
          }
        },
        "required": [
          "search_completed"
        ]
      },
      "then": {
        "properties": {
          "page": {
            "properties": {
              "completeness": {
                "properties": {
                  "state": {
                    "enum": [
                      "incomplete",
                      "unknown"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  ]
}

Related schemas

All API operations