The tables below contain lookup values used in the API.
Click here to see list of all iEdison enrolled agencies. Be advised that the API cannot be used for agencies that have the following red notice “THIS AGENCY IS CURRENTLY INACTIVE IN IEDISON”
List of available Agreement Types
| Value |
|---|
| Cooperative Agreement |
| Grant |
| Contract |
| ACT = DoE Specific |
| Other Funding Agreement |
List of the Invention funding agreement Award types
| Value |
|---|
| Prime Award |
| Sub-Award |
A list of valid country Names and FIPs Country Codes.
| Name | FIPs Country Codes |
|---|---|
| AFGHANISTAN | AF |
| African Manufacturer Intellectual Property Organization | OAPI |
| African Regional Manufacturer Intellectual Property Organization | ARIPO |
| ALBANIA | AL |
| ALGERIA | AG |
| ANDORRA | AN |
| ANGOLA | AO |
| ANGUILLA | AV |
| ANTIGUA/BARBUD | AC |
| ARGENTINA | AR |
| ARMENIA | AM |
| ARUBA | AA |
| AUSTRALIA | AS |
| AUSTRIA | AU |
| AZERBAIJAN | AJ |
| BAHAMAS | BF |
| BAHRAIN | BA |
| BANGLADESH | BG |
| BARBADOS | BB |
| BELARUS | BO |
| BELGIUM | BE |
| BELIZE | BH |
| BENIN | BN |
| BERMUDA | BD |
| BHUTAN | BT |
| BOLIVIA | BL |
| BOSNIA/HERZEG | BK |
| BOTSWANA | BC |
| BRAZIL | BR |
| BRITISH VI ISS | VI |
| BRUNEI | BX |
| BULGARIA | BU |
| BURKINA | UV |
| BURUNDI | BY |
| CABO VERDE | CV |
| CAMBODIA | CB |
| CAMEROON | CM |
| CANADA | CA |
| CAYMAN ISLANDS | CJ |
| CENTRAL AFR R | CT |
| CHAD | CD |
| CHILE | CI |
| CHINA | CH |
| COLOMBIA | CO |
| COMOROS | CN |
| CONGO | CF |
| CONGO DEM REP | CG |
| COSTA RICA | CS |
| COTE D’IVOIRE | IV |
| CROATIA | HR |
| CUBA | CU |
| CYPRUS | CY |
| CZECH REPUBLIC | EZ |
| DENMARK | DA |
| DJIBOUTI | DJ |
| DOMINICA | DO |
| DOMINICAN REP | DR |
| ECUADOR | EC |
| EGYPT | EG |
| EL SALVADOR | ES |
| EQUATOR GUINEA | EK |
| ERITREA | ER |
| ESTONIA | EN |
| ESWATINI | WZ |
| ETHIOPIA | ET |
| Eurasian Patent Organization | EAPO |
| European Patent Organization | EPO |
| FALKLAND ISS | FX |
| FIJI | FJ |
| FINLAND | FI |
| FRANCE | FR |
| FRENCH POLYNES | FP |
| GABON | GB |
| GAMBIA | GA |
| GAZA STRIP | GZ |
| GEORGIA | GG |
| GERMANY | GM |
| GHANA | GH |
| GIBRALTAR | GI |
| GREECE | GR |
| GREENLAND | GL |
| GRENADA | GJ |
| GUATEMALA | GT |
| GUERNSEY | GK |
| GUINEA | GV |
| GUINEA-BISSAU | PU |
| GUYANA | GY |
| HAITI | HA |
| HONDURAS | HO |
| HONG KONG | HK |
| HUNGARY | HU |
| ICELAND | IC |
| INDIA | IN |
| INDONESIA | ID |
| IRAN | IR |
| IRAQ | IZ |
| IRELAND | EI |
| ISRAEL | IS |
| ITALY | IT |
| JAMAICA | JM |
| JAPAN | JA |
| JERSEY | JE |
| JORDAN | JO |
| KAZAKHSTAN | KZ |
| KENYA | KE |
| KIRIBATI | KR |
| KOREA PEO REP | KN |
| KOREA REP OF | KS |
| KOSOVO | KV |
| KUWAIT | KU |
| KYRGYZSTAN | KG |
| LAOS | LA |
| LATVIA | LG |
| LEBANON | LE |
| LESOTHO | LT |
| LIBERIA | LI |
| LIBYA | LY |
| LIECHTENSTEIN | LS |
| LITHUANIA | LH |
| LUXEMBOURG | LU |
| MACAU | MC |
| MADAGASCAR | MA |
| MALAWI | MI |
| MALAYSIA | MY |
| MALDIVES | MV |
| MALI | ML |
| MALTA | MT |
| MAURITANIA | MR |
| MAURITIUS | MP |
| MEXICO | MX |
| MOLDOVA | MD |
| MONACO | MN |
| MONGOLIA | MG |
| MONTENEGRO | MW |
| MONTSERRAT | MH |
| MOROCCO | MO |
| MOZAMBIQUE | MZ |
| MYANMAR | BM |
| NAMIBIA | WA |
| NAURU | NR |
| NEPAL | NP |
| NETHERLANDS | NL |
| NEW ZEALAND | NZ |
| NICARAGUA | NU |
| NIGER | NG |
| NIGERIA | NI |
| NORTH MACEDONIA | MK |
| NORWAY | NO |
| OMAN | MU |
| PAKISTAN | PK |
| PANAMA | PM |
| PAPUA N GUINEA | PP |
| PARAGUAY | PA |
| Patent Office of the Cooperation Council for the Arab States of the Gulf | GCCPO |
| PERU | PE |
| PHILIPPINES | RP |
| POLAND | PL |
| PORTUGAL | PO |
| QATAR | QA |
| ROMANIA | RO |
| RUSSIA | RS |
| RWANDA | RW |
| SAMOA | WS |
| SAN MARINO | SM |
| SAO TOME/PRINC | TP |
| SAUDI ARABIA | SA |
| SENEGAL | SG |
| SERBIA | SR |
| SEYCHELLES | SE |
| SIERRA LEONE | SL |
| SINGAPORE | SN |
| SLOVAKIA | LO |
| SLOVENIA | SI |
| SOLOMON ISS | BP |
| SOMALIA | SO |
| SOUTH AFRICA | SF |
| SOUTH SUDAN | SS |
| SPAIN | SP |
| SRI LANKA | CE |
| ST HELENA | SH |
| ST KITTS/NEVIS | SC |
| ST LUCIA | ST |
| ST VINCENT/GRN | VC |
| SUDAN | SU |
| SURINAME | NS |
| SWEDEN | SW |
| SWITZERLAND | SZ |
| SYRIA | SY |
| TAIWAN | TW |
| TAJIKISTAN | TI |
| TANZANIA U REP | TZ |
| THAILAND | TH |
| TIMOR-LESTE | TT |
| TOGO | TO |
| TONGA | TN |
| TRINIDAD/TOBA | TD |
| TUNISIA | TS |
| TURKEY | TU |
| TURKMENISTAN | TX |
| TURKS/CAICOS I | TK |
| TUVALU | TV |
| UGANDA | UG |
| UKRAINE | UP |
| Unified Patent Court | UPC |
| UNITED ARAB EM | TC |
| UNITED KINGDOM | UK |
| UNITED STATES | US |
| URUGUAY | UY |
| UZBEKISTAN | UZ |
| VANUATU | NH |
| VENEZUELA | VE |
| VIETNAM | VM |
| WEST BANK | WE |
| YEMEN | YM |
| YUGOSLAVIA | YO |
| ZAMBIA | ZA |
| ZIMBABWE | ZI |
List of available Invention Development Stages
| Value |
|---|
| Commercialized |
| Licensed |
| Not Licensed |
The decision of the agency as to how to proceed with the technology. This field will be auto populated or set by the Primary Agency. It will be populated automatically to “Barred” if a Patent is not filed within one year of the “Date of the First Publication/Sale/Public Use” or as “Void,” “Transferred/Assigned” after a request is granted. Otherwise, the Disposition Status will be set by the Primary Agency in response to the selection of “Does Not Retain Title.”
| Value | Notes |
|---|---|
| Government Does Not Retain Rights | Active status to allow for agency clients to use in the request only. Organization can only view this in response data. |
| Government Retains Rights | Active status to allow for agency clients to use in the request only. Organization can only view this in response data. |
| Not Elect Title – Waive to Government | Non-Active status for response data view only. This shall not be used in the request for create or update. |
| Not Elect Title – Waive to Third Party | Non-Active status for response data view only. This shall not be used in the request for create or update. |
| Request for Inventor Waiver | Non-Active status for response data view only. This shall not be used in the request for create or update. |
| Assignment Approved | Non-Active status for response data view only. This shall not be used in the request for create or update. |
| Assignment Denied | Non-Active status for response data view only. This shall not be used in the request for create or update. |
| Barred | Active status to allow system to automatically set the Barred status. This status is used in response data only. This value shall not be used in API create or update request. |
| Voided | Active status value. Primary Agency can update the disposition status to Voided with API update request only. Title Election Status will change to Voided when Disposition Status is updated to Voided. |
| Transferred | Active status value. But it cannot be used in API create or update request. Response data for Organization. This will be set automatically when the Primary Agency approves the request. Note: Transferred status is for response data only. Updating an Invention to transfer status must go through Web Application Interface. |
The Invention Does Not Retain Title Reason values must be provided when the Title Election Status is set to “Does Not Retain Title”.
| Value |
|---|
| Low Commercial Potential |
| Non-Patentable (Not Novel) |
| Non-Patentable (Not Useful) |
| Non-Patentable (Obvious) |
| Did Not Yield Expected Results |
| Budget Limitation |
| Immature Market |
| Other |
Is inventor a federal employee?
| Value |
|---|
| true |
| false |
List of available Patent filing status
| Value |
|---|
| Active |
| Expired |
| Abandoned |
The iEdison Patent Action Document Type.
| Value | Notes |
|---|---|
| CL | Confirmatory License |
| SC | Government Support Clause |
The iEdison Patent Action Type.
| Value | Notes |
|---|---|
| A | Accept |
| R | Reject |
List of available Patent Application Types
| Patent Application Type | Description | Notes |
|---|---|---|
| CIP | Continuation-In-Part | Active Patent application type. This can be used in the Patent create and update API requests. |
| CON | Continuation | Active Patent application type. This can be used in the Patent create and update API requests. |
| CPA | Continued Prosecution Application | Non-Active Patent application type. This can NOT be used in the Patent create and update API requests. |
| DIV | Divisional | Active Patent application type. This can be used in the Patent create and update API requests. |
| FWC | File Wrapper Continuing | Non-Active Patent application type. This can NOT be used in the Patent create and update API requests. |
| ORD | Ordinary Utility | Active Patent application type. This can be used in the Patent create and update API requests. |
| PROV | Provisional | Active Patent application type. This can be used in the Patent create and update API requests. |
| PVP | Plant Variety Protection | Active Patent application type. This can be used in the Patent create and update API requests. |
| RCE | Request for Continued Examination | Non-Active Patent application type. This can NOT be used in the Patent create and update API requests. |
| PCT | PCT Designating the US | Active Patent application type. This can be used in the Patent create and update API requests. |
The iEdison Patent status list of value.
| Value | Notes |
|---|---|
| Transferred/Assigned | This status value shall not be used in API request. Organization needs to use the UI to submit a Transfer Patent Request. |
| Voided | This status value shall not be used in API request. Organization needs to use the UI to submit a Void Patent Request. |
| Expired | This status value shall be used for the Patent Application Types of DIV, ORD, PVP, CIP, and CON |
| Abandoned/Intent to Abandon | This value can be used for both organization and agency clients in the Patent request |
| Institution Retains Rights | This value can be used for both organization and agency clients in the Patent request |
The 2-letter code for U.S. states and territories. For use contractorState and Utilization Manufacturing locations. Use the appropriate ‘Code’ for in the request.
| Name | Code |
|---|---|
| ALABAMA | AL |
| ALASKA | AK |
| ALBERTA | AB |
| AMERICAN SAMOA | AS |
| AP0/FP0 EUROPE | AE |
| AP0/FP0 OT PAC | AP |
| AP0/FP0 S AMER | AA |
| ARIZONA | AZ |
| ARKANSAS | AR |
| BAKER ISLAND | FQ |
| BR. COLUMBIA | BC |
| CALIFORNIA | CA |
| COLORADO | CO |
| CONNECTICUT | CT |
| DELAWARE | DE |
| DIST OF COL | DC |
| FED MICRONESIA | FM |
| FLORIDA | FL |
| GEORGIA | GA |
| GUAM | GU |
| HAWAII | HI |
| HOWARD ISLAND | HQ |
| IDAHO | ID |
| ILLINOIS | IL |
| INDIANA | IN |
| IOWA | IA |
| JOHNSTON ATOLL | JQ |
| KANSAS | KS |
| KENTUCKY | KY |
| KINGMAN REEF | KQ |
| LOUISIANA | LA |
| MAINE | ME |
| MANITOBA | MB |
| MARSHALL IS | MH |
| MARYLAND | MD |
| MASSACHUSETTS | MA |
| MICHIGAN | MI |
| MIDWAY ISLANDS | MQ |
| MINNESOTA | MN |
| MISSISSIPPI | MS |
| MISSOURI | MO |
| MONTANA | MT |
| NAVASSA ISLAND | BQ |
| NEBRASKA | NE |
| NEVADA | NV |
| NEW BRUNSWICK | NB |
| NEW HAMPSHIRE | NH |
| NEW JERSEY | NJ |
| NEW MEXICO | NM |
| NEW YORK | NY |
| NEWFOUNDLAND | NL |
| NORTH CAROLINA | NC |
| NORTH DAKOTA | ND |
| NORTHN MARIANA | MP |
| NOVA SCOTIA | NS |
| NW TERRITORIES | NT |
| OHIO | OH |
| OKLAHOMA | OK |
| ONTARIO | ON |
| OREGON | OR |
| PALAU | PW |
| PALMYRA ATOLL | LQ |
| PENNSYLVANIA | PA |
| PR. EDWARD ISL | PE |
| PUERTO RICO | PR |
| QUEBEC | PQ |
| QUEBEC | QC |
| RHODE ISLAND | RI |
| SASKATCHEWAN | SK |
| SOUTH CAROLINA | SC |
| SOUTH DAKOTA | SD |
| TENNESSEE | TN |
| TEXAS | TX |
| TRUST TER PACF | PS |
| US MINOR OUTLY | UM |
| UTAH | UT |
| VERMONT | VT |
| VIRGIN ISLANDS | VI |
| VIRGINIA | VA |
| WAKE ISLAND | WQ |
| WASHINGTON | WA |
| WEST VIRGINIA | WV |
| WISCONSIN | WI |
| WYOMING | WY |
| YUKON | YT |
The decision of the institution regarding the election of title for this Invention.
The ‘Draft’ ‘Voided’, and ‘Transferred’ status values shall not be used when submitting Invention Create or Update API requests.
‘Only Elect to Retain Title’ and ‘Does Not Retain Title’ status will be allowed when submitting Invention Create Requests.
‘Designated as Unpatented Biological Material or Research Tool’ status is not available for DOE
| Value | Notes |
|---|---|
| Elect to Retain Title | This can be used for both organization and agency clients in the create or update request. |
| Does Not Retain Title | This can be used for both organization and agency clients in the create or update Invention request. Once the Invention is saved with this status, organization client will no longer allow to modify the Invention metadata. |
| Designated as Unpatented Biological Material or Research Tool | This can be used for both organization and agency clients in the update request. |
| Under Evaluation | Allow both organization and agency clients to use in the update request. |
| Draft | This status is used in response data only. This status value shall not be used in API create or update request. |
| Voided | This status is used in response data only. This status value shall not be used in API request. The organization is required to use the UI to submit an Invention Void Request. |
| Transferred | This status is use in response data only. This status value shall not be used in API request. The organization is required to use the UI to submit an Invention Transfer Request. |
| Government Takes Title (Award Terms) | If an invention is created by a large for-profit private organization that receives funding from the Department of Energy (DOE), and a DOE Waiver ID has not been issued, the iEdison system will automatically set the status to “Not Waived.” Users and administrators from the DOE and the National Nuclear Security Administration (NNSA) can update this status using the Restful API Services. For all other agencies, updates can only be made through the nightly job. |
| Value |
|---|
| Biologic |
| Medical Device |
| Drug |
| Value |
|---|
| Approved |
| Rejected |
| Pending |
| Value |
|---|
| Yes |
| No |
| Value |
|---|
| Actual |
| Expected |
| Value | Notes |
|---|---|
| 1 | Seeking additional funding to further develop this invention |
| 2 | Marketing and/or furthering development of this invention to attract commercial partners |
| 3 | Developing and/or using this invention for internal purposes only |
| 4 | Developing and/or preparing this invention with intent to commercialize ourselves |
| 5 | Making available for distribution and/or licensing for research purposes only |
| 6 | No current commercialization plan |
This section shows the dynamic question flow if the lastestStageDev = “Licensed” for Questions 8 and 9. The answer to Question 8 will determine which variation of Question 9 should be answered.
Question 8 is for the attribute USManufacturingRequired1. Question 9 is for the attribute isUSManufacturingRequired2.
![Figure 121: Licensed Utilization Questions]
This section shows the dynamic question flow if the lastestStageDev = “Commercialized” for Questions 8, 9 and 10. The answer to Question 8 will determine which variation of Question 9 and Question 10 should be answered.
Question 8 is for the attribute USManufacturingRequired1. Question 9 is for the attribute isUSManufacturingRequired2. Question 10 is for the attribute USManufacturingRequired3.
![Figure 122: Commercialized Utilization Questions]
This section contains a list of Document Type Name for Invention and Patent. These values are used in the document search to target for specific documentType filter.
| Value |
|---|
| Assignment |
| Confirmatory License |
| Domestic Manufacture Waiver |
| Election Extension |
| Foreign Filing |
| General |
| Government Support Clause |
| Greater Rights Determination |
| Invention Disclosure |
| Nonpatented Research Resource |
| Other Documents |
| Patent Extension |
| Provisional Extension |
| USPTO Recordation |
| Title Extension |
| Transfer |
| Waiver |
| Void |
| Domestic Manufacture Waiver Approval Letter |
| Publication |
| Custom Report |