---
title: "ActiveRestrictPolicyAlertDocument"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/ActiveRestrictPolicyAlertDocument"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# ActiveRestrictPolicyAlertDocument

Policy-level restriction alert aggregate (GET `/bpm/v1/policies/{planCode}/{policyNumber}/Restrict` when data exists).

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.8
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    ActiveRestrictAlertEntry:
      type: object
      description: One restriction alert lifecycle record in TDS
      properties:
        id:
          type: string
        restrictionType:
          type: string
        status:
          type: string
        activationDetails:
          $ref: "#/components/schemas/ActiveRestrictActivationBlock"
        deactivationDetails:
          nullable: true
          allOf:
            - $ref: "#/components/schemas/ActiveRestrictDeactivationBlock"
        restrictedTransaction:
          type: array
          items:
            $ref: "#/components/schemas/ActiveRestrictRestrictedTransactionItem"
    ActiveRestrictActivationBlock:
      type: object
      properties:
        effectiveDate:
          type: string
        setBy:
          $ref: "#/components/schemas/ActiveRestrictPersonRef"
        documents:
          type: array
          items:
            $ref: "#/components/schemas/ActiveRestrictTdsDocumentRef"
        supportingDocuments:
          type: array
          description: Alternative property name for activation documents on deserialize
          items:
            $ref: "#/components/schemas/ActiveRestrictTdsDocumentRef"
    ActiveRestrictDeactivationBlock:
      type: object
      properties:
        effectiveDate:
          type: string
        setBy:
          $ref: "#/components/schemas/ActiveRestrictPersonRef"
        supportingDocuments:
          type: array
          items:
            $ref: "#/components/schemas/ActiveRestrictTdsDocumentRef"
    ActiveRestrictRestrictedTransactionItem:
      type: object
      properties:
        transaction:
          type: string
        restrictionType:
          type: string
          description: Restriction classification for the transaction row (e.g. hard vs
            soft), not the policy restriction category
    ActiveRestrictPersonRef:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
    ActiveRestrictTdsDocumentRef:
      type: object
      properties:
        documentId:
          type: string
        documentName:
          type: string
    ActiveRestrictPolicyAlertDocument:
      type: object
      description: >
        Policy-level restriction alert aggregate (GET
        `/bpm/v1/policies/{planCode}/{policyNumber}/Restrict` when data exists).
      properties:
        policyNumber:
          type: string
        planCode:
          type: string
        correlationId:
          type: string
        alerts:
          type: array
          items:
            $ref: "#/components/schemas/ActiveRestrictAlertEntry"
```