• client_id is now required in the request.

• Changes to claims_independent value claim_number. This now reflects the number, or number range of the claim as displayed by the patent
• For claims that span a range, the claim_number will be listed as a string covering the range of claims. I.E 1-10 covers claim numbers 1 to 10

New Features

New fields

• pct_number
• pct_date
• pct_country
• priority_number
• priority_country
• filing_type
• priority_claim
• linkage_type
• agents
• firms
• ip_type
• national_file_date

Improvements

• Identifiers named innography_id or innography_ids were renamed to ipid and ipids.

• Fields in the response that previously only contained publication_number now also contain ipid.

  The fields are:

  • simple_family
  • inpadoc_family
  • citations_backward
  • citations_forward

  For example:

  "simple_family": [
    "CN201988234U"
  ]
  

  is now

  "simple_family": [
    {
      "publication_number": "CN201988234U",
      "ipid": "I-000099999999"
    }
  ]
  

• legal_status now returns the data in a JSON structure instead of stringified XML.

    "legal_status": "<legal_status><event><gazette_date>2011-09-28</gazette_date><effective_date></effective_date><legal_code>C14</legal_code><country_legal_code>CN_C14</country_legal_code><legal_code_description>GRANTED</legal_code_description><assignor></assignor><assignee></assignee><text></text><opponent_name></opponent_name></event></legal_status>"
  

  is now

    "legal_status": {
      "event": {
        "gazette_date": "2011-09-28",
        "legal_code": "C14",
        "country_legal_code": "CN_C14",
        "legal_code_description": "GRANTED"
      }
  },
  

• art_unit_desc no longer contains the ID embedded in it.

  {
    "art_unit_id": 42,
    "art_unit_desc": "42: The Answer"
  }
  

  is now

  {
    "art_unit_id": 42,
    "art_unit_desc": "The Answer"
  }
  

• Integer fields are now returned as integers instead of strings:

  • art_unit_id
  • assignee
  • assignee_original
  • assignee_ultimate
  • citations_backward_num
  • citations_forward_num
  • claims_first_wordcount
  • claims_count
  • simple_family_id
  • inpadoc_family_id
  • patentstrength

• Changes to claims_independent value claim_number. This now reflects the number of the claim as displayed by the patent
• For claims that span a range, only the first claim number for that range is listed
• To get full range, please use version 0.8

• Resolved and issue that would cause 500 errors on cases where first_page_clipping was requested, but no clippings were found.

This issue was filed to APP-19380.

• status field now correctly returns ‘Active’ or ‘Expired’ rather than estimated expiration dates

• Added example collection to specification

Fixes exceptions encountered when querying for citations.

• Added new premium field patentstrength
• Only the preferred document for a case is now returned instead of all the documents.
• citations_backward and citations_forward now return results.

• grant_date field was throwing an exception.
• grant_number, grant_date, publication_date, grant_pulication_date, and expiration_date were not exposed by the /case endpoint.

Changes from v0.6.x

0.7 version of Cases and Case endpoint added;

The Cases and Case endpoint have been updated to now give back an array objects each containing the id and title for usc_all, ipc_all, and cpc_all. The id field is the previous value returned in the 0.6 version.

Weekly Changelog

Changes that shipped with v0.6.13 on 2017-11-03

The permissions scheme for premium fields have been overhauled for this release. Now when a client_id requests a premium field for which they do not have access, the return will contain a warning message listing the inappropriately accessed fields while still return the data.

The endpoints specific to premium field queries have been removed, and two new endpoints have been created to allow IPMS consumers to define which client_ids have access to the any given subset of premium fields. More details are in the specification.

Changes that shipped with v0.6.10 on 2017-10-13

This release implements premium endpoints for the Cases API. These will be the only endpoints through which premium fields are available. Querying the existing endpoints for premium fields will now result in an error.

Clients can access the premium endpoints at /premium/case and /premium/cases for both GET and POST requests. The PDF endpoint is unaffected.

This release also adds support for 5 additional fields to the Cases API. They are;

• grant_number
• grant_date
• publication_date
• grant_publication_date
• expiration_date - Available as a premium field

More details are in the specification.

Other Changes;

• Improvements to claims rendering for patent documents in several jurisdictions

• Changes to claims_independent value claim_number. This now reflects the number of the claim as displayed by the patent
• For claims that span a range, only the first claim number for that range is listed
• To get full range, please use version 0.8

• Added example collection to specification

Fixes exceptions encountered when querying for citations.

• Added new premium field patentstrength
• Only the preferred document for a case is now returned instead of all the documents.
• citations_backward and citations_forward now return results.

• grant_date field was throwing an exception.
• grant_number, grant_date, publication_date, grant_pulication_date, and expiration_date were not exposed by the /case endpoint.

No significant changes from previous version.

The permissions scheme for premium fields have been overhauled for this release. Now when a client_id requests a premium field for which they do not have access, the return will contain a warning message listing the inappropriately accessed fields while still return the data.

The endpoints specific to premium field queries have been removed, and two new endpoints have been created to allow IPMS consumers to define which client_ids have access to the any given subset of premium fields. More details are in the specification.

No significant changes from previous version.

This version restores the full field set to the Cases API on both premium and non-premium endpoints. The restriction of premium fields to the premium endpoint will occur in a future version.

This release implements premium endpoints for the Cases API. These will be the only endpoints through which premium fields are available. Querying the existing endpoints for premium fields will now result in an error.

Clients can access the premium endpoints at /premium/case and /premium/cases for both GET and POST requests. The PDF endpoint is unaffected.

This release also adds support for 5 additional fields to the Cases API. They are;

• grant_number
• grant_date
• publication_date
• grant_publication_date
• expiration_date - Available as a premium field

More details are in the specification.

Other Changes;

• Improvements to claims rendering for patent documents in several jurisdictions

This release restricts requests to the /cases endpoint to a maximum of 100 cases per request.

The API specification for the Cases endpoint has been updated to reflect the current state of the API and improve documentation of the available fields for query. It has added documentation for the /cases/{innography_id}/pdf and /aagroups endpoints.

The 0.6.7 release of the Cases API features changes to the documentation and specification pages to improve usability and readability. Enjoy the new format, and please send any suggestions for improvements through the contact form under “Report an issue” on the sidebar.

Other changes included in this release;

• Improved handling of documents requested with ipc_all that have empty classifications. Improved error handling around classifications.

• The Cases API has added the feature for a PDF download of the case documents. For example, to access the PDF associated with Innography ID I-000123456789 use the URL

  /case/I-000123456789/pdf
  

  That will initiate a PDF download. More details are available in the API specification.

This is the initial release for which release notes are being kept. The 0.6.6 release features no significant changes from previously available versions.