API Error Troubleshooting

This page provides guidance on the most commonly received Application Programming Interface (API) error messages, but the list is not exhaustive. If you have additional questions about API errors, you can contact the iEdison Help Desk.

Invention Report Errors

Patent Report Errors

Invention Report Errors

When submitting an Invention Create API request, you received an error message stating "inventionDisclosure file is required."

When submitting an Invention Report with the Invention Create API, the invention disclosure document is required. Ensure a valid file is provided with the form data named 'inventionDisclosure'.

When submitting an Invention Update API request, you received an error message stating "Government Takes Title (Award Terms) can only be set by the iEdison system."

The Title Election Status value "Government Takes Title (Award Terms)" is used by the iEdison system in an automated-invention check daily process only. Invention Reports with the following conditions will be set to "Government Takes Title (Award Terms)":

1. The Invention Report has the Primary Funding Agency as Department of Energy (DOE).
2. The Invention Report has a large for-profit Grantee/Contractor Organization.
3. The Invention Report does not have a DOE Waiver ID.
4. The Invention Report has a Title Election Status value ""Under Evaluation"" or ""Elect to Retain Title""."

When submitting an Invention Update API request, you received an error message stating "API is not allowed to update to [Voided/Transferred]. Please use the Web UI to submit a request."

All Invention Reports being voided or transferred/assigned must provide additional information and/or supporting documents for the Primary Funding Agency to review prior to the final decision. The Grantee/Contractor Organization must log in to the iEdison system and manually submit a Void, Assignment, or Transfer request with the additional information.

When submitting an Invention Update API request, you received an error message stating "Changing Status to Does Not Retain Title must have all patent rights abandoned by Institution."

For a Grantee/Contractor Organization to choose "Does Not Retain Title" on the Invention Report, the organization/institution must change the patent reports to "Abandoned/Intent to Abandon" status first through the Patent Update API or the web UI at https://iedison.nist.gov/.

Patent Report Errors

When submitting a Patent Update API request, you received an error message stating "provisionalApplicationNumber: <##/###,###> does not exist in the system."

1. The patent application does not exist in the iEdison system. Log in to iEdison with a web browser, access the Patent Search page, and enter the Provisional Application Number value in the "Patent Application Number" field to ensure the Patent Record exists and is correct in the system.
2. The API request is updating the existing Patent Record with a new Provisional Application Number. Because the application number is the unique identifier used in the Patent Update API, the system will not be able to locate the patent with the new Provisional Application Number. If the user wants to edit the Provisional Application Number, they must log in to the iEdison application with a web browser to update the Provisional Application Number manually.

When submitting a Patent Update API request, you received an error message stating "pctApplicationNumber: does not exist in the system."

1. The patent application does not exist in the iEdison system. Log in to iEdison with a web browser, access the Patent Search page, and enter the PCT Application Number value in the "Patent Application Number" field to ensure the Patent Record exists and is correct in the system.
2. The API request is updating the existing Patent Record with a new PCT Application Number. Because the application number is the unique identifier used in the Patent Update API, the system will not be able to locate the patent with the new PCT Application Number. If the user wants to edit the PCT Application Number, they must log in to the iEdison application with a web browser to update the PCT Application Number manually.

When submitting a Patent Update API request, you received an error message stating "nonProvisionalApplicationNumber: <##/###,###> does not exist in the system."

1. The patent application does not exist in the iEdison system. Log in to iEdison with a web browser, access the Patent Search page, and enter the Non-Provisional Application Number value in the "Patent Application Number" field to ensure the Patent Record exists and is correct in the system.
2. The API request is updating the existing Patent Record with a new Non-Provisional Application Number. Because the application number is the unique identifier used in the Patent Update API, the system will not be able to locate the patent with the new Non-Provisional Application Number. If the user wants to edit the Non-Provisional Application Number, they must log in to the iEdison application with a web browser to update the Non-Provisional Application Number manually.