# placements.preview

Generate a transient placement to preview form requirements without creating it

Endpoint: POST /api/v1/placements/preview
Version: 0.0.1
Security: form_session, user_session, component_session, component_token, api_token

## Request fields (application/json):

  - `employee_id` (string, required)
    Employee Identifier

  - `employer_id` (any)

  - `client_id` (any)

  - `job_id` (any)

  - `custom_attributes` (object)
    Record of custom attribute values keyed by string path.

## Response 200 fields (application/json):

  - `id` (string, required)
    Placement Identifier

  - `employee_id` (string, required)
    Employee Identifier

  - `employer_id` (any, required)

  - `client_id` (any, required)

  - `job_id` (any, required)

  - `custom_attributes` (object, required)
    Record of custom attribute values keyed by string path.

  - `created_at` (string, required)
    a string to be decoded into a DateTime.Utc

  - `missing_task_count` (number, required)

  - `progress` (object, required)

  - `progress.forms_required` (number, required)

  - `progress.forms_completed` (number, required)

  - `form_requirements` (array, required)

  - `form_requirements.task_id` (any, required)

  - `form_requirements.form` (object, required)

  - `form_requirements.form.id` (string, required)
    Form Identifier (lineage uid)

  - `form_requirements.form.name` (string, required)

  - `form_requirements.form.tags` (array, required)

  - `form_requirements.form.tags.name` (string, required)

  - `form_requirements.form_name` (string, required)

  - `form_requirements.form_tags` (array, required)

  - `form_requirements.form_tags.name` (string, required)

  - `suggested_tasks` (array, required)

  - `suggested_tasks.form_name` (string, required)

  - `suggested_tasks.task_id` (any, required)

  - `suggested_tasks.form_tags` (array, required)

  - `suggested_tasks.form_tags.name` (string, required)

## Response 400 fields (application/json):

  - `issues` (array, required)

  - `issues._tag` (string, required)
    The tag identifying the type of parse issue
    Enum: "Pointer", "Unexpected", "Missing", "Composite", "Refinement", "Transformation", "Type", "Forbidden"

  - `issues.path` (array, required)
    The path to the property where the issue occurred

  - `issues.path._tag` (string, required)
    Enum: "symbol"

  - `issues.path.key` (string, required)

  - `issues.message` (string, required)
    A descriptive message explaining the issue

  - `message` (string, required)

  - `_tag` (string, required)
    Enum: "HttpApiDecodeError"

## Response 401 fields (application/json):

  - `message` (string, required)

  - `_tag` (string, required)
    Enum: "Unauthorized"

## Response 403 fields (application/json):

  - `message` (string, required)

  - `_tag` (string, required)
    Enum: "Forbidden"