LawsSearchResponse

  • page
    Type: integer

    Integer numbers.

  • page_size
    Type: integer

    Integer numbers.

  • results
    Type: array object[] · LawSearchResult[]
    • citation
      Type: string nullable
    • collection_id
      Type: string
    • collection_type
      Type: string
    • country
      Type: string
    • effective_date
      Type: string Format: datenullable

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • id
      Type: string Format: uuid

      Document id — use with /laws/get

    • is_current
      Type: boolean

      Whether this document is the law in force today (derived)

    • is_historical
      Type: boolean

      Whether the source or ingestion pipeline marks this version superseded

    • node_type
      Type: string enum

      LEAF is a content section; PARENT a container; TOMBSTONE a repealed/reserved placeholder

      values
      • LEAF
      • PARENT
      • TOMBSTONE
    • number
      Type: string nullable

      Section/part number token

    • path
      Type: string

      ltree path within the collection

    • publication_date
      Type: string Format: datenullable

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • score
      Type: number nullable
    • snippets
      Type: array string[]

      Highlighted fragments ( marks matches)

    • state
      Type: string
    • title
      Type: string nullable

      Section title / catchline

    • url
      Type: string Format: uri

      Midpage page for this exact version

  • state_counts
    Type: object

    Estimated per-state hit counts for the whole query (not just this page). Verify each state with a filtered search.

    • propertyName
      Type: integer

      Integer numbers.

  • total
    Type: integer

    Estimated matching documents for the whole query