{ "swagger" : "2.0", "info" : { "version" : "0.0.1-SNAPSHOT", "title" : "VendorAPI" }, "basePath" : "/iedison", "tags" : [ { "name" : "apiv1inventions", "description" : "Create, Update and Search Inventions" }, { "name" : "apiv1patents", "description" : "Create, Update and Search Patents" }, { "name" : "apiv1utilizations", "description" : "Create, Update and Search Utilizations" } ], "schemes" : [ "https" ], "paths" : { "/v1/inventions/create" : { "post" : { "tags" : [ "apiv1inventions" ], "summary" : "Creates Invention", "description" : "Creates Invention : JSON for Create Invention is required", "operationId" : "createInvention", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "inventionDisclosure", "description" : "Invention Disclosure Document file upload", "type" : "file", "required": true }, { "in" : "formData", "name" : "inventionRequest", "description" : "Invention Request JSON content as string with #/definitions/InventionRequestDTO properties", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "The Invention Create is Successful", "schema" : { "$ref" : "#/definitions/InventionResponseDTO" } }, "400" : { "description" : "The Invention Creation encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "Error while performing Invention Creation. Please contact Admin", "schema" : { "$ref" : "#/definitions/Result" } } } } }, "/v1/inventions/search" : { "post" : { "tags" : [ "apiv1inventions" ], "summary" : "Searches Inventions based on Search Criteria", "description" : "Searches Inventions : Search Criteria JSON for Invention is required", "operationId" : "searchInvention", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "inventionSearchCriteria", "description" : "Invention Search Criteria JSON content in string with the #/definitions/InventionSearchCriteriaDTO properties", "required" : true, "type": "string" } ], "responses" : { "200" : { "description" : "The Invention Search is Successful", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/InventionResponseDTOList" } } }, "400" : { "description" : "The Invention Search encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "The Invention Search encountered an unknow system error", "schema" : { "$ref" : "#/definitions/Result" } } } } }, "/v1/inventions/update" : { "post" : { "tags" : [ "apiv1inventions" ], "summary" : "Updates Invention", "description" : "Updates Invention : JSON for Update Invention is required", "operationId" : "updateInvention", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "inventionDisclosure", "description" : "Invention Disclosure Document file upload to add or update", "type" : "file", "required": false }, { "in" : "formData", "name" : "inventionRequest", "description" : "Invention Request JSON content as string with #/definitions/InventionRequestDTO properties", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "The Invention Update is Successful", "schema" : { "$ref" : "#/definitions/InventionResponseDTO" } }, "400" : { "description" : "The Invention Update encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "Error while performing Invention Updation. Please contact Admin", "schema" : { "$ref" : "#/definitions/Result" } } } } }, "/v1/patents/create" : { "post" : { "tags" : [ "apiv1patents" ], "summary" : "Creates Patent", "description" : "Creates Patent : JSON for Create Patent is required", "operationId" : "createPatent", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "patentRequest", "description" : "Create Patent Request JSON Content in string with the #/definitions/PatentRequestDTO properties", "type": "string", "required" : true }, { "in": "formData", "name": "confirmatoryLicense", "description": "The Confirmatory License document file upload for the Patent", "type": "file", "required": false }, { "in": "formData", "name": "governmentSupportClause", "description": "The Government Support Clause document file upload for the Patent", "type": "file", "required": false } ], "responses" : { "200" : { "description" : "The Patent Create is Successful", "schema" : { "$ref" : "#/definitions/PatentResponseDTO" } }, "400" : { "description" : "The Patent Creation encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "Error while performing Patent Creation. Please contact Admin", "schema" : { "$ref" : "#/definitions/Result" } } } } }, "/v1/patents/search" : { "post" : { "tags" : [ "apiv1patents" ], "summary" : "Searches Patents based on Search Criteria", "description" : "Searches Patents : Search Criteria JSON for Patents is required", "operationId" : "searchPatent", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "patentSearchCriteria", "type" : "string", "description" : "Patent Search Criteria JSON content in string with the #/definitions/PatentSearchCriteriaDTO properties", "required" : false } ], "responses" : { "200" : { "description" : "The Patent Search is Successful", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatentResponseDTOList" } } }, "400" : { "description" : "The Patent Search encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "Error while performing Patent Search. Please contact Admin", "schema" : { "$ref" : "#/definitions/Result" } } } } }, "/v1/patents/update" : { "post" : { "tags" : [ "apiv1patents" ], "summary" : "Updates Patent", "description" : "Updates Patent : JSON for Update Patent is required", "operationId" : "updatePatent", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "patentRequest", "description" : "Update Patent Request JSON Content in string with the #/definitions/PatentRequestDTO properties", "type": "string", "required" : true }, { "in": "formData", "name": "confirmatoryLicense", "description": "The Confirmatory License document file upload for the Patent to update or add", "type": "file", "required": false }, { "in": "formData", "name": "governmentSupportClause", "description": "The Government Support Clause document file upload for the Patent to update or add", "type": "file", "required": false } ], "responses" : { "200" : { "description" : "The Patent Update is Successful", "schema" : { "$ref" : "#/definitions/PatentResponseDTO" } }, "400" : { "description" : "The Patent Update encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "Error while performing Patent Updation. Please contact Admin", "schema" : { "$ref" : "#/definitions/Result" } } } } }, "/v1/utilizations/create" : { "post" : { "tags" : [ "apiv1utilizations" ], "summary" : "Creates Utilization", "description" : "Creates Utilization : JSON for Create Utilization is required", "operationId" : "createUtilization", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "utilizationRequest", "description" : "Create Utilization JSON Content in string with #/definitions/UtilizationRequestDTO model properties", "required" : true, "type": "string" } ], "responses" : { "200" : { "description" : "The Utilization Create is Successful", "schema" : { "$ref" : "#/definitions/UtilizationResponseDTO" } }, "400" : { "description" : "The Utilization Creation encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "Error while performing Utilization Creation. Please contact Admin" } } } }, "/v1/utilizations/search" : { "post" : { "tags" : [ "apiv1utilizations" ], "summary" : "Searches Utilizations based on Search Criteria", "description" : "Searches Utilizations : Search Criteria JSON for Utilization is required", "operationId" : "searchUtilization", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "utilizationSearchCriteria", "description" : "Utilization Search Criteria JSON content in string with #/definitions/UtilizationSearchCriteriaDTO Model properties", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "The Utilization Search is Successful", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UtilizationResponseDTOList" } } }, "400" : { "description" : "The Utilization Search encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "Error while performing Utilization Search. Please contact Admin", "schema" : { "$ref" : "#/definitions/Result" } } } } }, "/v1/utilizations/update" : { "post" : { "tags" : [ "apiv1utilizations" ], "summary" : "Updates Utilization", "description" : "Updates Utilization : JSON for Update Utilization is required", "operationId" : "updateUtilization", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "formData", "name" : "utilizationRequest", "description" : "Update Utilization JSON Content in string with #/definitions/UtilizationRequestDTO model properties", "required" : true, "type": "string" } ], "responses" : { "200" : { "description" : "The Utilization Update is Successful", "schema" : { "$ref" : "#/definitions/UtilizationResponseDTO" } }, "400" : { "description" : "The Utilization Update encountered a validation error", "schema" : { "$ref" : "#/definitions/Result" } }, "401" : { "description" : "Unauthorized access", "schema" : { "$ref" : "#/definitions/AccessDenied" } }, "500" : { "description" : "Error while performing Utilization Updation. Please contact Admin", "schema" : { "$ref" : "#/definitions/Result" } } } } } }, "definitions" : { "AccessDenied" : { "type" : "object", "properties" : { "message" : { "type": "string" }, "timestamp" : { "type" : "string", "format" : "date-time" } } }, "CommercialProductDTO" : { "type" : "object", "properties" : { "commercialName" : { "type" : "string", "example" : "Lyrica", "description" : "Commercial Product Name" }, "fdaApprovalNumber" : { "type" : "string", "description" : "FDA Approved Number" }, "publicInd" : { "type" : "string", "example" : "Yes", "description" : "Public Announced", "enum" : [ "Yes", "No" ] }, "govtReviewStatus" : { "type" : "string", "example" : "Approved", "description" : "FDA Government Review Status", "enum" : [ "Approved", "Rejected", "Pending" ] }, "fdaApprovalType" : { "type" : "string", "example" : "Biologic", "description" : "Commercial Product Type", "enum" : [ "Biologic", "Medical Device", "Drug" ] } } }, "Error" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "field" : { "type" : "string" }, "message" : { "type" : "string" } } }, "FundingAgreementDTO" : { "type" : "object", "properties" : { "agreementType" : { "type" : "string" }, "agency" : { "type" : "string" }, "grantNumber" : { "type" : "string" }, "awardType" : { "type" : "string" } } }, "InventionKeywordDTO" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "keyword" : { "type" : "string" } } }, "InventionRequestDTO" : { "type" : "object", "properties" : { "granteeOrganizationName" : { "type" : "string" }, "institutionCode" : { "type" : "string" }, "dunsNumber" : { "type" : "string" }, "inventionTitle" : { "type" : "string" }, "inventionDocketNumber" : { "type" : "string" }, "doesNumber" : { "type" : "string" }, "parentInventionNumber" : { "type" : "string" }, "inventionReportDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYY" }, "inventionSubmitDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYY" }, "firstPublicationDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYY" }, "doeWaiver" : { "type" : "string" }, "institutionCodeForOtherInstitutions" : { "type" : "array", "items" : { "type" : "string" } }, "keywords" : { "type" : "array", "items" : { "type" : "string" } }, "inventionReportNumber" : { "type" : "string" }, "inventors" : { "type" : "array", "items" : { "$ref" : "#/definitions/InventorDTO" } }, "primaryAgency" : { "type" : "string" }, "bayhDoleActVersion" : { "type" : "integer", "format" : "int32", "description" : "Indication of whether the original or 2018 regulations apply to this invention." }, "fundingAgreements" : { "type" : "array", "items" : { "$ref" : "#/definitions/FundingAgreementDTO" } }, "subContractInfos" : { "type" : "array", "items" : { "$ref" : "#/definitions/SubContractInfoDTO" } }, "inventionStatus" : { "$ref" : "#/definitions/InventionStatusDTO" }, "explanatoryNotes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VendorNotesDTO" } }, "governmentNotes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VendorNotesDTO" } }, "isInventionUnderFundingAgreement" : { "type" : "boolean" } }, "required" : ["inventionTitle", "primaryAgency", "inventionReportDate", "inventors", "fundingAgreements"] }, "InventionResponseDTO" : { "type" : "object", "properties" : { "inventionReportNumber" : { "type" : "string" }, "granteeOrganizationName" : { "type" : "string" }, "institutionCode" : { "type" : "string" }, "dunsNumber" : { "type" : "string" }, "inventionTitle" : { "type" : "string" }, "inventionDocketNumber" : { "type" : "string" }, "doesNumber" : { "type" : "string" }, "parentInventionNumber" : { "type" : "string" }, "inventionReportDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "inventionSubmitDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "reportingOverdue" : { "type" : "boolean" }, "firstPublicationDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "domesticManufactureWaiver" : { "type" : "boolean" }, "doeWaiver" : { "type" : "string" }, "institutionCodeForOtherInstitutions" : { "type" : "array", "items" : { "type" : "string" } }, "keywords" : { "type" : "array", "items" : { "type" : "string" } }, "inventors" : { "type" : "array", "items" : { "$ref" : "#/definitions/InventorDTO" } }, "primaryAgency" : { "type" : "string" }, "fundingAgreements" : { "type" : "array", "items" : { "$ref" : "#/definitions/FundingAgreementDTO" } }, "subContractInfos" : { "type" : "array", "items" : { "$ref" : "#/definitions/SubContractInfoDTO" } }, "explanatoryNotes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VendorNotesDTO" } }, "governmentNotes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VendorNotesDTO" } }, "inventionUnderFundingAgreement" : { "type" : "boolean" }, "inventionStatus" : { "$ref" : "#/definitions/InventionStatusDTO" } } }, "InventionResponseDTOList" : { "type" : "object", "properties" : { "inventions" : { "type" : "array", "items" : { "$ref" : "#/definitions/InventionResponseDTO" } }, "totalRecords" : { "type" : "integer", "format" : "int64" }, "limit" : { "type" : "integer", "format" : "int32" }, "offset" : { "type" : "integer", "format" : "int32" } } }, "InventionSearchCriteriaDTO" : { "type" : "object", "properties" : { "inventionReportNumber" : { "type" : "string" }, "inventionDocketNumber" : { "type" : "string" }, "inventionReportDateFrom" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "inventionReportDateTo" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "inventionTitle" : { "type" : "string" }, "primaryAgency" : { "type" : "string" }, "titleElectionStatus" : { "type" : "array", "items" : { "type" : "string" } }, "granteeOrganizationName" : { "type" : "string" }, "grantContractNumber" : { "type" : "string" }, "governmentCounsel" : { "type" : "string" }, "governmentStaff" : { "type" : "string" }, "inventionKeyword" : { "type" : "string" }, "inventorFirstName" : { "type" : "string" }, "inventorLastName" : { "type" : "string" }, "doeWaiver" : { "type" : "string" }, "domesticManufactureWaiver" : { "type" : "boolean" }, "limit" : { "type" : "integer", "format" : "int32" }, "offset" : { "type" : "integer", "format" : "int32" } } }, "InventionStatusDTO" : { "type" : "object", "properties" : { "titleElectionStatus" : { "type" : "string", "description" : "Indication of your institution's decision regarding the election of title for this invention.", "enum" : ["Elect to Retain Title", "Does Not Retain Title", "Designated as Unpatented Biological Material or Research Tool", "Under Evaluation"] }, "titleElectionDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "notElectTitleReason" : { "type" : "string", "description" : "If you select \"Does Not Retain Title\" as your Title Election Status, you must indicate why your institution decided not to take title.", "enum" : ["Low Commercial Potential", "Not Patentable – Not Novel", "Not Patentable – Obvious", "Not Patentable – Not Useful", "Other"] }, "notElectTitleOtherReason" : { "type" : "string" }, "dispositionStatus": { "type" : "string", "description" : "Decision of the agency as to how to proceed with the technology", "enum" : ["Government Does Not Retain Rights", "Government Retains Rights", "Barred", "Voided", "Transferred/Assigned"] }, "dispositionRightsDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "doesNotRetainTitleDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" } } }, "InventorDTO" : { "type" : "object", "properties" : { "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "fedEmployee" : { "type" : "boolean" }, "middleInitial" : { "type" : "string" }, "fedAgency" : { "type" : "string", "description" : "Federal Agency Abbreviation value from the agency list in documentation" } } }, "ManufacturingCommercialProductDTO" : { "type" : "object", "properties" : { "productName" : { "type" : "string", "description" : "Unique Commercial Product Name" }, "naicsCode" : { "type" : "string", "description" : "NAICS Code" }, "productLocation" : { "type" : "array", "description" : "Product Manufacturing Locations", "items" : { "$ref" : "#/definitions/ManufacturingCommercialProductLocationDTO" } } } }, "ManufacturingCommercialProductLocationDTO" : { "type" : "object", "properties" : { "state" : { "type" : "string", "example" : "Maryland", "description" : "Manufacturing Country" }, "firstDate" : { "type" : "string", "format" : "date", "example" : "04-04-2021", "description" : "First Date of Manufacturing" }, "firstDateType" : { "type" : "string", "example" : "Actual", "description" : "Manufacturing Date Type", "enum" : [ "Actual", "Expected" ] }, "productQuantity" : { "type" : "integer", "format" : "int32", "description" : "Total Number of Products at Location" }, "country" : { "type" : "string", "example" : "Greece", "description" : "Manufacturing Country" } } }, "NonProvisionalPatentApplicationDTO" : { "type" : "object", "description" : "If CIP, ORD, DIV, CON, or PVP is used in patentApplicationType, provide the value for this object", "properties" : { "nonProvisionalApplicationNumber" : { "type" : "string", "description" : "The serial number of the application that you are reporting." }, "nonProvisionalApplicationDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYY" }, "issuedApplicationNumber" : { "type" : "string", "description" : "Number given by USPTO once patent has been issued" }, "issuedApplicationDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "expirationDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" } } }, "ParentPatentDTO" : { "type" : "object", "properties" : { "inventionReportNumber" : { "type" : "string" }, "patentDocketNumber" : { "type" : "string" } } }, "PatentActionDTO" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "actionType" : { "type" : "string" }, "documentType" : { "type" : "string" }, "actionDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "reasonText" : { "type" : "string" } } }, "PatentForeignFilingDTO" : { "type" : "object", "properties" : { "countryName" : { "type" : "string", "example" : "Greece", "description" : "Patent Foreign Filing Country Name" }, "status" : { "type" : "string" }, "filingDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" } } }, "PatentRequestDTO" : { "type" : "object", "properties" : { "inventionReportNumber" : { "type" : "string" }, "granteeOrganizationName" : { "type" : "string" }, "patentDocketNumber" : { "type" : "string" }, "patentStatus" : { "type" : "string", "description" : "Patent Status", "enum" : [ "Transferred/Assigned", "Voided", "Expired", "Abandoned/Intent to Abandon", "Institution Retains Rights"] }, "patentTitle" : { "type" : "string" }, "patentApplicationType" : { "type" : "string", "description" : "Patent Application Type: Provisional (PROV), Continuation-In-Part (CIP), Continuation(CON), Divisional (DIV), Ordinary Utility (ORD), Plant Variety Protection (PVP), or Patent Cooperation Treaty Application (PCT)", "enum" : [ "PROV", "DIV", "ORD", "PVP", "PCT", "CIP", "CON" ] }, "parentPatents" : { "type" : "array", "items" : { "$ref" : "#/definitions/ParentPatentDTO" } }, "inventors" : { "type" : "array", "items" : { "$ref" : "#/definitions/InventorDTO" } }, "foreignFilings" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatentForeignFilingDTO" } }, "explanatoryNotes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VendorNotesDTO" } }, "provisionalPatentApplication" : { "$ref" : "#/definitions/ProvisionalPatentApplicationDTO" }, "nonProvisionalPatentApplication" : { "$ref" : "#/definitions/NonProvisionalPatentApplicationDTO" }, "pctPatentApplication" : { "$ref" : "#/definitions/PctPatentApplicationDTO" }, "governmentNotes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VendorNotesDTO" } }, "confirmatoryLicenseExcutionDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY", "description" : "Date that your Confirmatory License was executed." }, "pctAppNum" : { "type" : "string" }, "pctAppDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" } }, "required" : ["inventionReportNumber", "patentTitle", "patentApplicationType", "inventors"] }, "PatentResponseDTO" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "patentDocketNum" : { "type" : "string" }, "inventionReportNumber" : { "type" : "string" }, "issuedApplicationNumber" : { "type" : "string", "description" : "Number given by USPTO once patent has been issued" }, "issuedApplicationDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "pctAppNum" : { "type" : "string" }, "pctAppDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "provisionalAppNum" : { "type" : "string" }, "provisionalAppDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "nonProvisionalAppNum" : { "type" : "string" }, "nonProvisionalAppDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "patentApplicationType" : { "type" : "string" }, "patentStatus" : { "type" : "string" }, "patentReceiptDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "expireDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "patentTitle" : { "type" : "string" }, "confLicenseReceiptDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "confLicenseRejectDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "confLicenseRejectComment" : { "type" : "string" }, "confLicenseOutdated" : { "type" : "boolean" }, "govtSuppClauseReceiptDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "govtSuppClauseRejectDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "govtSuppClauseRejectComment" : { "type" : "string" }, "govtActionDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "domesticWaiverDecisionFlag" : { "type" : "boolean" }, "domesticWaiverDecisionDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "parentPatents" : { "type" : "array", "items" : { "$ref" : "#/definitions/ParentPatentDTO" } }, "executionDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "oldPatentRule" : { "type" : "boolean" }, "abandonedReason" : { "type" : "string" }, "extensionDays" : { "type" : "integer", "format" : "int32" }, "usptoAppStatus" : { "type" : "string" }, "usptoAppStatusDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "usptoLastSyncDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "assigned" : { "type" : "boolean" }, "explanatoryNotes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VendorNotesDTO" } }, "governmentNotes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VendorNotesDTO" } }, "govSupClauseActions" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatentActionDTO" } }, "inventors" : { "type" : "array", "items" : { "$ref" : "#/definitions/InventorDTO" } }, "foreignFilings" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatentForeignFilingDTO" } } } }, "PatentResponseDTOList" : { "type" : "object", "properties" : { "patents" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatentResponseDTO" } }, "totalRecords" : { "type" : "integer", "format" : "int64" }, "limit" : { "type" : "integer", "format" : "int32" }, "offset" : { "type" : "integer", "format" : "int32" } } }, "PatentSearchCriteriaDTO" : { "type" : "object", "properties" : { "inventionReportNumber" : { "type" : "string" }, "inventionDocketNumber" : { "type" : "string" }, "patentDocketNumber" : { "type" : "string" }, "primaryAgency" : { "type" : "string" }, "granteeOrganizationName" : { "type" : "string" }, "titleElectionStatus" : { "type" : "array", "items" : { "type" : "string" } }, "inventionTitle" : { "type" : "string" }, "inventionReportDateFrom" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "inventionReportDateTo" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "patentFilingDateFrom" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "patentFilingDateTo" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "patentApplicationType" : { "type" : "string" }, "patentStatus" : { "type" : "string" }, "patentTitle" : { "type" : "string" }, "grantContractNumber" : { "type" : "string" }, "inventorFirstName" : { "type" : "string" }, "inventorLastName" : { "type" : "string" }, "limit" : { "type" : "integer", "format" : "int32" }, "offset" : { "type" : "integer", "format" : "int32" } } }, "PctPatentApplicationDTO" : { "type" : "object", "description" : "If PCT is used in patentApplicationType, provide the value for this object", "properties" : { "pctApplicationNumber" : { "type" : "string" }, "pctApplicationDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" } } }, "ProvisionalPatentApplicationDTO" : { "type" : "object", "description" : "If PROV is used in patentApplicationType, provide the value for this object", "properties" : { "provisionalApplicationNumber" : { "type" : "string", "description" : "The serial number of the application that you are reporting." }, "provisionalApplicationDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" } } }, "Result" : { "type" : "object", "description" : "The validation or internal system error response result object", "properties" : { "responseCode" : { "type" : "integer", "format" : "int32" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/Error" } } } }, "SubContractInfoDTO" : { "type" : "object", "properties" : { "contractorState" : { "type" : "string" }, "contractorCity" : { "type" : "string" }, "contractorName" : { "type" : "string" }, "subContractNumber" : { "type" : "string" }, "contractorCountry" : { "type" : "string" }, "contractorDUNS" : { "type" : "string" }, "contractorUei" : { "type" : "string" } } }, "UtilizationRequestDTO" : { "type" : "object", "properties" : { "inventionReportNumber" : { "type" : "string" }, "reportingYear" : { "type" : "integer", "format" : "int32", "description" : "The four digit year of the utilization report year" }, "latestStageDev" : { "type" : "string", "description" : "", "enum" : ["Commercialized", "Licensed", "Not Licensed"] }, "firstCommercialSaleYear" : { "type" : "integer", "format" : "int32" }, "totalIncome" : { "type" : "number", "format" : "float" }, "manufacturingWaiver" : { "type" : "integer", "format" : "int32", "description" : "Did the grantee organization/contractor or any of the exclusive licensees request a waiver of the U.S. manufacturing requirements in the designated reporting period? 1 for Yes, 0 for No", "enum" : [1, 0] }, "manufacturingWaiverTotal" : { "type" : "integer", "format" : "int32" }, "domesticLicenseNumber" : { "type" : "integer", "format" : "int32" }, "exclusiveLicensesOptions" : { "type" : "integer", "format" : "int32" }, "nonExclusiveLicensesOptions" : { "type" : "integer", "format" : "int32" }, "smallBusinessLicensesOptions" : { "type" : "integer", "format" : "int32" }, "newUsJobs" : { "type" : "integer", "format" : "int32", "description" : "For DoE Invention: Approximate number of new US-based jobs created because of commercialization efforts during the reporting period." }, "newUsCompanies" : { "type" : "integer", "format" : "int32", "description" : "for DOE Invention: Number of new US-based companies created from the commercialization efforts during the reporting period." }, "utilizationDescription" : { "type" : "string", "description" : "For DOE Invention: Describe how the development and commercialization of the subject invention comply with any required U.S. manufacturing requirements (e.g., U.S. Preference, a U.S. Competitive Clause, U.S. Manufacturing Plan, etc.)" }, "fdaReportType" : { "type" : "string" }, "fdaApprovalNumber" : { "type" : "string" }, "totalGrossSales" : { "type" : "number", "format" : "float" }, "commercialProds" : { "type" : "array", "description" : "The commercial name of any FDA-approved products, utilizing this invention, that have first reached the market during the designated reporting period. For NIH related Invention", "items" : { "$ref" : "#/definitions/CommercialProductDTO" } }, "manufacturingCommProds" : { "type" : "array", "description" : "Unique Commercial Products Made Through the Use of or Embodying the Subject Invention which related to DOE agency", "items" : { "$ref" : "#/definitions/ManufacturingCommercialProductDTO" } } }, "required" : ["inventionReportNumber", "reportingYear", "latestStageDev"] }, "UtilizationResponseDTO" : { "type" : "object", "properties" : { "inventionReportNumber" : { "type" : "string" }, "granteeOrganizationName" : { "type" : "string" }, "inventionTitle" : { "type" : "string" }, "primaryAgency" : { "type" : "string" }, "inventionReportDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "titleElectDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "reportingYear" : { "type" : "integer", "format" : "int32" }, "latestStageDev" : { "type" : "string" }, "firstCommercialSaleYear" : { "type" : "integer", "format" : "int32" }, "totalIncome" : { "type" : "number", "format" : "float" }, "manufacturingWaiver" : { "type" : "integer", "format" : "int32" }, "manufacturingWaiverTotal" : { "type" : "integer", "format" : "int32" }, "exclusiveLicensesOptions" : { "type" : "integer", "format" : "int32" }, "domesticLicenseNumber" : { "type" : "integer", "format" : "int32" }, "nonExclusiveLicensesOptions" : { "type" : "integer", "format" : "int32" }, "smallBusinessLicensesOptions" : { "type" : "integer", "format" : "int32" }, "newUsJobs" : { "type" : "integer", "format" : "int32" }, "newUsCompanies" : { "type" : "integer", "format" : "int32" }, "utilizationDescription" : { "type" : "string" }, "totalGrossSales" : { "type" : "number", "format" : "float" }, "fdaApprovalNumber" : { "type" : "string" }, "commercialProds" : { "type" : "array", "items" : { "$ref" : "#/definitions/CommercialProductDTO" } }, "manufacturingCommProds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ManufacturingCommercialProductDTO" } } } }, "UtilizationResponseDTOList" : { "type" : "object", "properties" : { "utilizations" : { "type" : "array", "items" : { "$ref" : "#/definitions/UtilizationResponseDTO" } }, "totalRecords" : { "type" : "integer", "format" : "int64" }, "limit" : { "type" : "integer", "format" : "int32" }, "offset" : { "type" : "integer", "format" : "int32" } } }, "UtilizationSearchCriteriaDTO" : { "type" : "object", "properties" : { "inventionReportNumber" : { "type" : "string" }, "inventionDocketNumber" : { "type" : "string" }, "grantContractNumber" : { "type" : "string" }, "latestStageDev" : { "type" : "string" }, "primaryAgency" : { "type" : "string" }, "granteeOrganizationName" : { "type" : "string" }, "titleElectionStatus" : { "type" : "array", "items" : { "type" : "string" } }, "inventionTitle" : { "type" : "string" }, "inventionReportDateFrom" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "inventionReportDateTo" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" }, "fiscalYear" : { "type" : "integer", "format" : "int32" }, "commercialProductName" : { "type" : "string" }, "fdaReportType" : { "type" : "string" }, "fdaApprovalNumber" : { "type" : "string" }, "limit" : { "type" : "integer", "format" : "int32" }, "offset" : { "type" : "integer", "format" : "int32" } } }, "VendorNotesDTO" : { "type" : "object", "properties" : { "note" : { "type" : "string" }, "creatorName" : { "type" : "string" }, "createdDate" : { "type" : "string", "format" : "date", "pattern" : "MM/DD/YYYY" } } } } }