Socotra

Getting Started

  • Introduction to Socotra Enterprise Core
    • Overview
      • What is Socotra?
      • What is Socotra Enterprise Core?
    • What is the Getting Started with Socotra Learning Path?
    • Have questions?
    • Ready for the next module?
  • Log Into Socotra
    • Overview
      • What will I learn?
      • What will I need?
    • Key concepts
      • What is a business account?
      • Ready to begin?
    • Steps
    • Recap
    • Ready for the next module?
  • Create a Tenant Configuration File
    • Overview
      • What will I learn?
      • What will I need?
    • Key concepts
      • What is a tenant configuration file?
      • What is a tenant?
      • How is a tenant configuration file structured?
        • Considerations
        • What is an insurance product?
        • What is an account holder?
        • What is an element?
        • Visualizing the configuration of an insurance product
      • Ready to begin?
    • Part 1 - Creating a configuration file
    • Part 2 - Basic editing of the tenant configuration file
      • View the configuration file
      • Concept - Attributes
      • Concept - Default attributes
      • Edit the default attributes
      • Concept - Attribute types
    • Part 3 - Advanced editing of the tenant configuration file
      • View the Products menu
      • Concept - Abstract records and inheritance
      • Tabs in the Product menu
        • Eligible Account Types
        • Contents
        • Charges
        • Coverage Terms
        • Data
        • Static Data
        • Plugins
        • Documents
        • Settings
      • Making changes to the product
    • Recap
    • Ready for the next module?
  • Overview - Tenants
    • What is a tenant?
    • Tenants page
    • Tenant configuration page
      • Users
      • Resources
        • Resource instances
        • Resource groups
    • Ready for the next module?
  • Create a Tenant
    • Steps
    • Ready for the next module?
  • Set up Postman to use the Socotra API
    • Overview
      • What will I learn?
      • What will I need?
        • Issues with your credentials?
      • Ready to begin?
    • Steps
      • Part 1 - Set up your collection and environment
      • Part 2 - Set up your environment
      • Part 3 - Authenticate with Socotra
    • Make a request to test your authentication
    • Troubleshooting
    • Recap
    • Ready for the next module?
  • Create an Account
    • Overview
      • What will I learn?
      • What will I need?
    • Key concepts
      • What is an account?
      • What is the process for creating an account?
        • Create
        • Modify
        • Validate
      • Ready to begin?
    • Steps
      • Create an account
      • Update an account
      • Validate an account
    • Recap
    • Ready for the next module?
  • Execute Quote to Bind
    • Overview
      • What will I learn?
      • What will I need?
    • Key concepts
      • What is a quote?
      • What is a policy?
      • Life cycle of a quote
      • Resetting a quote
      • Atypical quote states
      • Ready to begin?
    • Steps
      • Part 1 - Create a quote
        • Request body breakdown
      • Part 2 - Validate the quote
      • Part 3 - Price the quote
      • Part 4 - Underwrite the quote
      • Part 5 - Accept the quote
      • Part 6 - Issue the quote
    • Recap
    • Ready for the next module?
  • Execute Policy Transactions
    • Overview
      • What will I learn in this tutorial?
      • What will I need?
    • Key concepts
      • What is a policy?
      • What are terms and segments?
        • Terms
        • Segments
      • What is a policy transaction?
    • Example scenarios
      • Example 1 - Changing a policy
      • Example 2 - Renewing a policy
      • Example 3 - Canceling a policy
    • Tutorials
      • Scenario - Homeowner seeking to modify home insurance coverage
      • Tutorial 1 - Making a change to a policy
        • 1.1 - Locating customer’s account number in Postman
        • 1.2 - Locating customer’s policy in Postman
        • 1.3 - Retrieving customer’s policy details
        • 1.4 - Creating a change transaction
        • 1.5 - Issuing a change transaction
        • 1.6 - Viewing the changed policy
      • Tutorial 2 - Renewing a policy
      • Tutorial 3 - Canceling a policy
      • Tutorial 4 - Reinstating a policy
    • Ready for the next module?
  • Invoices and Payments
    • Overview
      • What will I learn?
      • What will I need?
    • What is the billing life cycle?
    • Walkthrough the billing life cycle
    • Stage 1: Quote is issued (via API)
    • Stage 2: System generates an installment lattice
    • Stage 3: System generates installments
    • Stage 4: System generates invoice(s)
    • Stage 5: Payment is created (via API)
    • Stage 6: Payment is posted to invoice (via API)
  • Socotra Sample Postman Collection and Environment

Feature Guide

  • Business Accounts
    • Overview
    • Management Capabilities
      • Tenants
      • Users and Roles
      • Authentication
  • Accounts
    • Overview
    • Configuration
      • Extension Data
      • Product Enablement
    • Account States
    • Quotes and Quick Quotes
    • See Also
  • Quotation Topic Index
    • Quotes
      • Quote State Flow
        • Standard Flow
        • Atypical States
      • Quote Reset
      • Time Zones
      • Currencies
      • Error Handling
      • See Also
    • Quick Quotes
      • Overview
      • Workflow
      • Quotation
      • Discard
      • See Also
  • Policy Management Topic Index
    • Policy Transactions
      • Structure
      • Provisional Transactions
      • Basic Transactions
      • Advanced Transactions
      • Process
    • Policy Transaction Stack
      • Workflow
      • Transaction Data
      • Documents
      • Validation
      • See Also
    • Policy Elements
      • Overview
      • Categories and Types
        • Example
      • Quantifiers
      • Coverage Terms
      • Data Extensions
      • See Also
    • Coverage Terms
      • Overview
      • Configuration
      • Elements with Coverage Terms
        • Creation
        • Update
        • Default Coverage Term Options
        • Plugins
    • Out of Sequence Transactions
      • Overview
      • High-Level Approach
      • Static Locators
      • Intervening Out-of-Sequence Transactions
      • Reversals
      • See Also
    • Transaction Branching and Invalidation
      • Example
      • Details
      • Elements
      • Auto-Rebasing
      • See Also
    • Reinstatement
      • Overview
      • Behavior
      • Reinstatement After Multiple Cancellations
      • Reinstatement with a Gap
    • Renewal Management and Auto-Renewal
      • Overview
      • Manual Renewal
      • Auto-Renewal
        • Auto-Renewal States
        • Auto-Renewal Plugin
        • Manual Renewal Operations on an Auto-Renewal
      • Cancellations and Auto-Renew
      • Do Not Renew
      • Renewal with a Gap
      • See Also
  • Billing Topic Index
    • Installment Lattices
      • Overview
      • Structure
      • Process
      • See Also
    • Installment Settings
      • Overview
      • Settings List
      • Resolving Settings
        • Quotes Process
        • Quotes Example
        • Policy Transactions Process
      • Account Preferences
      • Validation
      • Persistence
      • Default Settings
      • See Also
    • Invoicing
      • Overview
      • Structure
      • Due Times
      • Invoice Rendering
      • See Also
    • Payments
      • Overview
      • Payments
      • Financial Instruments
      • External Cash Transactions
      • Payment Distribution
      • Payment Reversals
      • See Also
    • Delinquency
      • Overview
      • Configuration
      • Delinquency Onset
      • Lapse
      • Delinquency Events
      • See Also
    • Billing Holds
      • Overview
      • Lifecycle
      • Invoice Holds
      • Delinquency Holds
      • See Also
    • Disbursements
      • Overview
      • Lifecycle
      • Credit Sources
      • Financial Instruments
      • Configuration and Data Extensions
      • Accounting
      • See Also
    • Credit Balances
      • Overview
      • Usage
      • See Also
    • Excess Credits
      • Overview
      • Configuration
      • Process
      • See Also
    • Credits from Policy Transactions and Billing Changes
      • Overview
      • Example 1: Standard Cancellation
      • Example 2: Lapse
      • See Also
    • Backloading Installments
      • Overview
      • Initial State
      • Lattice Creation
      • Charge Processing
      • Invoicing
      • Results
  • Financials Topic Index
    • Charges
      • Categories
      • Charge Types
      • Reference Rates
      • Data Precision
    • Durations
      • Overview
      • Usage
      • Configuration
      • Supported Duration Bases
      • Daylight Saving Time
    • Rounding Service
    • Basic Double-Entry Accounting Primer
      • Introduction
      • General Principles
      • T-Accounts
      • Transactions
      • See Also
    • Simplified Accounting Example
      • Overview
      • Summary
      • See Also
  • Underwriting
    • Overview
    • Underwriting Flags
    • Plugin
    • Evaluation
    • Underwriting Status
    • See Also
  • Documents
    • Overview
    • Document Retreival
    • Direct Document Attachment and Modification
      • Attaching New Documents
      • Updating Documents
    • See Also
  • Diaries
    • Overview
    • Diary Entries
    • Revisioning
    • Discard
    • See Also
  • Search
    • Overview
    • Example
      • Request
      • Response
    • Requests
      • Search String Syntax
    • Responses
      • Relevance
      • Search Summary
      • Sample Responses
    • Configuration
    • See Also
  • Security Topic Index
    • Roles and Permissions
      • Special Roles
      • Tenant Access
      • Available Permissions
      • Wildcard Patterns
      • Auth Tokens
      • See Also
    • Comprehensive Permissions Listing
      • See Also
    • Password Policies
      • See Also
  • Migration
    • Overview
    • Migration Structure
      • Bring Your Own Identifiers
    • Migration Management
      • Remediation

Configuration Guide

  • Configuration General Topics Index
    • Configuration Deployment
      • Overview
      • Notes
        • Configuration Structure
        • Configuration Validation
        • Configuration Case Sensitivity
      • See Also
        • Configuration Redeployment
    • Configuration Redeployment
      • Overview
      • Safe Changes
      • Migratable Changes
      • Disallowed Changes
      • Future Functionality
        • Locking
        • Retirement
    • Configuration Bootstrap
      • Overview
      • Notes
        • Bootstrap Directory
        • Validations
        • Example
    • Configuration SDK
      • Overview
        • Do I really need an SDK to write and maintain configs?
      • Getting Started
        • Get the source control template
        • Update the config plugin to point at a target tenant
        • Use tasks as you build your config
      • Bootstrapping
    • Quantifiers
      • Overview
      • Structure
        • Element Quantifiers
        • Coverage Term Quantifiers
        • Data Extension Quantifiers
      • Automatic Items
        • Automatic Elements
        • Automatic Coverage Terms
    • Identifiers
      • Overview
      • Items with Identifier Names
      • Rules
    • Events
      • Usage
      • See Also
    • Event Definitions
      • Account Events
      • Quote Events
      • Transaction Events
      • Credit Distribution Events
      • Delinquency Events
      • Disbursement Events
      • Installment Events
      • Invoice Events
      • Payment Events
      • Shortfall Credit Events
      • Write Off Events
      • Event Payloads
      • See Also
    • Webhooks
      • Managing Webhooks
        • Failure Handling
      • See Also
  • Resources Topic Index
    • Versioned Resource Selection
      • Overview
      • Key Concepts
      • The Selection Time Basis
      • API and Entity Structure
      • Runtime Behavior in Plugins
      • Document Selection
      • Unmanaged Resources
      • Usage Example
    • Data Tables
      • Overview
      • Configuration
      • Limitations
    • Documents
      • Overview
      • Document Scope
      • Policy Document Workflow
      • Quotation
      • Plugins
        • Policy Document Selection Plugin
        • Document Data Snapshot Plugin
  • Data Extensions Topic Index
    • Data Extensions
      • Overview
      • Data Scopes
      • Data Types
      • Quantifiers and Arrays
      • Validation Requirements
      • Other Data Properties
      • Comprehensive Properties List
      • See Also
    • Data Extension Types
      • Overview
      • Built-In Data Types
      • Date Types
        • datetime
        • date
      • Custom Data Types
      • Limitations
    • Extension Data Constraints
      • Overview
      • Structure
      • Configuration
      • Dependency Maps
      • Constraint Evaluation API
      • Referencing Other Elements
      • Validation
    • Custom Data Types
      • Usage
      • Custom Data Inheritance
    • Validation
    • Static Data
      • Usage - Quotes
      • Usage - Policies
  • Front-End SDK Topics Index
    • Front-End SDK Overview
      • Installation
      • Example Applications
        • Full stack starter with Next.js
      • See Also
    • Front-End SDK Guides Topic Index
      • Authentication with Keycloak and NextAuth.js
        • Create a new Next.js App
        • Add NextAuth.js
        • Add environment variables for local development
        • (Optional) Add t3-oss/t3-env
        • Setup Next.js and NextAuth with Keycloak
        • Define Middleware for protecting routes
        • Add Logout Functionality
    • Components Index
      • AccountForm
        • Overview
        • Props
        • Usage
        • Customization
        • Standard Account Form
        • Creating a New Account
        • Updating an Existing Account
        • Customization
        • Validation
        • Submitting the Form
      • QuoteForm
        • Overview
        • Props
        • Usage
  • Plugins Topic Index
    • Plugins Overview
      • Overview
        • Precommit
        • Validation
        • Rating
        • Underwriting
        • Document Data Snapshot
        • Document Selection
      • Plugin Execution
      • Plugin Configuration
      • Precommit and Validation
      • Data Fetcher
      • Resource Selector
      • External API Calls
    • Precommit
      • Overview
      • Plugin Execution
      • Account
      • Quote
      • Transaction
      • Payment
      • Disbursement
      • Delinquency
    • Validation
      • Overview
      • Plugin Execution
      • Account
      • Quote
    • Rating
      • Overview
      • Configuration
      • Return Object
    • Underwriting
      • Overview
      • Configuration
      • Return Object
    • Document Data Snapshot
      • Overview
    • Document Selection
      • Overview

API Guide

  • Business Account API Index
    • Authentication API
      • Creation
      • Fetch
      • Deletion
    • Tenant Management API
    • User Management API
      • Endpoint Index
      • Users
      • Roles
      • Permissions
      • User Role Assignments
      • User Tenant Assignments
  • Accounts API
    • Endpoint Index
    • Fetch
    • Account Creation
    • Updating
    • Validation
    • Quotes and Policies
    • Holds
    • Billing
  • Quotes API
    • Endpoint Index
      • Main Flow
    • Fetch
    • Quote Creation
    • Update
    • Validation
    • Pricing
    • Underwriting
    • Acceptance
    • Issuance
    • Quote Copy and Group Assignment
    • Static Data
    • Documents
    • Billing
      • Atypical States and Operations
  • Quick Quotes API
    • Endpoint Index
    • See Also
  • Policy Management API Index
    • Policies API
      • Endpoint Index
      • Fetch
      • Static Data
      • Snapshots
      • Billing Triggers
      • Billing
    • Policy Transactions API
      • Endpoint Index
        • Main Flow
      • Fetch
      • Transaction Creation
      • Updating
      • Validation
      • Pricing
      • Underwriting
      • Acceptance
      • Issuance
      • Documents
        • Transaction Details
        • Atypical States and Operations
      • Deprecated Items
    • Policy Terms API
      • Fetch
      • Term Summaries
    • Renewal Management and Auto-Renewal API
      • Endpoint Index
      • Fetch
      • Create
      • Update
      • Plan Updates
      • See Also
  • Billing API Index
    • Main Index
      • Installments API
      • Installment Lattices API
        • See Also
      • Invoices API
        • Endpoint Index
        • Fetch
        • Invoice Documents
        • Invoice Preview
      • Payments API
        • See Also
      • Disbursements API
        • See Also
      • Credit Distribution API
        • Fetch
        • Creation and Update
        • Execution
        • Reversal
        • Reset and Discard
        • Invoices
      • Credits API
      • Account Balances API
      • Financial Instruments and External Cash Transactions API
        • Financial Instruments
        • External Cash Transactions
      • Delinquency API
        • Delinquency Plan Assignment
        • Fetch
        • Delinquency Updates
        • Delinquency Events
        • See Also
      • Billing Holds API
        • Fetch
        • Creation and Update
        • Execution
        • Release, Reset, and Discard
        • See Also
      • Write-Offs API
    • Policy Service Endpoints
  • Accounting API
    • Accounting Transactions
    • Accounting T-Accounts
    • Cash Accounts
  • Documents API
    • Fetch
    • Modification
    • Ad-hoc Rendering
    • See Also
  • Resources API Index
    • Resource Service API
      • Resource Groups
      • Resources
    • Document Resources API
      • Document Resources
      • Document Templates
    • Tables API
      • Data Tables
        • Usage
        • Configuration
      • Constraint Tables
        • Quotes
        • Quick Quotes
        • Policy Transactions
        • Configuration
    • Secrets API
  • Data API Index
    • Aux Data API
    • Diary API
      • Fetch
      • Creation
      • Revisioning
      • Discard
      • See Also
    • Events API
      • Fetch
      • See Also
    • Diverted Events API
      • See Also
    • Search API
      • Data Search
      • See Also
  • Configuration and Development API Index
    • Configuration Deployments API
      • Tenant Creation
      • Fetch
      • Redeployment
      • Validation
      • Utility
      • Configuration Entities
    • Developer API
    • Logging API
    • Jobs API
      • Endpoint Index
      • Documents Jobs
      • Job Retrigger
      • Installment Jobs
      • Invoice Jobs
      • Delinquency Jobs
    • Identity Providers API
    • Webhooks API
      • See Also
    • Passwords API
      • Fetch
      • Update
      • See Also
  • Migration API
    • Endpoint Index
    • Migration Management
    • Migration Information

Other Resources

  • Release Notes
    • October 9, 2024
      • New Feature Guides
      • Other Changes
    • October 2, 2024
    • September 25, 2024
      • New Getting Started Guide!
      • New Migration Feature Guide
      • Invoice Documents
      • Other Changes
    • September 18, 2024
      • External Documents
      • Other Changes
    • September 11, 2024
    • September 4, 2024
      • Optional Properties
      • Billing Triggers
      • Other Change
    • August 28, 2024
    • August 21, 2024
      • Diaries
      • Regions
      • Changes to Paged List Fetch Semantics
      • Auto Transaction Rebasing
      • Other Changes
    • July 31, 2024
      • Quick Quotes
      • Account Level Billing
      • Policy Transaction Branching
      • Configuration Changes
      • Other Changes
    • July 24, 2024
    • July 1, 2024
      • Stateless Operations
      • Invoices and Installments
      • Other Changes
    • June 10, 2024
      • Policies
      • Invoices and Payments
      • Installments
      • Stateless Operations
      • Underwriting
      • Accounting
      • Delinquency
      • Aux Data
      • Data Extension Constraints
      • Other Changes
    • May 23, 2024
      • Users
      • Excess Credits
      • Open API Definitions
      • Other Changes
    • May 20, 2024
      • Event Stream Data Definition
    • May 17, 2024
      • Deprecations
      • Static Data
      • Other Changes
    • May 15, 2024
      • Renewal Management and Auto-Renewal
      • Resources
      • Policy Snapshots
      • Credits
      • “List” Endpoints
      • Other Changes
    • May 1, 2024
      • Charges
      • Documents
    • April 28, 2024
      • Feature Guides
      • Search
      • Password Policies
    • April 23, 2024
      • Payments
      • Write-Offs
      • Other Changes
      • Feature Guides
    • April 17, 2024
      • Optional and Required Properties
      • Write-Offs
      • Term Summary
      • Other Changes
    • April 12, 2024
      • Search
      • Invoicing
      • Other Changes
    • Older Changes
  • Deprecated API Items
    • Endpoints
      • GET /billing/{tenantLocator}/jobs/invoices/policies/{locator}/list
      • GET /billing/{tenantLocator}/jobs/invoices/quotes/{locator}/list
      • PATCH /policy/{tenantLocator}/policies/{locator}/billingTrigger
      • GET /policy/{tenantLocator}/policies/snapshot/list
      • GET /policy/{tenantLocator}/quotes/list
      • GET /policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator}
      • GET /policy/{tenantLocator}/transactions/{locator}/segments/list
    • Entities
      • Account Response
      • Billing Plan Ref
      • Billing Trigger Update Request
      • Charge Ref
      • Configuration Ref
      • Document Job Info
      • Document Summary
      • Element Ref
      • Params Change Instruction Create Request
      • Params Change Instruction Response
      • Policy Response
      • Policy Transaction Response
      • Product Ref
      • Quick Quote Price Response
      • Quote Create Request
      • Quote Response
      • Quote Update Request
  • Open API Definition File
  • Connected Core Docs
Socotra
  • Search

Search

Socotra’s search allows you to find policies, quotes, and accounts quickly and easily.

Overview

You can search against locators, static data, and data extensions of type string. If there is a match with some degree of relevancy, the corresponding quote, policy, or account will be returned for that match. Results are ordered by relevancy score, from highest to lowest. Relevancy scores are boosted for exact matches on locators and static data, helping to ensure that such results emerge towards the top of the results.

Example

If you have an account configured with a data extension field lastName, and there is at least one account with last name “Swerski” in your set of accounts, a search query for Swerski will return at least one result: the account record for “Swerski”, with a high relative score.

Request

POST request body:

{
    "searchString":"Swerski"
}

Response

{
    "page": 0,
    "results": [
        {
            "score": 1.0,
            "searchEntityType": "ACCOUNT",
            "locator": "01HRQ8BQTAPT16ZZ6JQJBDNVP8",
            "highlights": [
                "Score:1.0 ,Document: accountdata_01HRQ8BQTAPT16ZZ6JQJBDNVP8,Highlight: {data.lastName.keyword=[<em>Swerski</em>], data.lastName=[<em>Swerski</em>]}"
            ]
        },
        {
            "score": 0.85714287,
            "searchEntityType": "ACCOUNT",
            "locator": "01HRQ8QEA03ZNSV73Y6X9Y8P6Z",
            "highlights": [
                "Score:0.85714287 ,Document: accountdata_01HRQ8QEA03ZNSV73Y6X9Y8P6Z,Highlight: {data.lastName.keyword=[<em>Swersky</em>], data.lastName=[<em>Swersky</em>]}"
            ]
        }
    ]
}

Note

A similar name, “Swersky”, appears in the results, but with lower relevance than the more exact match on “Swerski”. An exact match request with “Swerski” wrapped in (escaped) quotes would only return the “Swerski” account. Read on for details about search behavior and search string syntax.

Requests

Requests can be sent as a single searchString or as a searchTerm array. See the API reference for details.

Search String Syntax

A search request comprises search terms - an array of searchTerm items - and can be expressed as a searchString. searchString syntax allows you to express a complete query in a single string, such as one passed through a typical search form box.

A search string follows these rules:

  • A sequence one or more searchTerm strings, separated by whitespace.

  • Each searchTerm string has the following form:

    • Form: [+|-][fieldName:]string[*]

      • The fieldName slug determines whether the match should be against a specific field name or any field.

      • The fieldName can be qualified by the full path of the element to which it belongs, which allows for greater specificity in your query. For example, a top-level lastName data extension string on an account can be searched like this: +data.lastName:Swerski, while a firstName data extension on an exposure “insured” under some product can be searched as +insuredQuote.firstName:Veronica (for quotes) or +insuredPolicy.firstName:Veronica (for policies).

      • Term relevance scoring:

        • If the term is prefixed with a +, the term is required for search result relevance.

        • If the term is prefixed with a -, the term must be excluded for search result relevance.

        • Absence of + or - before a term is interpreted as a suggestion: the presence of the term increases the relevance score, but does not require that the term be present or absent from a match candidate.

    • The default match behavior is fuzzy.

      • Appending * to the term sets matching to startsWith.

      • Enclosing the term in double quotes sets matching to exact. Searches with spaces cannot be fuzzy searches.

Responses

The SearchServiceResponse provides a list of SearchResultResponse results, along with properties to assist in paging through results.

You can fetch up to 100 results at a time, and use the count, offset, and searchToken values to control pagination. If no count is set for the initial search request, it will be set to 100. The searchToken should be used in subsequent GET requests to page through the results, with count serving as the number of results to be returned in the page and offset as the starting index (beginning at 0) in the result list. For example, if you perform a search with a total of 70 results, and want to page through 25 results at a time, you can do it with three requests, all setting count to 25:

  1. The initial query

  2. A second query, along with the searchToken and offset as 25

  3. A final query , along with the searchToken and offset as 50

You’ll know that you have exhausted the result set when the length of the result list is less than count. If there are no results beginning at some offset index, the service will return an empty result list. You can set the count to another value when fetching results; following the example above, if you decided you wanted all the results in a single response, just provide the searchToken with count at least 70. A provided count greater than 100 will be set to 100.

Relevance

The highlights and score properties provide additional context about the match. In highlights you will find one or more excerpts from text that matched the query, while score indicates the relative numerical value assigned for ranking. You’ll see very high score values for certain cases, such as exact matches on locator values.

Search Summary

The searchSummary object serves as a digest about the entity, reducing the need for subsequent data fetches from the API in order to understand which entity is being referred to, or to display the search result in an effective way. The contents of searchSummary depends on the result entity type:

  • Accounts will have all string-type data extension field values in the data property, along with name and state.

  • Quotes and policies will have all static data fields in a static property.

  • Quotes will also have a state property.

Sample Responses

A SearchResultResponse for a “ConsumerAccount” account (search query was simply “Evans”):

{
    "score": 1.0,
    "searchEntityType": "account",
    "searchEntityLocator": "01J53T5V9B3ARJDF38CYY17CJ1",
    "searchSummary": {
        "data": {
            "crm_reference_id": "refId123",
            "firstName": "Bill",
            "lastName": "Evans"
        },
        "name": "ConsumerAccount",
        "state": "validated"
    },
    "highlights": [
        "Score:1.0 ,Document: 01J53T5V9B3ARJDF38CYY17CJ1,Highlight: {entity.data.lastName=[<em>Evans</em>]}"
    ]
}

A SearchResultResponse for a quote result (search query was the locator value 01J56JJ8N7S00XFBW8Z69Q94JX – note that the score is set to the highest in the highlights):

{
    "score": 102.0,
    "searchEntityType": "quote",
    "searchEntityLocator": "01J56JJ8N7S00XFBW8Z69Q94JX",
    "productName": "Basic_Homeowners",
    "accountLocator": "01J53T5V9B3ARJDF38CYY17CJ1",
    "searchSummary": {
        "state": "issued",
        "static": {
            "policyNumber": "123-31231"
        }
    },
    "highlights": [
        "Score:102.0 ,Document: 01J56JJ8N7S00XFBW8Z69Q94JX,Highlight: {entity.elements.staticLocator.keyword=[<em>01J56JJ8N7S00XFBW8Z69Q94JX</em>], entity.elements.locator.keyword=[<em>01J56JJ8N7S00XFBW8Z69Q94JX</em>]}",
        "Score:101.0 ,Document: 01J56JJ8N7S00XFBW8Z69Q94JX,Highlight: {entity.locator.keyword=[<em>01J56JJ8N7S00XFBW8Z69Q94JX</em>]}"
    ]
}

Configuration

Search is enabled by default, indexing both locators and data extension fields of type string. String field indexing includes data fields contained within Custom Data Types and in static data.

Locator indexing makes it possible to search for quotes, policies, and accounts by locator, along with elements by locator or static locator.

You may use the defaultSearchable and searchable configuration properties to more precisely control which string fields are indexed for search. defaultSearchable is available at the top level of the configuration, in addition to configuration for accounts, products, and elements. When defaultSearchable is true, all string fields at that level and below are indexed. When defaultSearchable is false, then a string field must have searchable set to true in order to be indexed for search. For a given field, the nearest defaultSearchable value when going up the configuration hierarchy applies.

See Also

  • Search API reference


© Copyright 2024, Socotra.

Built with Sphinx using a theme provided by Read the Docs
.