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

# Search a long list of a market rater version

> Find the answers of a long list, such as car models, that match what the person typed. A planning question of kind `search` names its list. Matching is by the same fixed rules as [Search the answers of a planning question](#): case, spacing and punctuation folded; an exact label, an exact other name, a label that starts with the query, each typed word a word prefix, the same for other names, then a small misspelling; ties in the list’s order.

When `query` holds a word and nothing matches, `noMatch` is true and `choices` holds first the answers the query says in full and adds to (`RAV4 XLE` says `RAV4`), then the answers the list marks as standing for anything it does not name, in list order. It is empty when the list has neither. Tell the person nothing matched before offering them. An empty `query` returns the first answers and never sets `noMatch`.



## OpenAPI

````yaml /openapi.json get /insurance/rating-programs/{id}/versions/{version}/lists/{name}
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /insurance/rating-programs/{id}/versions/{version}/lists/{name}:
    get:
      tags:
        - Market raters
      summary: Search a long list of a market rater version
      description: >-
        Find the answers of a long list, such as car models, that match what the
        person typed. A planning question of kind `search` names its list.
        Matching is by the same fixed rules as [Search the answers of a planning
        question](#): case, spacing and punctuation folded; an exact label, an
        exact other name, a label that starts with the query, each typed word a
        word prefix, the same for other names, then a small misspelling; ties in
        the list’s order.


        When `query` holds a word and nothing matches, `noMatch` is true and
        `choices` holds first the answers the query says in full and adds to
        (`RAV4 XLE` says `RAV4`), then the answers the list marks as standing
        for anything it does not name, in list order. It is empty when the list
        has neither. Tell the person nothing matched before offering them. An
        empty `query` returns the first answers and never sets `noMatch`.
      operationId: searchRatingProgramList
      parameters:
        - schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            description: The market rater’s ID, such as `effective.example-ca-ppa`.
          required: true
          description: The market rater’s ID, such as `effective.example-ca-ppa`.
          name: id
          in: path
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            description: The published version number.
          required: true
          description: The published version number.
          name: version
          in: path
        - schema:
            type: string
            minLength: 1
            maxLength: 200
          required: true
          name: name
          in: path
        - schema:
            type: string
            maxLength: 200
            default: ''
          required: false
          name: query
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
          required: false
          name: limit
          in: query
      responses:
        '200':
          description: >-
            Up to `limit` matches, best first; or, with `noMatch`, the answers
            the query says in full, then the list’s catch-all answers.
          content:
            application/json:
              schema:
                type: object
                properties:
                  choices:
                    type: array
                    items:
                      nullable: true
                    description: >-
                      Each `{value, label}`, with `catchAll: true` on an answer
                      that stands for every answer the list does not name. With
                      an empty `query` such answers come last.
                  noMatch:
                    type: boolean
                    description: >-
                      Present and true when `query` holds a word and matches
                      nothing: `choices` is then the answers the query says in
                      full and adds to, followed by the list’s catch-all
                      answers; empty when it has neither.
                required:
                  - choices
                additionalProperties: false
        '400':
          description: Invalid request or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            Your organization’s access to the rater, or your permission, is
            missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: The rater, version or package is not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            version_not_loadable: this server’s rating engine cannot load the
            version; it was built for another release of the engine. Leave the
            version out to use the newest version this server loads; with no
            version named, none of the newest loads. conflict: the engine that
            serves this version differs from the engine it records. Retry later;
            if it persists, contact Effective.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: The inputs exceed 1 MiB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: The request body is not application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '422':
          description: >-
            invalid_inputs or business_rejection: violations lists each failed
            constraint. evaluation_failed: the engine could not rate the inputs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Too many requests, or no rating capacity. Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: A dependency is unavailable. Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: Not currently returned.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.