Overview

The Opportunity Management API will allow authorized users to submit and request Opportunities data.

Note: The specifications on this page are for a soon to be released API. Check back here or be in contact with IAE for the release date and testing session.

Note: Operations marked with * (asterisk) are not available at this time

Getting Started

Opportunity Management API can be accessed from Beta or Alpha via the following endpoints:

  • Beta: https://api.sam.gov/prod/opportunity (Coming Soon)
  • Alpha: https://api-alpha.sam.gov/prodlike/opportunity

REST API Workflow Chart

To view the current workflow of REST APIs, refer below file:

Authentication and Authorization

Generating a System Account API Key

  • Users registered with a government email address and have appropriate System Account Manager or System Account Admin role may request a system account for data access.
  • If a user satisfies the above registration criteria they will be able to access the System Accounts widget from their Workspace page after logging in.
  • The user can then select “Request System Account” from the widget and fill out the required sections with appropriate Contract Opportunities permissions.
  • The requested system account will then need to be approved. After approval the user will be notified via email and they can also see the updated status in the System Account widget.
  • The user can select ‘Go to System Accounts’ in the widget from their workspace and enter a new system account password.
  • After setting up the password the user will see a new section for retrieving a system account API Key. The user must enter their password again to retrieve the key.

System Account Authentication

In order to utilize the Contract Opportunity Management API, the following is required:

  • Valid beta.SAM.GOV federal government system account with Read and Write permissions under Contract Opportunity domain.

Type of Connection Validation (Future Implementation)

All REST API requests will be validated against the Type of Connection within the system account profile. All requests without “REST API” type of connection in the system account profile will be rejected with an error.

IP Address Validation (Future Implementation)

All REST API requests will be validated against the IP Addresses registered within the system account profile. All requests that are not from registered IP address(es) in the system account profile will be rejected with an error.

User Account Authorization

In order to perform an Opportunity Management API operation, the following is required:

  • beta.SAM.GOV user account with either ‘Administrator’, ‘Contracting Officer’ role or ‘Contracting Specialist’ role. Permissions for operations by role are listed in the table below.

To submit any opportunity notice type (except “Special Notice”) for an office, user should provide Federal Hierarchy (FH) Organization ID or Activity Address Code (AAC) (procurement/non-procurement). To submit Special Notice opportunity, user should provide Federal Hierarchy (FH) Organization ID of office, sub-tier or department or Activity Address Code (AAC) (procurement/non-procurement) or [other codes] for sub-tier and department.
Note: Permissions marked “Yes” are may not be assigned by default and will require your user administrator to update.

Back to top

Operation Administrator
(Contract Opportunities domain)
Contracting Officer Contracting Specialist
Create Draft Opportunity Yes Yes Yes
Create and Publish Yes Yes No
Publish Draft Opportunity Yes Yes No
Revise Published Opportunity Yes Yes Yes
Update Draft Opportunity Yes Yes Yes
Get Opportunity History Yes Yes Yes
Delete Draft Opportunity Yes Yes No
Delete Notice Yes Yes No
Get List of Opportunity Yes Yes Yes
Get an Opportunity by Opportunity ID Yes Yes Yes
Cancel Published Opportunity Yes Yes No
Uncancel Canceled Opportunity Yes Yes No
Archive Opportunity Yes Yes Yes
Unarchive Archived Opportunity Yes Yes No
Create Attachment in Draft Opportunity Yes Yes Yes
Update Attachment in Draft Opportunity Yes Yes Yes
Download Attachment as Original File Type Yes Yes Yes
Download All Attachments as Zip for an Opportunity Yes Yes Yes
Download Metadata for an Attachment by Resource ID Yes Yes Yes
Download Metadata for All Attachments by Oppoprtunity ID Yes Yes Yes
Get Attachment Yes Yes Yes
Get IVL Yes Yes Yes
IVL settings Yes Yes Yes
Delete Vendor Yes Yes Yes
Get Authorized Party Yes Yes No
Add Authorized Party Yes Yes No
Check Unique Solicitation Number Yes Yes Yes
Get Related Opportunities Yes Yes Yes

Back to top

Secure Attachment Authorization

In order to download secure attachment, user should have at least one of the below permissions:

  • Create Draft Attachment
  • Edit Draft Attachment
  • Delete Draft Attachment

Lookup/Meta Data

Notice Types

The API includes specific methods to submit each of the base notice types (i.e. presolicitation, combined/synopsis, award, etc.). You will find these outlined in the sections below.

Code Description
o Solicitation
p Presolicitation
k Combined Synopsis/Solicitation
r Sources Sought
g Sale of Surplus Property
s Special Notice
i Intent to Bundle Requirements (DoD- Funded)
a Award Notice
u Justification and Authorization

Back to top

Set-Aside Values

Several methods pertaining to submitting Contract Opportunities involve the Set-Aside Type field. Use the Set-Aside codes to submit notices.

Refer below table for valid Set-Aside values:

Code SetAside Values
SBA Total Small Business Set-Aside (FAR 19.5)
SBP Partial Small Business Set-Aside (FAR 19.5)
8A 8(a) Set-Aside (FAR 19.8)
8AN 8(a) Sole Source (FAR 19.8)
HZC Historically Underutilized Business (HUBZone) Set-Aside (FAR 19.13)
HZS Historically Underutilized Business (HUBZone) Sole Source (FAR 19.13)
SDVOSBC Service-Disabled Veteran-Owned Small Business (SDVOSB) Set-Aside (FAR 19.14)
SDVOSBS Service-Disabled Veteran-Owned Small Business (SDVOSB) Sole Source (FAR 19.14)
WOSB Women-Owned Small Business (WOSB) Program Set-Aside (FAR 19.15)
WOSBSS Women-Owned Small Business (WOSB) Program Sole Source (FAR 19.15)
EDWOSB Economically Disadvantaged WOSB (EDWOSB) Program Set-Aside (FAR 19.15)
EDWOSBSS Economically Disadvantaged WOSB (EDWOSB) Program Sole Source (FAR 19.15)
LAS Local Area Set-Aside (FAR 26.2)
IEE Indian Economic Enterprise (IEE) Set-Aside (specific to Department of Interior)
ISBEE Indian Small Business Economic Enterprise (ISBEE) Set-Aside (specific to Department of Interior)
BICiv Buy Indian Set-Aside (specific to Department of Health and Human Services, Indian Health Services)
VSA Veteran-Owned Small Business Set-Aside (specific to Department of Veterans Affairs)
VSS Veteran-Owned Small Business Sole source (specific to Department of Veterans Affairs)

Back to top

Stauth valid values

Below table captures stauth values to use while making requests as needed.

Code Description
1 Urgency
2 Only One Source (except brand name)
3 Follow-on Delivery Order Following Competitive Initial Order
4 Minimum Guarantee
5 Other Statutory Authority (e.g. 8a, etc.)
brand FAR 6.302-1(c) - Brand name
far1 FAR 6.302-1 - Only one responsible source (except brand name)
far2 FAR 6.302-2 - Unusual and compelling urgency
far3 FAR 6.302-3 - Industrial mobilization; engineering, developmental or research capability; or expert services
far4 FAR 6.302-4 - International agreement
far5 FAR 6.302-5 - Authorized or required by statute
far6 FAR 6.302-6 - National security
far7 FAR 6.302-7 - Public interest
far13 FAR 13.5 - Simplified Procedures for One Source

Back to top

Contract Opportunity Management API Request and Responses

Note: All Opportunity notices types except Special notices will be associated to organization at office level. Special notices can be associated to Organization at department, sub-tier, or office level.

Create Draft Opportunity

Request Type POST
URL /v1/api/create
Summary Create a new Draft Opportunity
Consumes application/json
Produces NA

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
Request JSON Body JSON Yes Refer Create and Update Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
201 string Draft Opportunity successfully created returns Opportunity ID in response header

Examples

ITB Request

{
  "data": {
    "solicitationNumber": "ITB_Test1",
    "title": "TST_T1",
    "type": "i",
    "classificationCode": "13",
    "organizationId": "100120624",
    "naics": [
      {
        "type": "primary",
        "code": [
          "111150"
        ]
      }
    ],
    "pointOfContact": [
      {
        "additionalInfo": {
          "content": ""
        },
        "email": "",
        "fax": "",
        "fullName": "GSA",
        "phone": "",
        "title": "",
        "type": "primary"
      }
    ],
    "placeOfPerformance": {
      "city": {
        "code": "",
        "name": ""
      },
      "country": {
        "code": "",
        "name": ""
      },
      "state": {
        "code": "",
        "name": ""
      },
      "streetAddress": "",
      "streetAddress2": "",
      "zip": ""
    },
    "award": {
      "date": "2019-08-08T11:20:20-05:00",
      "number": "12345",
      "deliveryOrderNumber": "",
      "amount": "number",
      "lineItemNumber": "",
      "awardee": {
        "name": "",
        "duns": "",
        "location": {
          "streetAddress": "",
          "streetAddress2": "",
          "city": {
            "code": "",
            "name": ""
          },
          "state": {
            "code": "",
            "name": ""
          },
          "zip": "",
          "country": {
            "code": "",
            "name": ""
          }
        }
      },
      "justificationAuthority": {
        "modificationNumber": "",
        "authority": "dictionary"
      },
    },
    "permissions": {
      "IVL": {
        "create": false,
        "delete": false,
        "read": false,
        "update": false
      }
    },
    "solicitation": {
      "setAside": "SBA",
      "deadlines": {
        "response": "2019-08-08T11:20:20-05:00"
      }
    },
    "archive": {
      "type": "autocustom",
      "date": "2019-09-09"
    },
    "flags": [
      {
        "code": "",
        "isSelected": true
      }
    ],
    "link": {
      "additionalInfo": {
        "content": ""
      },
      "href": ""
    },
    "additionalReporting": [
      "none"
    ]
  },
  "description": [
    {
      "body": "Description"
    }
  ]
}

PRESOL Request

{
  "data": {
    "solicitationNumber": "PRESOLTest1",
    "title": "PRESOLTEST_T1",
    "type": "p",
    "classificationCode": "13",
    "organizationId": "100120624",
    "naics": [{
      "type": "primary",
      "code": ["111150"]
    }],
    "pointOfContact": [{
        "additionalInfo": {
            "content": ""
        },
        "email": "",
        "fax": "",
        "fullName": "gsa",
        "phone": "",
        "title": "",
        "type": "primary"
    }],
    "placeOfPerformance": {
        "city": {
            "code": "",
            "name": ""
        },
        "country": {
            "code": "",
            "name": ""
        },
        "state": {
            "code": "",
            "name": ""
        },
        "streetAddress": "",
        "streetAddress2": "",
        "zip": ""
    },
    "permissions": {
        "IVL": {
            "create": false,
            "delete": false,
            "read": false,
            "update": false
        }
    },
     "solicitation": {
      "setAside": "SBA",
      "deadlines": {
        "response": "2019-08-08"
      }
    },
    "archive": {
      "type": "autocustom",
      "date": "2019-09-09"
    },
    "flags": [{
        "code": "",
        "isSelected": true
    }],
    "link": {
        "additionalInfo": {
            "content": ""
        },
        "href": ""
    },
     "additionalReporting": [
        "none"
    ]
    },
 "description": [{
    "body": "Description"
  }]
}

COMBINE Request

{
  "data": {
    "solicitationNumber": "Test1combine1",
    "title": "TST_T1",
    "type": "k",
    "classificationCode": "13",
    "organizationId": "100000136",
    "archive": {
      "type": "autocustom",
      "date": "2019-09-09"
    },
    "naics": [
      {
        "type": "primary",
        "code": [
          "111150"
        ]
      }
    ],
    "pointOfContact": [
      {
        "additionalInfo": {
          "content": ""
        },
        "email": "",
        "fax": "",
        "fullName": "gsa",
        "phone": "",
        "title": "",
        "type": "primary"
      }
    ],
    "permissions": {
      "IVL": {
        "create": false,
        "delete": false,
        "read": false,
        "update": false
      }
    },
    "solicitation": {
      "setAside": "",
      "deadlines": {
        "responseTz": "YYYY-MM-DDTHH:MM:SS-05:00",
        "response": "2019-11-11T11:12:00-05:00"
      }
    },
    "additionalReporting": [
      "none"
    ]
  },
  "description": [
    {
      "body": "Description_TEST "
    }
  ]
}

Back to top

Publish Draft Opportunity

Request Type POST
URL /v1/api/publish/{opportunityId}
Summary Publish a Draft Opportunity
Consumes application/json
Produces NA

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Request JSON Body JSON Yes Refer Publish Draft Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
204 string Opportunity successfully published returns Opportunity ID in response header

Examples

Publish Opportunity Request:

{
  "requestType": "publish_request",
  "reason": "Publish Opportunity test"
}

Back to top

Create and Publish Opportunity

Request Type POST
URL /opps/v1/opportunities/createAndPublish
Summary Creates and publishes contract opportunity; JSON same as Create and Update API
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
Request JSON Body JSON Yes Refer Create and Update Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
201 string Draft Opportunity successfully created returns Opportunity ID in response header

Revise Published Opportunity

Request Type POST
URL /v1/api/revise/{opportunityId}
Summary Create a draft version of an Opportunity for a Published Opportunity.
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Published Opportunity ID
Request JSON Body JSON Yes Refer Revise Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string Revise an Opportunity is successful return response is Opportunity ID

Examples

Revise Opportunity Request:

{
  "requestType": "update_publish_request",
  "reason": "Revise Opportunity test"
}

Back to top

Update Draft Opportunity

Request Type PATCH
URL /v1/api/update/{opportunityId}
Summary Update a Draft Opportunity
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Request JSON Body JSON Yes Refer Create and Update Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
201 string Update an Opportunity is successful return response is Opportunity ID

Examples

ITB Request

{
  "data": {
    "solicitationNumber": "ITB_Test1_Update",
    "title": "TST_T1_update",
    "type": "i",
    "classificationCode": "13",
    "organizationId": "100120624",
    "naics": [
      {
        "type": "primary",
        "code": [
          "111150"
        ]
      }
    ],
    "pointOfContact": [
      {
        "additionalInfo": {
          "content": ""
        },
        "email": "",
        "fax": "",
        "fullName": "GSA",
        "phone": "",
        "title": "",
        "type": "primary"
      }
    ],
    "placeOfPerformance": {
      "city": {
        "code": "",
        "name": ""
      },
      "country": {
        "code": "",
        "name": ""
      },
      "state": {
        "code": "",
        "name": ""
      },
      "streetAddress": "",
      "streetAddress2": "",
      "zip": ""
    },
    "award": {
      "date": "2019-08-08T11:20:20-05:00",
      "number": "12345",
      "deliveryOrderNumber": "",
      "amount": "number",
      "lineItemNumber": "",
      "awardee": {
        "name": "",
        "duns": "",
        "location": {
          "streetAddress": "",
          "streetAddress2": "",
          "city": {
            "code": "",
            "name": ""
          },
          "state": {
            "code": "",
            "name": ""
          },
          "zip": "",
          "country": {
            "code": "",
            "name": ""
          }
        }
      },
      "justificationAuthority": {
        "modificationNumber": "",
        "authority": "dictionary"
      },
    },
    "permissions": {
      "IVL": {
        "create": true,
        "delete": true,
        "read": true,
        "update": true
      }
    },
    "solicitation": {
      "setAside": "SBA",
      "deadlines": {
        "response": "2019-08-08T11:20:20-05:00"
      }
    },
    "archive": {
      "type": "autocustom",
      "date": "2019-09-09"
    },
    "flags": [
      {
        "code": "",
        "isSelected": true
      }
    ],
    "link": {
      "additionalInfo": {
        "content": ""
      },
      "href": ""
    },
    "additionalReporting": [
      "none"
    ]
  },
  "description": [
    {
      "body": "Description_updated"
    }
  ]
}

PRESOL Request

{
  "data": {
    "solicitationNumber": "PRESOLTest1_update",
    "title": "PRESOLTEST_T1_update",
    "type": "p",
    "classificationCode": "13",
    "organizationId": "100120624",
    "naics": [
      {
        "type": "primary",
        "code": [
          "111150"
        ]
      }
    ],
    "pointOfContact": [
      {
        "additionalInfo": {
          "content": ""
        },
        "email": "",
        "fax": "",
        "fullName": "gsa",
        "phone": "",
        "title": "",
        "type": "primary"
      }
    ],
    "placeOfPerformance": {
      "city": {
        "code": "",
        "name": ""
      },
      "country": {
        "code": "",
        "name": ""
      },
      "state": {
        "code": "",
        "name": ""
      },
      "streetAddress": "",
      "streetAddress2": "",
      "zip": ""
    },
    "permissions": {
      "IVL": {
        "create": true,
        "delete": true,
        "read": true,
        "update": true
      }
    },
    "solicitation": {
      "setAside": "SBA",
      "deadlines": {
        "response": "2019-08-08"
      }
    },
    "archive": {
      "type": "autocustom",
      "date": "2019-09-09"
    },
    "flags": [
      {
        "code": "",
        "isSelected": true
      }
    ],
    "link": {
      "additionalInfo": {
        "content": ""
      },
      "href": ""
    },
    "additionalReporting": [
      "none"
    ]
  },
  "description": [
    {
      "body": "Description_updated "
    }
  ]
}

COMBINE Request

{
  "data": {
    "solicitationNumber": "Test1combine1_update",
    "title": "TST_T1_update",
    "type": "k",
    "classificationCode": "13",
    "organizationId": "100000136",
    "archive": {
      "type": "autocustom",
      "date": "2019-09-09"
    },
    "naics": [
      {
        "type": "primary",
        "code": [
          "111150"
        ]
      }
    ],
    "pointOfContact": [
      {
        "additionalInfo": {
          "content": ""
        },
        "email": "",
        "fax": "",
        "fullName": "gsa",
        "phone": "",
        "title": "",
        "type": "primary"
      }
    ],
    "permissions": {
      "IVL": {
        "create": true,
        "delete": true,
        "read": true,
        "update": true
      }
    },
    "solicitation": {
      "setAside": "",
      "deadlines": {
        "responseTz": "America/New_York",
        "response": "2019-12-12T23:59:00-05:00"
      }
    },
    "additionalReporting": [
      "none"
    ]
  },
  "description": [
    {
      "body": "Description_updated "
    }
  ]
}

Back to top

Get Opportunity History

Request Type GET
URL /v1/api/history/{opportunityId}
Summary Get history of an Opportunity
Consumes Request Parameters
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
postedFrom Body JSON No Posted From - Date

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string History of Opportunity JSON (see below)
Response Element Response Type Reason Description
history JSON    
history.parentOpportunityId string   Parent Opportunity ID
history.cancel_notice boolean   Identify if the Opportunity is cancelled or not
history.procurement_type string   Notice Type
history.archive_notice boolean   Identify if the Opportunity is archived or not
history.request.type string   Type of request on Opportunity such as ‘submit’, ‘cancel_request’, ‘archive_request’ etc.
history.action_type string   Type of action performed on Opportunity request such as ‘publish’, ‘cancel’,’archive’ etc.
history.action_date date   Date and time of the action type
Example: 2019-02-01T17:12:00-5:00
history.title string   Opportunity title
history.index string   Version number of revision
history.relatedOpportunityId string   Related Opportunity ID
history.opportunityId string   Opportunity ID (System generated)
history.deleted string   Identify if the Opportunity is deleted or not
history.solicitation_number string   Solicitation Number of a Notice (Opportunity ID in UI)
history.revision_reason string   Reason for revision
history.posted_date string   Posted date and time
Example: 2019-01-04T14:00:00
history.latest     Service will return all the Opportunities but with latest=1

Examples

History Response:

{
  "content": {
    "history": [
      {
        "parentOpportunityId": "66544daa822c3c1667d927a70b7324f1",
        "cancel_notice": "0",
        "procurement_type": "p",
        "archive_notice": "0",
        "request_type": "submit",
        "action_type": "publish",
        "action_date": null,
        "index": "5",
        "title": "61 -- Loadbank",
        "relatedOpportunityId": null,
        "opportunityId": "9d8a8d2b0befa3b6b9683a689566d9c4",
        "deleted": "0",
        "solicitation_number": "FA8532-06-R-70739",
        "revision_reason": null,
        "posted_date": null,
        "latest": "1"
      },
      {
        "parentOpportunityId": "66544daa822c3c1667d927a70b7324f1",
        "cancel_notice": "0",
        "procurement_type": "p",
        "archive_notice": "0",
        "request_type": "submit",
        "action_type": "publish",
        "action_date": "2006-11-01T05:00:00+00",
        "index": "4",
        "title": "61 -- Loadbank",
        "relatedOpportunityId": null,
        "opportunityId": "1ef3f05d226c7cf877de3bcc285621aa",
        "deleted": "0",
        "solicitation_number": "FA8532-06-R-70739",
        "revision_reason": null,
        "posted_date": "2006-11-01T00:00:00",
        "latest": "0"
      },
      {
        "parentOpportunityId": "66544daa822c3c1667d927a70b7324f1",
        "cancel_notice": "0",
        "procurement_type": "p",
        "archive_notice": "0",
        "request_type": "submit",
        "action_type": "publish",
        "action_date": "2006-10-23T04:00:00+00",
        "index": "2",
        "title": "61 -- Loadbank",
        "relatedOpportunityId": null,
        "opportunityId": "0befa794b87fd0dc12a27ebc7c96c951",
        "deleted": "0",
        "solicitation_number": "FA8532-06-R-70739",
        "revision_reason": null,
        "posted_date": "2006-10-23T00:00:00",
        "latest": "0"
      },
      {
        "parentOpportunityId": "66544daa822c3c1667d927a70b7324f1",
        "cancel_notice": "0",
        "procurement_type": "p",
        "archive_notice": "0",
        "request_type": "submit",
        "action_type": "publish",
        "action_date": "2006-10-23T04:00:00+00",
        "index": "3",
        "title": "61 -- Loadbank",
        "relatedOpportunityId": null,
        "opportunityId": "3751f0b8e25f0ea478f0b1754fca93d2",
        "deleted": "0",
        "solicitation_number": "FA8532-06-R-70739",
        "revision_reason": null,
        "posted_date": "2006-10-23T00:00:00",
        "latest": "0"
      },
      {
        "parentOpportunityId": null,
        "cancel_notice": "0",
        "procurement_type": "p",
        "archive_notice": "0",
        "request_type": "submit",
        "action_type": "publish",
        "action_date": "2006-10-06T04:00:00+00",
        "index": "1",
        "title": "61 -- Loadbank",
        "relatedOpportunityId": null,
        "opportunityId": "66544daa822c3c1667d927a70b7324f1",
        "deleted": "0",
        "solicitation_number": "FA8532-06-R-70739",
        "revision_reason": null,
        "posted_date": "2006-10-06T00:00:00",
        "latest": "0"
      }
    ]
  }
}

Back to top

Delete Draft Opportunity

Request Type DELETE
URL /v1/api/delete/{opportunityId}
Summary Delete a Draft Opportunity
Consumes Request Parameters
Produces NA

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID

Back to top

Responses

HTTP Status Code Response Type Reason Description
204 string Opportunity successfully deleted NA

Examples

NA

Back to top

Delete Notice

Request Type POST
URL /opps/v1/opportunities/{opportunityId}/requests
Summary Deletes all the versions or latest version of a notice
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
Request JSON Body JSON Yes Refer Delete Notice JSON

Responses

HTTP Status Code Response Type Reason Description
200 JSON Deleted the latest or all versions of a notice NA

Examples

Delete Notice:

{
   "requestType":"delete_request",
    "reason":"test",
     "data":{
              "description":"test",
               "title":null,
                "newArchiveDate":null,
                "newArchiveType":null,
                 "deleteOption":"latest"  ( “all”  - to delete all versions)
              }
}

Get List of Opportunities

Request Type GET
URL /v1/api/search
Summary Get list of Opportunities
Consumes Request Parameters
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
archivedFrom query date-time No Archive From UTC Date and Time
Example: 2018-11-01 00:00:00
archivedTo query date-time No Archive To UTC Date and Time
Example: 2018-11-01 00:00:00
awardNumber query string No Award Number
cancelled (will be deprecated) query boolean No True or false
doNumber query string No Delivery Order Number
includeCount query boolean No True or false
keyword query string No Enter any keyword from the description
latest query boolean No True or false
opportunityIds query Array No Opportunity IDs (comma separated)
noticeType query Array No See Notices Types table (comma separated)
organizationId query Array No FH Org ID/AAC code of the office where an Opportunity is being submitted (comma separated)
page query integer No Page number
parentNotice query Array No Parent Opportunity ID (comma separated)
postedFrom query date-time No Posted From UTC Date and time
Example: 2018-11-01 00:00:00
postedTo query date-time No Posted To UTC Date and time
Example: 2018-11-01 00:00:00
relatedNotice query Array No Related Opportunity ID (comma separated)
responseFrom query date-time No ResponseFrom UTC Date and Time
Example: 2018-11-01 00:00:00
responseTo query date-time No ResponseTo UTC Date and Time
Example: 2018-11-01 00:00:00
size query integer No Size limit is 10 by default
solNumber query string No Solicitation Number
sortBy query string No Sort (-createdOn, -modifiedOn)
status (To be updated) query Array[string] No 1.status= active (published, unarchive and uncancelled records)
2.status=inactive (published, archive and uncancelled records)
3.status=draft (draft records)
4.status=published (published and unarchive)
5.status=active_cancelled(published, unarchive and cancelled records)
6.status=inactive_cancelled(published, archive and cancelled records)
7. status=archived(published and archived)
(comma separated)

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string List of Opportunities JSON (see below)
Response Element Response Type Reason Description
data JSON   All the Opportunities are listed out in the response
opportunityId string   Opportunity ID
data.type string   See Notices Types table
data.solicitationNumber string   Solicitation Number
data.title string   Title of the Opportunity
data.organizationId string   FH Org Id/AAC code of the office where an Opportunity is being submitted
data.classificationCode string   Product Service Code (PSC)
data.naics JSON    
data.naics.code string   NAICS Code
data.naics.type string   NAICS type
data.flags JSON    
data.flags.code string    
data.flags.isSelected boolean    
data.pointOfContact JSON    
data.pointOfContact.type string   Contact Type
data.pointOfContact.title string   Contact title
data.pointOfContact.fullname string   Contact Full Name
data.pointOfContact.email string   Contact email
data.pointOfContact.phone string   Contact Phone
data.pointOfContact.fax string   Contact Fax
data.placeOfPerformance JSON    
data.placeOfPerformance.streetAddress string   Pop Address
data.placeOfPerformance.streetAddress2 string   Pop Address2
data.placeOfPerformance.city JSON   Pop City
data.placeOfPerformance.city.code string   Pop City code
data.placeOfPerformance.city.name string   Pop City name
data.placeOfPerformance.city.state JSON   Pop City state
data.placeOfPerformance.state.code string   Pop city state code
data.placeOfPerformance.state.name string   Pop city state name
data.placeOfPerformance.country JSON   Pop Country
data.placeOfPerformance.country.code string   Pop Country Code
data.placeOfPerformance.country.name string   Pop Country name
data.placeOfPerformance.zip string   Pop Country zip
data.archive JSON    
data.archive.type string   Archive Type: auto15, auto30, autocustom
data.archive.date date and time   Archive Date
data.permissions JSON    
data.permissions.ivl JSON    
data.permissions.ivl.create boolean   permissions.ivl.create
data.permissions.ivl.read boolean   permissions.ivl.read
data.permissions.ivl.update boolean   permissions.ivl.update
data.permissions.ivl.delete boolean   permissions.ivl.delete
data.solicitation JSON    
data.solicitation.setAside string   See Set-Aside values table
data.solicitation.deadlines JSON    
data.solicitation.deadlines.response date and time   Solicitation Deadline Date
data.solicitation.deadlines.responseTz string   Solicitation Deadlines Response Time Zone
data.award JSON    
data.award.date date and time   Award Date
data.award.number string   Award Number
data.award.deliveryOrderNumber string   Award Deliver Order Number
data.award.amount Number   Award Amount
data.award.lineitemNumber string   Award Line Item Number
data.award.awardee JSON    
data.award.awardee.name string   Awardee Name
data.award.awardee.duns string   Awardee Duns
data.award.awardee.location JSON   Awardee Location
data.award.awardee.location.streetAddress string   Awardee Street Address 1
data.award.awardee.location.streetAddress2 string   Awardee Street Address 1
data.award.awardee.location.city string   Awardee City
data.award.awardee.location.city.code string   Awardee City Code
data.award.awardee.location.city.name string   Awardee City Name
data.award.awardee.location.state JSON   Awardee State
data.award.awardee.location.state.code string   Awardee State Code
data.award.awardee.location.state.name string   Awardee State Name
data.award.awardee.location.country JSON   Awardee Country
data.award.awardee.location.country.code string   Awardee Country Code
data.award.awardee.location.country.name string   Awardee Country Name
data.award.awardee.location.zip string   Awardee Zip
data.award.justificationAuthority JSON    
data.award.justificationAuthority.modificationNumber string   justificationAuthority modification number
data.award.justificationAuthority.authority string   justificationAuthority authority
data.link JSON    
data.link.additionalInfo JSON    
data.link.additionalInfo.content string   Additional Info
data.link.href string   Website Address
data.additionalReporting string   recovery_act or none
description JSON    
additionalInfo.sections JSON JSON    
additionalInfo.sections.opportunityId string    
additionalInfo.sections.status string    
parent JSON    
parent.opportunityId string   Parent Opportunity ID
related JSON    
related.opportunityId string   Related Opportunity ID
status JSON    
status.code string   1.status= active (published, unarchive and uncancelled records)
2.status=inactive (published, archive and uncancelled records)
3.status=draft (draft records)
4.status=published (published and unarchive)
5.status=active_cancelled(published, unarchive and cancelled records)
6.status=inactive_cancelled(published, archive and cancelled records)
7.status=archived(published and archived)
status.value string   Refer to status.code
archived boolean   Indicates Archived
cancelled boolean   Indicates Canceled
latest string   Inidcates latest record
deleted boolean   Indicates Deleted
postedDate date   Date Posted
modifiedDate date   Date Modified
createdDate date   Date Created
modifiedBy string   Modified By User ID
createdBy string   Created By User ID
description JSON   JSON applicable to Get Opportunity By ID only
description.body string   Description of Notice
description.opportunityId string   Opportunity ID (UI)
description.descriptionId string    
description.modifiedOn string   Date Description modified
page JSON   JSON applicable to Get List of Opportunities only
page.size string    
page.totalElements string    
page.totalPages string    
page.number string    

Back to top

Examples

Get List of Opportunities Response:

{
  "_embedded": {
    "opportunity": [
      {
        "data": {
          "type": "r",
          "flags": [
            {
              "code": "isScheduledNotice",
              "isSelected": false
            }
          ],
          "title": "V--flight services",
          "archive": {
            "date": "2020-06-14",
            "type": "auto15"
          },
          "permissions": {
            "IVL": {
              "read": false,
              "create": false,
              "delete": false,
              "update": false
            }
          },
          "solicitation": {
            "deadlines": {
              "response": "2020-05-30T00:00:00-05:00",
              "responseTz": "America/Chicago"
            }
          },
          "organizationId": "500028949",
          "pointOfContact": [
            {
              "fax": null,
              "type": "primary",
              "email": "test@gsa.gov",
              "phone": null,
              "title": null,
              "fullName": "Neal Hitchcock at 208-387-5400; Bureau of Land Management, Office of Fire and Aviation, 3833 S. Development Avenue, Boise, ID 83705-5354"
            }
          ],
          "classificationCode": "V",
          "solicitationNumber": "NICC-01",
          "additionalReporting": [
            "none"
          ]
        },
        "additionalInfo": {
          "sections": [
            {
              "id": "header",
              "status": "updated"
            },
            {
              "id": "award",
              "status": "updated"
            },
            {
              "id": "general",
              "status": "updated"
            },
            {
              "id": "classification",
              "status": "updated"
            },
            {
              "id": "description",
              "status": "updated"
            },
            {
              "id": "attachments-links",
              "status": "updated"
            },
            {
              "id": "contact",
              "status": "updated"
            }
          ]
        },
        "parent": {
          "opportunityId": "8de3d88fc7642d9adcdb8d4ff9070399"
        },
        "related": {

        },
        "status": {
          "code": "draft",
          "value": "Draft"
        },
        "archived": false,
        "cancelled": false,
        "latest": false,
        "deleted": false,
        "modifiedDate": "2019-02-19T21:18:20.669+0000",
        "createdDate": "2019-02-19T21:18:20.669+0000",
        "modifiedBy": "reitestuser+aa@gsa.gov",
        "createdBy": "reitestuser+aa@gsa.gov",
        "opportunityId": "f563391e2c8a4b7180a6cf49d6980723"
      },
      {
        "data": {
          "type": "s",
          "award": {
            "lineItemNumber": null
          },
          "title": "test",
          "permissions": {
            "IVL": {
              "create": false,
              "delete": false,
              "update": false
            }
          },
          "organizationId": "100186612",
          "pointOfContact": null,
          "solicitationNumber": ""
        },
        "additionalInfo": {
          "sections": [
            {
              "id": "header",
              "status": "updated"
            }
          ]
        },
        "parent": {

        },
        "related": {

        },
        "status": {
          "code": "draft",
          "value": "Draft"
        },
        "archived": false,
        "cancelled": false,
        "latest": false,
        "deleted": false,
        "modifiedDate": "2019-02-19T21:14:02.308+0000",
        "createdDate": "2019-02-19T21:14:02.308+0000",
        "modifiedBy": "reitestuser+cs1@gsa.gov",
        "createdBy": "reitestuser+cs1@gsa.gov",
        "opportunityId": "f687c5c4e4124c27a068c145d0a4a1f5"
      },
      {
        "data": {
          "type": "i",
          "award": {
            "date": "2019-01-01",
            "number": "A1234567890",
            "deliveryOrderNumber": "TO3456789"
          },
          "naics": [
            {
              "code": [
                "621111"
              ]
            }
          ],
          "title": "SK Intent to Bundle Requirements",
          "archive": {
            "date": "2019-03-21",
            "type": "auto30"
          },
          "permissions": {
            "IVL": {
              "read": false,
              "create": false,
              "delete": false,
              "update": false
            }
          },
          "solicitation": {
            "deadlines": {
              "response": null,
              "responseTz": null
            }
          },
          "organizationId": "100186612",
          "pointOfContact": [
            {
              "fax": "",
              "type": "primary",
              "email": "sk@test.com",
              "phone": "",
              "title": null,
              "fullName": "Sravanthi Kundur"
            }
          ],
          "classificationCode": "84",
          "solicitationNumber": "31231231241414",
          "additionalReporting": [
            "none"
          ]
        },
        "additionalInfo": {
          "sections": [
            {
              "id": "header",
              "status": "updated"
            },
            {
              "id": "contact",
              "status": "updated"
            },
            {
              "id": "attachments-links",
              "status": "updated"
            },
            {
              "id": "description",
              "status": "updated"
            },
            {
              "id": "classification",
              "status": "updated"
            },
            {
              "id": "general",
              "status": "updated"
            },
            {
              "id": "award",
              "status": "updated"
            }
          ]
        },
        "parent": {

        },
        "related": {

        },
        "status": {
          "code": "published",
          "value": "Published"
        },
        "archived": false,
        "cancelled": false,
        "latest": true,
        "deleted": false,
        "postedDate": "2019-02-19T21:09:37.369+0000",
        "modifiedDate": "2019-02-19T21:09:37.369+0000",
        "createdDate": "2019-02-19T20:16:31.728+0000",
        "modifiedBy": "reitestuser+aa@gsa.gov",
        "createdBy": "reitestuser+aa@gsa.gov",
        "opportunityId": "530382634cc9401db875fd18c9831bda"
      }
    ]
  },
  "page": {
    "size": 4,
    "totalElements": 1153,
    "totalPages": 289,
    "number": 0
  }
}

Back to top

Get an Opportunity by Opportunity ID

Request Type GET
URL /v1/api/{opportunityId}
Summary Get Opportunity by Opportunity ID
Consumes Request Parameters
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
latest query boolean No default = true

Back to top

Responses

See Responses for Get List of Opportunity - link to the above display

Examples

Get Opportunity by ID Response

{
  "data": {
    "link": {
      "href": "https://www.fedconnect.net/FedConnect/?doc=140S0318B0003&agency=DOI                                                                                                                                                                                            ",
      "additionalInfo": {
        "content": "Click here to see more information about this opportunity on FedConnect"
      }
    },
    "type": "s",
    "flags": [
      {
        "code": "isScheduledNotice",
        "isSelected": false
      }
    ],
    "naics": [
      {
        "code": [
          "312111"
        ]
      }
    ],
    "title": "XYZ--CONSTRUCTION",
    "archive": {
      "date": "2020-01-16",
      "type": "auto15"
    },
    "permissions": {
      "IVL": {
        "read": false,
        "create": true,
        "delete": true,
        "update": true
      }
    },
    "solicitation": {
      "deadlines": {
        "response": "2020-01-01T23:59:00-05:00",
        "responseTz": "America/New_York"
      }
    },
    "organizationId": "48493828",
    "classificationCode": "9999",
    "solicitationNumber": "140S0318B0003",
    "additionalReporting": [
      "none"
    ]
  },
  "additionalInfo": {
    "sections": [
      {
        "id": "header",
        "status": "updated"
      },
      {
        "id": "award",
        "status": "updated"
      },
      {
        "id": "general",
        "status": "updated"
      },
      {
        "id": "classification",
        "status": "updated"
      },
      {
        "id": "description",
        "status": "updated"
      },
      {
        "id": "attachments-links",
        "status": "updated"
      },
      {
        "id": "contact",
        "status": "updated"
      }
    ]
  },
  "parent": {
    "opportunityId": "f4685436437d1846830932117ecad067"
  },
  "related": {

  },
  "status": {
    "code": "published",
    "value": "Published"
  },
  "archived": false,
  "cancelled": false,
  "latest": true,
  "deleted": false,
  "postedDate": "2019-02-19T16:34:32.267+0000",
  "modifiedDate": "2019-02-19T16:34:32.267+0000",
  "createdDate": "2019-02-19T16:33:17.126+0000",
  "modifiedBy": "reitestuser+aa@gsa.gov",
  "createdBy": "reitestuser+aa@gsa.gov",
  "description": [
    {
      "opportunityId": "bac24bfdc52046ae90ff0ddfe818bfd4",
      "descriptionId": "759877f6e64d423cbf23997006ea767a",
      "modifiedOn": "2019-02-19T16:34:32.265+0000",
      "body": "The Department of the Interior's Office of Surface Mining Reclamation and Enforcement intends to release"
    }
  ],
  "opportunityId": "bac24bfdc52046ae90ff0ddfe818bfd4"
}

Back to top

Cancel Published Opportunity

Request Type POST
URL /v1/api/cancel/{opportunityId}
Summary Cancel a Published Opportunity
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Request JSON Body JSON Yes Refer Cancel Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string Opportunity successfully canceled return response is new Opportunity ID

Examples

Cancel Request:

{
  "reason": "",
  "requestType": "cancel_request",
  "data": {
    "description": "test"
  }
}

Back to top

Uncancel Canceled Opportunity

Request Type POST
URL v1/api/uncancel/{opportunityId}
Summary Update status of a Canceled Opportunity to Published status
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Request JSON Body JSON Yes Refer Uncancel Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string Opportunity successfully un canceled return response is new Opportunity ID

Examples

Uncancel Request (active Opportunity):

{
  "reason": "",
  "requestType": "uncancel_request",
  "data": {
    "description": "test"
  }
}

Uncancel Request (inactive Opportunity):

{
  "reason": "test",
  "requestType": "uncancel_request",
  "data": {
    "description": "test",
    "newArchiveDate": null,
    "newArchiveType": "auto15",
    "newResponseDate": "2018-11-11T10:58:00-05:00",
    "newResponseTz": "America/New_York"
  }
}

Back to top

Archive Published Opportunity

Request Type POST
URL /v1/api/archive/{opportunityId}
Summary Archive a Published Opportunity
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Request JSON Body JSON Yes Refer Archive Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string Opportunity successfully archived return response is new Opportunity ID

Examples

Archive Request:

{
  "reason": "test",
  "requestType": "archive_request"
}

Back to top

Unarchive Archived Opportunity

Request Type POST
URL /v1/api/unarchive/{opportunityId}
Summary Update status of a Archived Opportunity to Published status
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Request JSON Body JSON Yes Refer Unarchive Opportunity Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string Opportunity successfully unarchived return response is new Opportunity ID

Examples

Unarchive:

{
  "reason": "test",
  "requestType": "unarchive_request",
  "data": {
    "newArchiveDate": null,
    "newArchiveType": "auto15",
    "newResponseDate": "2019-11-11T10:58:00-05:00",
    "newResponseTz": "America/New_York"
  }
}

Back to top

Create Attachment in Draft Opportunity

Request Type POST
URL /v1/api/{opportunityId}/attachments
Summary Create attachment/link to a draft Opportunity
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Request JSON Body JSON Yes Refer Create Attachment Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
201 string Attachment successfully created Resource ID returned

Examples

Create Attachment Request - file

{
 "attType": "file",
 "content": "SGVsbG8=",
 "resourceName": "Hello.txt",
 "fileType": "text/plain",
 "packageAccessLevel": "public"
}

Create Attachment Request - link

{"attType":"link",
 "link":"https://faaco.faa.gov/index.cfm/attachment/download/84723",
 "description":"test attachment pdf link",
"packageAccessLevel":null
}

Back to top

Update Attachment in Draft Opportunity

Request Type PATCH
URL /v1/api/{opportunityId}/attachments/{resourceId}
Summary Update an attachment metadata on a draft Opportunity
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
resourceId query string Yes Attachment ID
Request JSON Body JSON Yes Refer Update Attachment Contract JSON

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string Attachment successfully updated Resource ID returned

Examples

Update Attachment Request - file

{
  "attType": "file",
  "packageAccessLevel": "private",
   "explicitAccess": "1",
 "content": "SGVsbG8=",
 "fileType": "text/plain"
}

Update Attachment Request - link

{
  "attType": "file",
  "packageAccessLevel": "private",
   "explicitAccess": "1",
 "content": "SGVsbG8=",
 "fileType": "text/plain"
}

Back to top

Download Attachment as Original File Type

Request Type GET
URL /v1/api/resources/files/{resourceId}/download
Summary Download the attachment for the given Resource ID
Consumes Request Parameters
Produces file

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
resourceId query string Yes Resource ID
status query string No Active or Inactive
token query string No  

Back to top

Responses

HTTP Status Code Response Type Reason Description
200 string File provided as response NA

Examples

NA

Back to top

Download All Attachments as Zip for an Opportunity

Request Type GET
URL /v1/api/{opportunityId}/resources/download/zip
Summary Download all attachments as zip file for an Opportunity
Consumes Request Parameters
Produces Zip

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID

Responses

HTTP Status Code Response Type Reason Description
200 zip Zip file provided as response NA

Examples

N/A

Back to top

Get IVL (Interested Vendor List)

Request Type GET
URL /v1/api/{opportunityId}/ivl
Summary Get IVL of the Opportunity ID
Consumes Request Parameters
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
entityId query string No Entity ID (DUNS #)

Back to top

Responses

HTTP Status Code Response Type Reason Description
ivl JSON    
ivl. duns string   DUNS number for the business entity
ivl.cageNumber string   Identifies a given facility at a specific location
ivl.name string   Name of business entity
ivl.addedOn string   Date added to IVL
ivl.contacts JSON   Business entity contact
ivl.contacts.email string   Business entity email
ivl.contacts.firstName string   Business entity contact first name
ivl.contacts.lastName string   Business entity contact last name
ivl.contacts.phoneNumber string   Business entity contact phone number
ivl.contacts.type string   Business entity contact type
ivl.addresses JSON    
ivl.addresses.streetAddress string   Business entity address
ivl.addresses.city string   Business entity city
ivl.addresses.state string   Business entity state
ivl.addresses.zip string   Business entity zip
ivl.addresses.country string   Business entity country
ivl.addresses.addressType string   Business entity address type
ivl.naicsList Array   Business entity’s NAICS

Examples

Response - Get IVL

ivl": [
  {
    "duns": "6759999520",
    "cageNumber": "3ABC1",
    "name": "TECH SYSTEMS, INC.",
    "addedOn": "2019-03-04 15:06:11",
    "contacts": [
      {
        "email": "johndoe@techsystems.com",
        "firstName": "JOHN",
        "lastName": "DOE",
        "phoneNumber": "7031234567",
        "type": "Government Business POC"
      }
    ],
    "addresses": [
      {
        "streetAddress": "P.O. BOX 123",
        "city": "SOMECITY",
        "state": "VIRGINIA",
        "zip": "22102",
        "country": "UNITED STATES",
        "addressType": "mailing"
      }
    ],
    "naicsList": [
      "423430",
      "511210",
      "518210",
      "541330",
      "541511",
      "541512",
      "541513",
      "541519",
      "541611",
      "541618",
      "541990",
      "611430",
      "811212"
    ]
  }
]
  },
  "page": {
    "size": 10,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }

Back to top

Download Metadata for an Attachment by Resource ID

Request Type GET
URL /opps/v1/api/resource
Summary Download all attachments from resource ID
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
Api_key query string Yes Valid System Account API Key  
ResourceID query string Yes Resource ID

Responses

HTTP Status Code Response Type Reason Description
200 JSON Downloaded all attachments from resource ID OK

Examples

Response

{
"opportunityId": "02160428f9e84cbe8af8f7cc1bd49c7b",
"attachments": [
{
"attachmentId": "eab82b2378aa4cdbacf340b01631c011",
"resourceId": "5ed09570655a4fbb93bbea4a8570ebe9",
"fileExists": "1",
"name": "Hello.txt",
"type": "file",
"postedDate": "",
"accessLevel": "public",
"exportControlled": "0",
"explicitAccess": "0",
"mimeType": ".txt",
"size": 5,
"deletedDate": "",
"deletedFlag": "0",
"accessStatus": "public"
}
]
}

Download Metadata for All Attachments by Opportunity ID

Request Type GET
URL /opps/v1/api/resources
Summary Download all attachments from opportunity ID
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
Api_key query string Yes Valid System Account API Key  
OpportunityID query string Yes Opportunity ID

Responses

HTTP Status Code Response Type Reason Description
200 JSON Downloaded all attachments from opportunity ID OK

Examples

Response

{
  "_embedded": {
    "opportunityAttachmentList": [
      {
        "opportunityId": "02160428f9e84cbe8af8f7cc1bd49c7b",
        "attachments": [
          {
            "attachmentId": "eab82b2378aa4cdbacf340b01631c011",
            "resourceId": "5ed09570655a4fbb93bbea4a8570ebe9",
            "fileExists": "1",
            "name": "Hello.txt",
            "type": "file",
            "postedDate": "",
            "accessLevel": "public",
            "exportControlled": "0",
            "explicitAccess": "0",
            "mimeType": ".txt",
            "size": 5,
            "deletedDate": "",
            "deletedFlag": "0",
            "accessStatus": "public"
          }
        ]
      }
    ]
  }
}

IVL Settings

Request Type PUT
URL /v1/api/organization/{orgId}/ivl
Summary Update IVL Settings (on or off) for an Organization
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
orgId query string Yes FH Org Id/AAC code of the organization
Request JSON Body JSON Yes Refer IVL Settings Contract JSON

Responses

HTTP Status Code Response Type Reason Description
204 string Organization’s IVL settings successfully set NA

Examples

Request - IVL Settings

{
  "ivlCreate": "forcedon",
  "ivlView": "forcedon"
}

Back to top

Delete Vendor

Request Type DELETE
URL /v2/opportunities/{opportunityId}/ivl/{entityid}
Summary Delete Vendor from IVL for Opportunity ID
Consumes Request Parameters
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
entityid query string Yes DUNS number for the business entity

Responses

HTTP Status Code Response Type Reason Description
204 string Vendor successfully deleted NA

Examples

N/A

Back to top

Get Authorized Party

Request Type GET
URL /v1/opportunities/access/{opportunityId}/accessRequest
Summary Summary Get Authorized Party list for the explicit access requests submitted to an Opportunity
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid API Key
opportunityId query string Yes Opportunity ID
status query string No Request access status can be: Pending, Approved, Rejected, or blank to get all request details for a notice

Responses

HTTP Status Code Response Type Reason Description
200 JSON To get the list of pending, approved, rejected or all request access on that notice List of the Requestor’s info and the status on their request access

Examples

Response – Get Authorized Party

{

    "_embedded": {
        "authorizedPartyList": [
            {
                "idType": "resource",
                "resourceName": "Secure 2.png",
                "requestId": "cfc4c057a13e4a2c91741e46399d4a7d",
                "actionType": "pending",
                "fName": "Data",
                "lName": "Entry",
                "email": "reitestuser.de@gmail.com",
                "phone": "1+9734323019",
                "contractorName": "REI SYSTEMS, INC.",
                "duns": "608999520",
                "cageCode": "1DJP1"
            },
            {
                "idType": "resource",
                "resourceName": "Secure 1.png",
                "requestId": "7900084914ea400e82db0152cecfbcaf",
                "actionType": "pending",
                "fName": "Data",
                "lName": "Entry",
                "email": "reitestuser.de@gmail.com",
                "phone": "1+9734323019",
                "contractorName": "REI SYSTEMS, INC.",
                "duns": "608999520",
                "cageCode": "1DJP1"
            },
            {
                "idType": "notice",
                "requestId": "4f4eeb29dcd2411dbc5a89ab0243f7c8",
                "actionType": "approved",
                "fName": "Data",
                "lName": "Entry",
                "email": "reitestuser.de@gmail.com",
                "phone": "1+9734323019",
                "contractorName": "REI SYSTEMS, INC.",
                "duns": "608999520",
                "cageCode": "1DJP1”
            }
        ]
    },
}

Add Authorized Party

Request Type POST
URL /v1/opportunities/access/{opportunityId}/accessRequest
Summary Add a Vendor as an Authorized Party for a notice to grant access to all the secured attachments across all the versions . This API will create and approve the request for the vendor.
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Request JSON Body JSON Yes Refer Vendor Data JSON

Responses

HTTP Status Code Response Type Reason Description
201 string Access Request created and approved for the vendor. Action Id is returned.

Examples

Response – Add Authorized Party

{
"lname":"test",
"fname":"test123",
"email":"reitestuser.de@gmail.com",
"contractorName":"",
"duns":"608999520",
"cageCode":""
}

Check Unique Solicitation Number

Request Type GET
URL /v1/api/isSolicitationNumberUnique/{parent}/{solicitationNumber}/{type}
Summary Check if solicitation number is unique. A solicitation number is unique if it is not used by another opportunity of equivalent type. For justification type, j&a and fair opportunity/limited sources justification are considered equivalent.
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Accounts API Key
Parent path string No Parent
SolicitationNumber Path String Yes Solicitation Number
Type Path String Yes Type

Responses

HTTP Status Code Response Type Reason Description
200 JSON True/False True if solicitation number is unique; false if solicitation number is not unique

Examples

Response – Check Unique Solicitation Number

{
 “content”: true
}

Request Type GET
URL /v1/api/opportunities/{opportunityId}/relatedopportunities/{type}
Summary Get Related Contract Opportunities
Consumes application/json
Produces JSON

Request Parameters

Parameter Name Parameter Type Data Type Required Description
Authorization Header string Yes Valid and authorized user ID
api_key query string Yes Valid System Account API Key
opportunityId query string Yes Opportunity ID
Page query Integer No Page; Default Value: 0
Size query Integer No Size; Default value: 0
sortBy query string No sortBy; Default Value: -modifiedOn
Type Path String Yes Type

Responses

HTTP Status Code Response Type Reason Description
200 JSON True/False Pulls related opportunity information based on the given parameter

Examples

Response – Get Related Opportunities

{
  "recipientCount": 0,
  "unparsableCount": 0,
  "count": 1,
  "totalAwardAmt": 0,
  "relatedOpportunities": [
    {
      "data": {
        "award": {
          "date": null,
          "amount": null,
          "number": "awd123",
          "awardee": {
            "duns": null,
            "name": null,
            "location": null
          },
          "lineItemNumber": null,
          "deliveryOrderNumber": "donumber"
        },
        "title": "Test Justification 4 conv 1",
        "id": "96ba2e5833b14cecb3c2b3ac1ba3b56e",
        "opportunityId": "96ba2e5833b14cecb3c2b3ac1ba3b56e"
      },
      "archived": false,
      "cancelled": false,
      "latest": false,
      "deleted": false
    }
  ]
}

API Contract JSON

Create and Update Opportunity Contract JSON

Create_Update_Opportunity_Contract_Json

{
   "data": {
        "solicitationNumber": "Test1",
        "title": "TST_T1",
        "type": "p",
        "classificationCode": "13",
        "organizationId": "100000136",
        "organizationLocationId": "",
        "naics": [{
            "type": "primary",
            "code": ["111150"]
        }],
        "pointOfContact": [{
                "additionalInfo": {
                        "content": ""
                },
                "email": "",
                "fax": "",
                "fullName": "Veera",
                "phone": "",
                "title": "",
                "type": "primary"
        }],
        "placeOfPerformance": {
                "city": {
                        "code": "",
                        "name": ""
                },
                "country": {
                        "code": "",
                        "name": ""
                },
                "state": {
                        "code": "",
                        "name": ""
                },
                "streetAddress": "",
                "streetAddress2": "",
                "zip": ""
        },
        "award": {
                "date": "",
                "number": "",
                "deliveryOrderNumber": "",
                "amount": "number",
                "lineItemNumber": "",
                "awardee": {
                        "manual": false,
                        "name": "",
                        "duns": "",
                        "location": {
                                "streetAddress": "",
                                "streetAddress2": "",
                                "city": {
                                        "code": "",
                                        "name": ""
                                },
                                "state": {
                                        "code": "",
                                        "name": ""
                                },
                                "zip": "",
                                "country": {
                                        "code": "",
                                        "name": ""
                                }
                        }
                },
                "justificationAuthority": {
                        "modificationNumber": "",
                        "authority": "dictionary"
                },
                "fairOpportunity": {
                        "authority": ""
                }
        },
        "permissions": {
                "IVL": {
                        "create": false,
                        "delete": false,
                        "read": false,
                        "update": false
                }
        }, 
          "solicitation": {
            "setAside": "SBA",
            "deadlines": {
                "response": "2019-08-08"
            }
        },
       "archive": {
            "type": "autocustom",
            "date": "2019-09-09"
        },
        "flags": [{
                "code": "",
                "isSelected": true
        }],
        "link": {
                "additionalInfo": {
                        "content": ""
                },
                "href": ""
        },
         "additionalReporting": [
                "none"
        ]
        },
 "description": [{
        "body": ""
    }],
     "resources": [{
        "attType": "link",

        "link": "http://beta.sam.gov",

        "description": "test beta sam link",

        "packageAccessLevel": null
    },
    {
       "attType": "link",

        "link": "https://faaco.faa.gov/index.cfm/attachment/download/84723",

        "description": "test attachment pdf link",

        "packageAccessLevel": null

    }],

    "postedDate": "20190423",

    "archived": false
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required (Create/Update) Required (to Publish) Description  
type string See Notice Types table Yes Yes Notice Type  
solicitationNumber string   No Yes Solicitation Number  
title string   Yes Yes Title of the Opportunity  
organizationId string   No for Create (Yes for Update) Yes FH Org Id/AAC code of the office where an Opportunity is being submitted  
organizationLocationId string   No No Organization Location ID  
classificationCode string   No Yes (not required for type= r) Product Service Code (PSC)  
naics JSON NA NA NA    
naics.code string   No Yes NAICS Code  
naics.type string primary No Yes NAICS Type Note: ‘p’ must be in lower case  
flags JSON NA NA NA    
flags.code string Recovery act No No This is a recovery or Reinvestment Act Action  
flags.IsSelected boolean default = True No No    
pointOfContact JSON NA NA NA    
pointOfContact.type string p No Yes Contact Type Note: ‘p’ must be in lower case  
pointOfContact.title string   No No Contact title  
pointOfContact.fullname string   No Yes Contact Full Name  
pointOfContact.email string   No Yes (no if type = a) Contact email  
pointOfContact.phone string   No No Contact Phone  
pointOfContact.fax string   No No Contact Fax  
placeOfPerformance JSON NA NA NA    
placeOfPerformance.
streetAddess
string   No No Pop Address  
placeOfPerformance.
streetAddess2
string   No No Pop Address2  
placeOfPerformance.city JSON NA NA NA Pop City  
placeOfPerformance.city.
code
string   No No Pop City code  
placeOfPerformance.city.
name
string   No No Pop City name  
placeOfPerformance.state JSON NA NA NA Pop City state  
placeOfPerformance.state.
code
string   No No Pop city state code  
placeOfPerformance.state.
name
string   No No Pop city state name  
placeOfPerformance.country JSON NA NA NA Pop Country  
placeOfPerformance.
country.code
string   No No Pop Country Code  
placeOfPerformance.
country.name
string   No No Pop Country name  
placeOfPerformance.zip string   No No Pop Country zip  
archive JSON NA NA NA    
archive.type string auto15, auto30, autocustom No Yes Archive Type  
archive.date date   No Yes (if archive.type=
autocustom)
Archive Date  
permissions JSON NA NA NA    
permissions.ivl JSON NA NA NA    
permissions.ivl.create boolean   No No permissions.ivl.create  
permissions.ivl.read boolean   No No permissions.ivl.read  
permissions.ivl.update boolean Not In Use Not In Use Not In Use Not In Use  
permissions.ivl.delete boolean Not In Use Not In Use Not In Use Not In Use  
solicitation JSON NA NA NA    
solicitation.setAside string See Set-Aside values table No No setAside  
solicitation.deadlines JSON NA NA NA    
solicitation.
deadlines.response
date YYYY-MM-DDTHH:MM:SS-05:00 No 1) Yes (for type=k,o)
2) Yes (when archive.type=
auto1)
Deadline Date  
solicitation.deadlines.
responseresponseTz
string   No No Time Zone for
Solicitation Deadline Date
 
award JSON NA NA NA    
award.date date YYYY-MM-DD No Yes only for type= a Award Date  
award.number string   No Yes only for type= i, j, a Award Number  
award.deliverOrderNumber string   No No Award Deliver Order Number  
award.amount number   No No Award Amount  
award.lineitemNumber string   No No Award Line item Number  
award.awardee JSON NA NA NA    
award.awardee.manual string boolean Yes Yes Awardee  
award.awardee.name string   No No Awardee Name  
award.awardee.duns string   No No Awardee Duns  
award.awardee.location JSON NA NA NA    
award.awardee.location.
streetAddress
string   No No Awardee Street Address 1  
award.awardee.location.
streetAddress2
string   No No Awardee Street Address 1  
award.awardee.location.
city
string   No No Awardee City  
award.awardee.location.
city.code
string   No No Awardee City code  
award.awardee.location.
city.name
string   No No Awardee City name  
award.awardee.location.
state
JSON NA NA NA    
award.awardee.location.
state.code
string   No No Awardee State code  
award.awardee.location.
state.name
string   No No Awardee State name  
award.awardee.location.
country
JSON NA NA NA    
award.awardee.location.
country.code
string   No No Awardee Country code  
award.awardee.location.
country.name
string   No No Awardee Country Name  
award.awardee.location.
zip
string   No No Awardee Country Zip  
justificationAuthority JSON NA NA NA    
justificationAuthority.
modificationNumber
string   No No Justification Authority Modification Number  
justificationAuthority.
authority
string   No No Justification Authority  
link JSON NA NA NA    
link.additionalInfo JSON NA NA NA    
link.additionalInfo.cotent string   No No Additional info  
link.href string   No No Website Address  
additionalReporting string none/
auto_recovery
No Yes    
description JSON NA NA NA    
description.body string   No Yes Description of notice  
attType string link, file No No Type of attachment, either link or file  
content byte   No No File content in byte format  
link string     No No Resource link or URL
packageAccessLevel string public,private(default public) No No Type of access to file or link  
resourceName string   No No Name of file  
fairOpportunity string   No No Fair Opportunity  
fairOpportunity.authority string   No No Fair Opportunity Authority  
postedDate date   No No Posted Date  
archived string     No No Archived Status

Back to top

Publish Opportunity Contract JSON

Publish_Opportunity_Contract_Json

{
  "requestType": "publish_request",
  "reason": ""
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
requestType string publish_request Yes Type of request
reason string   No Publish reason

Back to top

Revise Opportunity Contract JSON

Revise_Opportunity_Contract_Json

{
  "requestType": "update_publish_request",
  "reason": ""
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
requestType string update_publish_request Yes Type of request
reason string   Yes Reason for revision

Back to top

Cancel Opportunity Contract JSON

Cancel_Opportunity_Contract_Json

{
  "reason": "",
  "requestType": "cancel_request",
  "data": {
    "description": ""
  }
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
Reason string   Yes Reason for cancelation
requestType string cancel_request Yes Type of request
description string   Yes Description for cancelation

Back to top

Uncancel Opportunity Contract JSON

Uncancel_Opportunity_Contract_Json

{
  "reason": "",
  "requestType": " uncancel_request ",
  "data": {
    "description": "",
    "newContractAwardDate": "",
    "newArchiveDate": "",
    "newArchiveType": "",
    "newResponseDate": "",
    "newResponseTz": "America/New_York",
    "newContractAwardDate": ""
  }
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
reason string   Yes Reason for uncanceling
requestType string uncancel_request Yes Type of request
description string   Yes Description for uncanceling
newContractAwardDate date YYYY-MM-DD Yes (if unarchiving an award notice) New Contract Award Date
newArchiveDate date YYYY-MM-DD Yes (if newArchiveType=autocustome) New Archive Date
newArchiveType string auto15, auto30, autocustom Yes New Archive Type
newResponseDate date YYYY-MM-DDTHH:MM:SS-05:00 Yes (if newArchiveType = auto15) New Response Date
newResponseTz string America/New_York Yes (if newResponseDate is provided) New Response Time Zone
newContractAwardDate date YYYY-MM-DD Yes (if type=a) New Contract Award Date

Back to top

Archive Opportunity Contract JSON

Archive_Opportunity_Contract_Json

{
  "reason": "",
  "requestType": "archive_request"
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
requestType string archive_request Yes Type of request
reason string   Yes Archive reason

Back to top

Unarchive Opportunity Contract JSON

Unarchive_Opportunity_Contract_Json

{
  "reason": "",
  "requestType": " unarchive_request",
  "data": {
    "newContractAwardDate": "",
    "newArchiveDate": "",
    "newArchiveType": "",
    "newResponseDate": "",
    "newResponseTz": "America/New_York"
  }
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
reason string   Yes Reason for uncanceling
requestType string unarchive_request Yes Type of request
newContractAwardDate date YYYY-MM-DD Yes (if unarchiving an award notice) New Contract Award Date
newArchiveDate date YYYY-MM-DD Yes (if newArchiveType=autocustom) New Archive Date
newArchiveType string auto15, auto30, autocustom Yes New Archive Type
newResponseDate date YYYY-MM-DDTHH:MM:SS-05:00 Yes (if newArchiveType = auto15) New Response Date
newResponseTz string America/New_York Yes (if newResponseDate is provided) New Response Time Zone

Back to top

Create Attachment Contract JSON

Create_Attachment_Contract_Json - File

{
 "attType": "file",
 "content": "",
 "resourceName": "",
 "fileType": "text/plain",
 "packageAccessLevel": "public"
}

Create_Attachment_Contract_Json - Link

{
  "attType": "link",
  "link": "",
  "description": "",
  "packageAccessLevel": ""
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
attType string link, file Yes Type of attachment, either link or file
content byte   Yes (if attType=file) File content in byte format
link string   Yes (if attType=link) Resource link or URL
packageAccessLevel string public,private(default public) No Type of access to file or link
resourceName string   Yes (if attType=file) Name of file

Valid File Types

File Extension File Type
Bitmap Image File (.bmp) image/bmp
Graphical Interchange Format File (.gif) image/gif
JPEG Image (.jpeg) image/jpeg
JPEG Image (.jpg) image/jpeg
LaTex (.tex) application/x-tex
Microsoft Excel Document (.xls) application/vnd.ms-excel
Microsoft Excel Open XML Document (.xlsx) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Microsoft Word Document (.doc) application/msword
Microsoft Word Open XML Document (.docx) application/vnd.openxmlformats-officedocument.wordprocessingml.document
OpenDocument Text Document (.odt) application/vnd.oasis.opendocument.text
Plain Text File (.txt) text/plain
Portable Document Format File (.pdf) application/pdf
Portable Network Graphic (.png) image/png
PowerPoint Open XML Presentation (.pptx) application/vnd.openxmlformats-officedocument.presentationml.presentation
PowerPoint Presentation (.ppt) application/vnd.ms-powerpoint
Rich Text Format (.rtf) application/rtf
Audio Video Interleaved (.AVI) video/avi
QuickTime (.mov) video/quicktime
MPEG (.mpg, .mpeg, .mp4) video/mpeg , video/mp4
Windows Media Video (.wmv) video/x-ms-wmv
Flash Video (.flv, .f4v) video/x-flv

Back to top

Update Attachment Contract JSON

Update_Attachment_Contract_Json

{
 "attType": "file",
 "packageAccessLevel": "private",
  "explicitAccess": "1",
"content": "SGVsbG8=",
"fileType": "text/plain"
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
attType string link, file Yes Type of attachment, either link or file
link string   Yes (if attType=link) Resource link or URL
packageAccessLevel string public,private(default public) No Type of access to file or link
resourceName string   Yes (if attType=file) Name of file
explicitAccess string 0, 1 No Defaults to ‘0’ (public access) if not provided. ‘1’ is used for Controlled Unclassified files.

Back to top

IVL Settings Contract JSON

IVL_Settings_Contract_JSON

{
  "ivlCreate": "",
  "ivlView": ""
}

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
ivlCreate string forcedon, forcedoff Yes Indicates whether vendors can indicate interest in the organization’s Opportunities
ivlView string forcedon, forcedoff Yes Indicates whether vendors can view other vendors interested in the organization’s Opportunities

Vendor Data JSON

Name Data Type Allowed Values Required Description
fname string   Yes First name of the user
lname string   Yes Last name of the user
email string   Yes Email Id of the user
contractorName string   No Contractor Name
duns string   Yes DUNS#
cageCode string   No Cage Code

Delete Notice JSON

  • Field headers in the table must match with field headers shown in JSON example
Name Data Type Allowed Values Required Description
reason string   Yes Reason for deletion
requestType string delete_request Yes Type of request
description string   Yes Description for deletion of a notice
title string   No  
newArchiveDate date YYYY-MM-DD No New Archive Date
newArchiveType string   No New Archive Type
deleteOption string latest, all Yes Option to delete either the latest or all versions of a notice
Response

   {
   "requestType”: delete_request",
    "reason":"test",
     "data": {
                           "description”: “test",
                            "title”: null,
                            "newArchiveDate":null,
                             "newArchiveType":null,
                             "deleteOption”: latest"  ( “all”  - to delete all versions)
              }
}

Back to top

Error Messages

General Error Messages

The following error messages may be returned as part of the response to various web service calls; these errors are not specific to one method and may apply to more than one.

Error codes may change depending on the error given; document will be updated accordingly.

Error Code Error Message Reason/Description
401 Please provide valid Authorization Email & API Key API Key and/or Authorization Email is required
401 Encountered error authenticating user.Invalid JWT provided Invalid Authorization Email provided
401 Insufficient privileges to retrieve system account profile as the given organization is invalid Invalid Organization ID provided
400 Error processing POST request Invalid JSON format provided
400 $.data: is missing but it is required Request JSON is empty
400 ”$.requestType: does not have a value in the enumeration [archive_request, unarchive_request, publish_request, update_publish_request, cancel_request, uncancel_request]” ] Request Type must be valid for operation
404 Please provide Opportunity id Invalid Opportunity ID provided
401 Insufficient privileges to retrieve system account profile as the given organization is not part of the approved FH hierarchy Office ID provided is not authorized for system account
401 Insufficient privileges to edit opportunity Account does not have appropriate privileges to edit opportunity
403 This opportunity cannot be published. Auto 15 archive type is not allowed for this opportunity type Archive type = auto 15 archive type is not allowed for type “u” Justification and Authorization sections

Back to top

Specific Error Messages

This section details possible error messages for specific operations.

Error codes may change depending on the error given; document will be updated accordingly.

Error Code Field Error Message Reason/Description Operation
400 Additional Reporting This opportunity cannot be published. Additional reporting is required. Additional Reporting is required with valid values of “none” or “recovery_act” Publish
400 ARCHIVE This opportunity is not the latest published. Draft Opportunity cannot be archived. Archive
400 Archive Date $.archive.date: does not match the date pattern ^\d{4}-(?:0[0-9]{1}\1[0-2]{1})-(0?[1-9][12][0-9]\3[01])$ Archive Date must be in specified format Create, Publish, Uncancel, Unarchive
400 Archive Date This opportunity cannot be published. Inactive date is a required field. Archive Date is required if Archive Type = autocustom Create, Publish, Uncancel, Unarchive
400 Archive Type This opportunity cannot be published. Inactive Policy is a required field. Archive Type is required Publish
400 Archive Type $.archive.type: does not have a value in the enumeration[auto15, auto30, autocustom] Archive type must be specified value Create, Publish, Uncancel, Unarchive
400 Archive Type This opportunity cannot be published. Auto 15 archive type is not allowed for this opportunity type. Archive Type = auto15 not allowed Publish
400 attType Attachment must have AttType of file or link Attachment type must be a file or a line Create Attachment
401 Authorization Insufficient privileges to edit opportunity See User Account Authorization section Update, Publish, Revise
401 Authorization Insufficient privileges to create opportunity Insufficient privileges to create an award notice. See User Account Authorization section for more details. Create Opportunity
401 Authorization Insufficient privileges to create request Insufficient privileges to publish an award notice. See User Account Authorization section for more details. Create
400 Award Award Details Section - Contract Award Dollar Amount is not a valid field for this opportunity type Award Section is not valid for Base Notice Types (s, o, p, r, g, k, i) Publish
400 Award Amount Award Detail Section-Please enter valid integer for Amount Field Award Amount required Publish
400 Award Amount Award Details Section - Contract Award Dollar Amount is not a valid field for this opportunity type Contract Award Amount only valid for Type “a” Award Publish
400 Award Date Award Details Section - Contract Award Date provided is in an invalid format. Date is not in specified format Create Opportunity, Publish, Uncancel, Unarchive
400 Award Date Award Details section -Award date provided is in the past. Award Date must be current or future date. Create Opportunity, Publish, Uncancel, Unarchive
400 Award Number Award Details Section - Contract Award Number is a required field Contract Award Number is missing Publish, Uncancel, Unarchive
400 Classification Code This opportunity cannot be published. Classification Code provided did not match expected codes Invalid PSC provided Publish
400 CANCEL This opportunity cannot be cancelled. This opportunity is a revision. Cannot cancel a revised Opportunity. Cancel
400 Content File Resource must have content. File Resource must be filled out Create Attachment
400 Contract Award Dollar Amount Award Details Section – Please enter valid integer for Amount Field Valid integer amount must be entered for award dollar amount Publish
401 CREATE Insufficient privileges to create opportunity Account does not have appropriate privileges to create opportunity CREATE
401 CREATE ATTACHMENT Insufficient privileges to upload attachment Attachments cannot be added to published notices Create Attachment
400 Deadlines Response This opportunity cannot be published. Response Deadline Date is required Publish
400 Description Description is required Description is required Publish
400 IVL This opportunity cannot be published. Interested Vendors List Add is a required field. Interested Vendors List Add is a required Publish
400 Justification Authority This opportunity cannot be published. Justification Authority is not valid field for this opportunity type Justification Authority Section is not valid for Base Notice Types (s, o, p, r, g, k, i) Publish
400 Justification Authority This opportunity cannot be published. Justification Authority Modification Number is not valid field for this opportunity type. Justification Authority Section is not valid for Base Notice Types (s, o, p, r, g, k, i) Publish
400 Justification Authority This opportunity cannot be published. Justification Authority is not valid field for this opportunity type Justification Authority only valid for Type “u” Justification and Authorization Publish
400 Justification Authority This opportunity cannot be published. Justification Authority Modification Number is not valid field for this opportunity type Justification Authority Modification Number is only valid for Type “u” Justification and Authorization Publish
400 NAICS Code This opportunity cannot be published. NAICS provided did not match expected codes NAICS Code is invalid Create Opportunity, Publish
400 NAICS Type $.data.naics[0].type: does not have a value in the enumeration [primary] NAICS Type is required Create Opportunity
400 Notice Type This opportunity cannot be published. The opportunity type j is no longer supported See Notice Types table for valid notice types Publish
400 Opportunity ID Opportunity ID for the selected opportunity type already exists Cannot publish an existing published record Publish
400 Opportunity ID Opportunity cannot be updated An Opportunity cannot be revised if that Opporutnity was revised previously and is currently in draft state Revise
404 Opportunity ID Opportunity ID is required Opportunity ID is required All
400 Opportunity Type Opportunity type is required Opportunity type is required Create Opportunity
400 Opportunity Type errorCode”:400,”message”:”Opportunity type given is not a valid type.” Opportunity type is empty Create Opportunity
400 Organization Id Contracting office is required FH Org Id/AAC code is required Publish
400 Organization Id The Organization ID that you provided is an inactive and/or invalid. Inactive/Invalid Organization Id Create Opportunity
400 Organization Id The Organization ID that you provided is not an office level, and it must be for this opportunity type. Organization ID is not valid for opportunity type. Note: Organization ID must be Office level unless creating a Special Notice. Create Opportunity
400 Point of Contact Type $.data.pointOfContact[0].type: does not have a value in the enumeration [primary, secondary, owner] Point of Contact Type is required Create Opportunity
400 Point of Contact Email Primary Contact – Email is required If Contact email is missing. This is a required field Publish
400 Primary Contact Full Name Primary Contact - Name is required Point of Contact Full Name is required Publish
400 Response Date This opportunity cannot be published. Response Date is a required field Response Date is only valid for Notice Type “o” Publish
400 Title Title is required Title is required Publish
400 UNARCHIVE This opportunity is not the latest published Only archived notices can be unarchived UNARCHIVE
400 resourceName Attachment must have a name File Name is a required field Create Attachment
400 Request Id Duplicate request. Vendor is already added as an authorized party on the notice. Request already exists for the vendor on the notice. AddAuthorizedParty
400 Duns# No contact match on vendor data provided. Not a Valid email or Duns#. AddAuthorizedParty
401 Authorization Error code: 401 ; User does not have sufficient privileges to perform this action Invalid API key is used other than write sensitive permission Add Authorized Party
400 Authorization Error code: 400 ; Duplicate request. Vendor is already added as an authorized party on the notice If a party is already added and is being added again by a contract writing individual Add Authorized Party
401 Authorization Error code: 401 ; Your request did not get processed! Please verify your permission/roles If nonfed email id is used in authorization Get Authorized Party
400 Entity Error code: 400 ; No contact match on vendor data provided Wrong entity info is entered Add Authorized Party
400 Duns# No contact match on vendor data provided. Not a Valid email or Duns#. AddAuthorizedParty, Approve or Reject Explicit Access Request By Vendor Data.
404 Opportunity Id, VendorData No request found for the notice and the vendor data provided. Unable to find a request for the opportunity and vendor details provided. Approve or Reject Explicit Access Request By Vendor Data.
400 JSON No Request JSON Given Can’t parse JSON. Raw result: error processing request Delete Latest or All Notices

FAQ

Back to top

Contact Us

Change Log

Date Version Description
4/25/2019 v.01 Base Version
4/29/2019 v0.2 Added information for Get Authorized Party List
Added Add Authorized Party
Added Vendor Data JSON
POC Email changed to not required
Change log added
Secure Attachment Download Authorization section added
Alpha and Beta endpoint section added
5/23/2019 v0.3 Update IVL Settings URL
Removed Get IVL by DUNS
Added EntityID to getIVL API parameter
Updated Get Authorized Party
Updated Add Authorized Party
Error Message Section Updated
5/28/2019 v0.4 Updated Add Authorized Party
Get Authorized Party
Delete All Attachments API’s
Added Delete Notice API
Updated User Permissions
Create and Publish Contract Opportunity
6/6/2019 v0.5 Deleted Download All Attachments (metadata)
Added Download All Attachments by Resource ID
Added Download All Attachments by Opportunity ID
7/22/2019 v0.6 Only title required to create draft opportunity
Solicitation number not required for create/update draft notices JSON
soliciation.deadlines.response required for types k and o to publish
Contract Award Date required only for Award to publish
Contract Award Number required only for a, j, and i to publish
POC email required except for Award to publish
Description not needed for Update Attachment JSON
Workflow Chart Added
8/1/2019 v0.71 Added Future Implementation for IP Address Validation and Type of Connection
Delete Draft Opportunities Role changed so that CO and Admin can Delete
Reason not required for Publish Opportunity
8/19/2019 v0.72 API Names Updated
Valid File Types Updated
8/29/2019 v0.73 Error Codes Added
8/29/2019 v0.74 Updated the missing description for explicitAccess field in Update Attachment Contract JSON
10/10/2019 v0.8 Updated the Set-Aside values with the latest codes

Back to top