Notification API Reference

The Notification API provide ways to search for a list of pending notifications. Search condition for notifications is the combination of attributes of the notificationSearchCriteria JSON object. The system will only return pending notifications which granted access permission to the user’s organization. Refer to Appendix E for samples of requests and responses.

Endpoint URI

This is an example of the endpoint for the Notification resource.

POST /iedison/api/v1/notifications/search

Request Parameters

The request has the following elements:

Headers: These are the request headers such as Accept or Content-Type. The Accept header defines the expected response format when the API returns the response. The Accept header is required for all requests.

Body: The body contains the data that will be submitted as the POST request. When submitting a form, the format data and file content are sent in the body of the request.

The table below provides the explanation of the Notification request header and body parameters that are expected by the iEdison API.

Request Parameter Description Required Data Type Version In
accept Specifies the response format that is expected. Set to “application/json”. Yes String v1 header
notificationSearchCriteria The notificationSearchCriteria JSON objects containing fields to be used in the search. Refer to the table below for a description of the attributes. Yes String v1 form-data

The table below lists the attributes that will be included in the notificationSearchCriteria parameter when searching for a notification. The attributes are included in the JSON object as part of the notificationSearchCriteria form-data text element.

JSON Attribute Name Description Required Data Type Length Version
inventionReportNumber Automatically generated by iEdison for an Invention Report after data has been submitted, checked for errors, and verified. No String 100 v1
patentDocketNumber The Patent Docket Number is an internal reference number of the grantee/contractor organization to help track a reported Patent(s). No String 30 v1
messageNumber Search for the “MessageNumber” of a pending notification No Integer 4 v1
fiscalYear Search for the “FiscalYear” of a pending notification, Format: 4-digit “YYYY” No Integer 4 v1
postedDateFrom Search the “From Date” of a notification posting date. Format: MM/DD/YYYY No String 10 v1
postedDateTo Search the “To Date” of a notification posting date. Format: MM/DD/YYYY No String 10 v1
dueDateFrom Search the “From Date” of a notification due date. Format: MM/DD/YYYY No String 10 v1
dueDateTo Search the “To Date” of a notification due date. Format: MM/DD/YYYY No String 10 v1
limit Total number of records to be retrieved per page. This field must be a number. Max Value = 100, Default = 20 No Integer   v1
offset Indicates the page index. Default = 0 No Integer   v1

Response Parameters

Based on the request parameters, the Notification API provides the below response parameters.

Response Parameter Description Data Type Version
totalRecords The total number of records for the search. Number v1
limit The limit used in the request. Integer v1
offset The offset used in the request. Integer v1
notifications A list of notification response objects. Array [JSON Object] v1

notificationResponse Data Object

The Utilization create, update, and search API endpoints return a common utilizationReponse data object. The JSON attributes are described in the table below.

Response Parameter Description Data Type Version
inventionReportNumber System generated sequence number used for ID of the Patent. String v1
patentDocketNumber The Patent Docket Number is an internal reference number of the grantee/contractor organization to help track a reported Patent(s). String v1
messageNumber The Message Number of the notification. Number v1
messageDescription The Message Description of the notification.    
organization The recipient organization of the notification. It can be either be a federal agency or a grant contractor String v1
fiscalYear The Fiscal Year of the notification. Number V1
status The Status (Active/Inactive) of the notification. String V1
postedDate The date the notification was posted. String v1
dueDate The Due Date of the notification. String v1