LawsGetResponse

Discriminated by status — found / ambiguous (404 for not_found).

  • children
    Type: array object[] · LawChild[]

    Present for container nodes — current children in authored order, capped at 250 (see children_total). Navigation only; fetch a child by id for its text. Empty for leaves.

    • citation
      Type: string nullable
    • 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
    • node_type
      Type: string
    • number
      Type: string nullable
    • path
      Type: string
    • sort_order
      Type: integer nullable

      Integer numbers.

    • title
      Type: string nullable
  • children_total
    Type: integer

    True number of current children (children[] holds at most 250)

  • document
    Type: object · LawDocument
    • citation
      Type: string nullable
    • collection_id
      Type: string
    • collection_name
      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

    • html
      Type: string nullable

      Verbatim document text as HTML (null for most containers)

    • id
      Type: string Format: uuid
    • is_current
      Type: boolean

      Derived — the law in force today

    • is_historical
      Type: boolean

      Source/pipeline marked this version superseded

    • node_type
      Type: string enum
      values
      • LEAF
      • PARENT
      • TOMBSTONE
    • number
      Type: string nullable
    • parent_id
      Type: string Format: uuidnullable

      Parent node — fetch it to zoom out to surrounding context

    • path
      Type: string
    • publication_date
      Type: string Format: datenullable

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

    • register_citation
      Type: string nullable
    • sort_order
      Type: integer nullable

      Integer numbers.

    • source_as_of
      Type: string Format: datenullable

      The source's own "current as of" date, when stated

    • source_url
      Type: string nullable

      The official source page

    • state
      Type: string
    • title
      Type: string nullable
    • url
      Type: string Format: uri

      Midpage page for this exact version

  • matches
    Type: array object[] · LawMatch[]

    Only for status=ambiguous — candidate documents; retry by id

    • citation
      Type: string nullable
    • collection_id
      Type: string
    • collection_type
      Type: string
    • id
      Type: string Format: uuid
    • is_current
      Type: boolean
    • path
      Type: string
    • state
      Type: string nullable
    • title
      Type: string nullable
  • message
    Type: string

    Only for status=not_found

  • status
    Type: string enum
    values
    • found
    • ambiguous
    • not_found
  • versions
    Type: array object[] · LawVersion[]

    The document's version chain (empty when it has no version history). Every version with dates and currency; is_requested marks the returned one.

    • 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
    • is_current
      Type: boolean
    • is_historical
      Type: boolean
    • is_requested
      Type: boolean

      True for the version returned as document

    • publication_date
      Type: string Format: datenullable

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

    • source_as_of
      Type: string Format: datenullable

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