Create a Product Model Data

create a product model data object and returns the object

Request Parameters

{
  "jurisdiction": "string",
  "product_code": "string"
}

Request Schema

product_model_data_request:
  type: object
  properties:
    jurisdiction:
      type: string
    product_code:
      type: string

Body Response - Schema

200 OK

product_model_data_response:
  type: object
  properties:
    code: 
      type: string
    display_name: 
      type: string
    policy_line:
      type: object
      $ref: '#/definitions/PolicyLine'
  
definitions:
  PolicyLine:
    type: object
    properties:
      code:
        type: string
      conditions:
        type: object
        $ref: '#/definitions/Conditions'
      coverages:
        type: object
        $ref: '#/definitions/Coverages'
      display_name:
        type: string
      exclusions:
        type: object
        $ref: '#/definitions/Exclusions'
      modifiers:
        type: object
        $ref: '#/definitions/Modifiers'
        
  Conditions:
    type: object
    properties:
      code:
        type: string
      condition:
        type: array
        items:
          type: object
          $ref: '#/definitions/Condition'
      display_name:
        type: string
        
  Condition:
    type: object
    properties:
      cov_term:
        type: array
        items:
          type: object
          $ref: '#/definitions/Condition_CovTerm'
      coverable:
        type: string
      display_name:
        type: string
      notes:
        type: string
      pattern_codeidentifier:
        type: string
      priority:
        type: integer
        
  Condition_CovTerm:
    type: object
    properties:
      display_name:
        type: string
      notes:
        type: string
      option:
        type: array
        items:
          type: object
          $ref: '#/definitions/Option'
      package:
        type: array
        items:
          type: object
          $ref: '#/definitions/Package'
      pattern_codeidentifier:
        type: string
      priority:
        type: integer
      value_type:
        type: string
        
  Option:
    type: object
    properties:
      display_value:
        type: string
      notes:
        type: string
      priority:
        type: integer
      value_as_string:
        type: string    
        
  Package:
    type: object
    properties:
      display_value:
        type: string
      notes:
        type: string
      priority:
        type: integer
      value_as_string:
        type: string     
        
  Coverages:
    type: object
    properties:
      code:
        type: string
      coverage:
        type: array
        items:
          type: object
          $ref: '#/definitions/Coverage'
      display_name:
        type: string
        
  Coverage:
    type: object
    properties:
      category:
        type: string
      cov_term:
        type: array
        items:
          type: object
          $ref: '#/definitions/Coverage_CovTerm'
      coverable:
        type: string
      display_name:
        type: string
      notes:
        type: string
      pattern_codeidentifier:
        type: string
      priority:
        type: integer
        
  Coverage_CovTerm:
    type: object
    properties:
      display_name:
        type: string
      notes:
        type: string
      option:
        type: array
        items:
          type: object
          $ref: '#/definitions/Option'
      package:
        type: array
        items:
          type: object
          $ref: '#/definitions/Package'
      pattern_codeidentifier:
        type: string
      priority:
        type: integer
      value_type:
        type: string 
        
  Exclusions:
    type: object
    properties:
      code:
        type: string
      display_name:
        type: string
      exclusion:
        type: array
        items:
          type: object
          $ref: '#/definitions/Exclusion'
          
  Exclusion:
    type: object
    properties:
      coverable:
        type: string
      display_name:
        type: string
      notes:
        type: string
      pattern_codeidentifier:
        type: string
      priority:
        type: integer
        
  Modifiers:
    type: object
    properties:
      code:
        type: string
      display_name:
        type: string
      modifier:
        type: array
        items:
          type: object
          $ref: '#/definitions/Modifier'
          
  Modifier:
    type: object
    properties:
      display_name:
        type: string
      pattern_codeidentifier:
        type: string

400's

ErrorInfo:
  type: object
  properties:
    details:
      type: array
      items:
        type: object
        $ref: '#/definitions/ErrorDetails'
    developerMessage:
      type: string
    errorCode:
      type: string
    status:
      type: integer
    userMessage:
      type: string

definitions:
  ErrorDetails:
    type: object
    properties:
      message:
        type: string
      properties:
        type: object
        $ref: '#/definitions/ErrorDetailsProperties'
      stackTrace:
        type: string
  
  ErrorDetailsProperties:
    type: object
    properties:
      lineNumber:
        type: integer
      parameterLocation:
        type: string
      parameterName:
        type: string

❗️

API Availability

The Financial Services Experience Cloud for Insurance - Integrations Bridge is only available for customers enrolled in Talkdesk's Early Access (EA) program. To enter the EA program, contact a Customer Success Manager.

The Financial Services Experience Cloud for Insurance - Integrations Bridge has been in EA since November 2023.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!