/api/v1/pg_brf_sum_text/

In data version 20261027.2 this endpoint answers 501 ERR_NOT_IMPLEMENTED: publications: pre-grant publications (/api/v1/publication/, /api/v1/publication/rel_app_text/ and the pg_claim, pg_brf_sum_text, pg_detail_desc_text and pg_draw_desc_text endpoints), deferred to a later build.

Upstream view PGBrfSumTextList (index pg_brf_sum_texts, response key pg_brf_sum_texts). Deferred: pre-grant publications are not in this snapshot yet; the endpoint answers 501 with X-Status-Reason-Code ERR_NOT_IMPLEMENTED. Any field may be null where the bulk data has no value. Default fields (f): document_number, summary_text. Default sort (s): [{"document_number": "asc"}].

Routes

GET POST /api/v1/pg_brf_sum_text/

Response key

pg_brf_sum_texts

Default f

document_number, summary_text

Default s

[{"document_number": "asc"}]

Default o

{}

q

required on the list route

Example

curl -s -G -H "X-Api-Key: $KEY" https://patentref.io/api/v1/pg_brf_sum_text/ \
  --data-urlencode 'q={"document_number": "<value>"}'

import json, os, requests

base_url = "https://patentref.io"
headers = {"X-Api-Key": os.environ["PATENTREF_KEY"]}
params = {"q": {"document_number": "<value>"}}
r = requests.get(base_url + "/api/v1/pg_brf_sum_text/", headers=headers,
                 params={k: json.dumps(v) for k, v in params.items()})
r.raise_for_status()
data = r.json()
print(data["total_hits"], data["pg_brf_sum_texts"][:3])

Fields

Kind is how q treats the field (grammar, Field kinds). Sortable fields go in s. Nested fields are named with a dot in q and f; naming the group returns its upstream fields, and a field whose note says it is present only when f names it comes back only then. The rows of a group come in the order of their source (grammar, the response and paging).

Machine-readable: this page's data as JSON, and the operation in openapi.json (operationId PGBrfSumTextList).