> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pingintel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Export Modeling Options

> **⚠️ Under active development — subject to change.**

Returns all modeling options for the submission. Each entry includes the full coverage option (with peril and zone terms) and the layers selected for modeling.



## OpenAPI

````yaml https://vision.staging.pingintel.com/api/schema/?format=json get /api/v1/submission/{pingid}/cat/modeling-options/export
openapi: 3.0.3
info:
  title: Ping.Vision API
  version: v1.0
  description: >
    ### Ping.Vision API


    This API provides convenient, efficient access to Ping Intel's data and
    services. It is designed to be used by developers and data scientists to
    integrate Ping Intel's capabilities into their applications.


    Once SSO is set up with your organization, you can create an Organization or
    Personal API key at https://auth.pingintel.com/org.


    Please see the Python client library
    [pingintel-api](https://pypi.org/project/pingintel-api/) for commandline
    tools and programmatic access, and you

    can refer to the following documentation for details on interacting with the
    system via the HTTP API.
  contact:
    email: support@pingintel.com
    name: Ping Intel
    url: https://www.pingintel.com
servers:
  - url: https://vision.pingintel.com
    description: Ping.Vision API
  - url: https://vision.staging.pingintel.com
    description: Ping.Vision API (staging)
security: []
tags:
  - name: Create Submission
    description: The Create Submission API allows you to add new data into the system.
  - name: Update Submission
    description: >-
      The Update Submission API provides various endpoints to update, modify, or
      act upon existing submissions.
  - name: Get Submission Data
    description: ''
  - name: User Memberships
    description: >-
      The User Memberships API allows you to add, remove, and change the role of
      users in different teams, divisions, or companies.
  - name: Miscellaneous
    description: ''
paths:
  /api/v1/submission/{pingid}/cat/modeling-options/export:
    get:
      tags:
        - CAT Modeling
      summary: Export Modeling Options
      description: >-
        **⚠️ Under active development — subject to change.**


        Returns all modeling options for the submission. Each entry includes the
        full coverage option (with peril and zone terms) and the layers selected
        for modeling.
      operationId: api_v1_submission_cat_modeling_options_export_retrieve
      parameters:
        - in: path
          name: pingid
          schema:
            type: string
          description: Ping ID of the submission.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ModelingOptionExport'
              examples:
                OneModelingOptionWithTwoLayers-WithoutPD/BISplit:
                  value:
                    - uuid: a1b2c3d4-0000-0000-0000-000000004001
                      created_time: '2024-01-01T00:00:00Z'
                      modified_time: '2024-06-15T12:00:00Z'
                      default_bi_period_days: 10
                      bi_limit_type: GE
                      coverage_option:
                        uuid: a1b2c3d4-0000-0000-0000-000000003001
                        name: Option 1
                        peril_terms:
                          - location_deductible_type: S
                            peril_name: EQ
                            subperil_types:
                              - EQ_Shake
                              - EQ_Fire
                              - EQ_Sprinkler
                              - EQ_Landslide
                              - EQ_Tsunami
                              - EQ_Liquefaction
                            sublimit: 1000000
                            min_deductible: 10000
                            max_deductible: 20000
                            self_insured_retentions: 100000
                            agg_limit: 500000
                            agg_deductible: 50000
                            bi_days_deductible: 10
                            location_deductible:
                              amount: 25000
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                          - location_deductible_type: S
                            peril_name: HU
                            subperil_types:
                              - HU_Wind
                              - HU_Surge
                              - HU_PrecipitationFlood
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                          - location_deductible_type: S
                            peril_name: SCS
                            subperil_types:
                              - Hail
                              - StraightLineWind
                              - Tornado
                              - WinterStorm
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                          - location_deductible_type: S
                            peril_name: IF
                            subperil_types:
                              - InlandFlood
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                          - location_deductible_type: S
                            peril_name: WF
                            subperil_types:
                              - Wildfire
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                        zone_terms:
                          - peril_class: EQ
                            zones:
                              - is_excluded: false
                                zone_name: CA
                                bi_days_deductible: 10
                              - is_excluded: false
                                zone_name: PacNW
                                bi_days_deductible: 11
                              - is_excluded: false
                                zone_name: NewMadrid
                                bi_days_deductible: 12
                              - is_excluded: false
                                zone_name: HI
                                bi_days_deductible: 13
                              - is_excluded: false
                                zone_name: AK
                                bi_days_deductible: 14
                              - is_excluded: false
                                zone_name: AllOther
                                bi_days_deductible: 15
                          - peril_class: HU
                            zones:
                              - is_excluded: false
                                zone_name: TriCounty
                              - is_excluded: false
                                zone_name: FL
                              - is_excluded: false
                                zone_name: TX
                              - is_excluded: false
                                zone_name: Tier1
                              - is_excluded: false
                                zone_name: AllOther
                          - peril_class: SCS
                            zones:
                              - is_excluded: false
                                zone_name: AllOther
                          - peril_class: IF
                            zones:
                              - is_excluded: false
                                zone_name: SFHA
                              - is_excluded: false
                                zone_name: AllOther
                        excluded_subperil_types:
                          - Terrorism
                      layer_structure:
                        uuid: a1b2c3d4-0000-0000-0000-000000001000
                        name: Structure 1
                        modified_time: '2024-06-15T12:00:00Z'
                        created_time: '2024-06-14T12:00:00Z'
                      layers:
                        - uuid: a1b2c3d4-0000-0000-0000-000000002001
                          name: Primary 25
                          attachment: null
                          limit: 25000000
                          participation_amount: null
                          participation_percent: null
                          premium: null
                        - uuid: a1b2c3d4-0000-0000-0000-000000002002
                          name: 10x25
                          attachment: 25000000
                          limit: 10000000
                          participation_amount: 5000000
                          participation_percent: null
                          premium: null
                  summary: One modeling option with two layers - Without PD/BI split
                OneModelingOptionWithTwoLayers-WithPD/BISplit:
                  value:
                    - uuid: a1b2c3d4-0000-0000-0000-000000004001
                      created_time: '2024-01-01T00:00:00Z'
                      modified_time: '2024-06-15T12:00:00Z'
                      default_bi_period_days: 10
                      bi_limit_type: GE
                      coverage_option:
                        uuid: a1b2c3d4-0000-0000-0000-000000003001
                        name: Option 1
                        peril_terms:
                          - bi_location_deductible:
                              percent: 4.5
                            location_deductible_type: S
                            bi_max_deductible: 10000
                            bi_min_deductible: 5000
                            bi_sublimit: 300000
                            pd_location_deductible:
                              amount: 25000
                            pd_max_deductible: 6000
                            pd_min_deductible: 3000
                            pd_sublimit: 200000
                            peril_name: EQ
                            subperil_types:
                              - EQ_Shake
                              - EQ_Fire
                              - EQ_Sprinkler
                              - EQ_Landslide
                              - EQ_Tsunami
                              - EQ_Liquefaction
                            is_sublimit_combined: false
                            is_deductible_combined: false
                            sublimit_type: Split
                            deductible_type: Split
                            self_insured_retentions: 100000
                            agg_limit: 500000
                            agg_deductible: 50000
                            bi_days_deductible: 10
                          - location_deductible_type: S
                            peril_name: HU
                            subperil_types:
                              - HU_Wind
                              - HU_Surge
                              - HU_PrecipitationFlood
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                          - location_deductible_type: S
                            peril_name: SCS
                            subperil_types:
                              - Hail
                              - StraightLineWind
                              - Tornado
                              - WinterStorm
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                          - location_deductible_type: S
                            peril_name: IF
                            subperil_types:
                              - InlandFlood
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                          - location_deductible_type: S
                            peril_name: WF
                            subperil_types:
                              - Wildfire
                            is_sublimit_combined: true
                            is_deductible_combined: true
                            sublimit_type: Combined
                            deductible_type: Combined
                        zone_terms:
                          - peril_class: EQ
                            zones:
                              - is_excluded: false
                                zone_name: CA
                                bi_days_deductible: 10
                              - is_excluded: false
                                zone_name: PacNW
                                bi_days_deductible: 11
                              - is_excluded: false
                                zone_name: NewMadrid
                                bi_days_deductible: 12
                              - is_excluded: false
                                zone_name: HI
                                bi_days_deductible: 13
                              - is_excluded: false
                                zone_name: AK
                                bi_days_deductible: 14
                              - is_excluded: false
                                zone_name: AllOther
                                bi_days_deductible: 15
                          - peril_class: HU
                            zones:
                              - is_excluded: false
                                zone_name: TriCounty
                              - is_excluded: false
                                zone_name: FL
                              - is_excluded: false
                                zone_name: TX
                              - is_excluded: false
                                zone_name: Tier1
                              - is_excluded: false
                                zone_name: AllOther
                          - peril_class: SCS
                            zones:
                              - is_excluded: false
                                zone_name: AllOther
                          - peril_class: IF
                            zones:
                              - is_excluded: false
                                zone_name: SFHA
                              - is_excluded: false
                                zone_name: AllOther
                        excluded_subperil_types:
                          - Terrorism
                      layer_structure:
                        uuid: a1b2c3d4-0000-0000-0000-000000001000
                        name: Structure 1
                        modified_time: '2024-06-15T12:00:00Z'
                        created_time: '2024-06-14T12:00:00Z'
                      layers:
                        - uuid: a1b2c3d4-0000-0000-0000-000000002001
                          name: Primary 25
                          attachment: null
                          limit: 25000000
                          participation_amount: null
                          participation_percent: null
                          premium: null
                        - uuid: a1b2c3d4-0000-0000-0000-000000002002
                          name: 10x25
                          attachment: 25000000
                          limit: 10000000
                          participation_amount: 5000000
                          participation_percent: null
                          premium: null
                  summary: One modeling option with two layers - With PD/BI split
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse404'
          description: ''
      security:
        - authorization_header: []
components:
  schemas:
    ModelingOptionExport:
      type: object
      properties:
        coverage_option:
          $ref: '#/components/schemas/ModelingOptionCoverageOptionExport'
        created_time:
          type: string
          format: date-time
          readOnly: true
        layer_structure:
          $ref: '#/components/schemas/LayerStructureList'
        layers:
          type: array
          items:
            $ref: '#/components/schemas/ModelingOptionExportLayer'
        modified_time:
          type: string
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
      required:
        - coverage_option
        - created_time
        - layer_structure
        - layers
        - modified_time
        - uuid
    ErrorResponse404:
      type: object
      properties:
        detail:
          type: string
          description: This id cannot be found.
      required:
        - detail
    ModelingOptionCoverageOptionExport:
      type: object
      properties:
        bi_limit_type:
          enum:
            - GE
            - GP
            - null
          type: string
          description: |-
            * `GE` - Gross Earnings
            * `GP` - Gross Profits
          x-spec-enum-id: f81ee74b088734af
          readOnly: true
          nullable: true
        created_time:
          type: string
          format: date-time
          readOnly: true
        default_bi_period_days:
          type: integer
          readOnly: true
          nullable: true
        excluded_subperil_types:
          type: array
          items:
            type: string
          readOnly: true
        modified_time:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        name:
          type: string
          readOnly: true
          nullable: true
        peril_terms:
          type: object
          additionalProperties: {}
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
          nullable: true
          description: UUID of the policy terms coverage option
        zone_terms:
          type: object
          additionalProperties: {}
          readOnly: true
      required:
        - bi_limit_type
        - created_time
        - default_bi_period_days
        - excluded_subperil_types
        - modified_time
        - name
        - peril_terms
        - uuid
        - zone_terms
    LayerStructureList:
      type: object
      properties:
        created_time:
          type: string
          format: date-time
          readOnly: true
        modified_time:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        name:
          type: string
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
          nullable: true
          description: UUID of the policy terms layer structure
      required:
        - created_time
        - modified_time
        - name
        - uuid
    ModelingOptionExportLayer:
      type: object
      properties:
        attachment:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        limit:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        name:
          type: string
          readOnly: true
        participation_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        participation_percent:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        premium:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        uuid:
          type: string
          format: uuid
          readOnly: true
          nullable: true
          description: UUID of the layer
      required:
        - attachment
        - limit
        - name
        - participation_amount
        - participation_percent
        - premium
        - uuid
  securitySchemes:
    authorization_header:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
        authentication.

````