diff --git a/APIDOCS.md b/APIDOCS.md
old mode 100755
new mode 100644
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
old mode 100755
new mode 100644
diff --git a/LICENSE.md b/LICENSE.md
old mode 100755
new mode 100644
diff --git a/README.md b/README.md
old mode 100755
new mode 100644
diff --git a/_apidocs/get-opportunities-public-api.md b/_apidocs/get-opportunities-public-api.md
index 1272184a6..56cbcaaa5 100644
--- a/_apidocs/get-opportunities-public-api.md
+++ b/_apidocs/get-opportunities-public-api.md
@@ -47,7 +47,7 @@ deptname | Department Name (L1) |No| String
subtier| Agency Name (L2)| No| String
state| Place of Performance (State)| No |String
zip| Place of Performance (Zip code)| No| String
-typeOfSetAside| Legacy Set Aside codes & their descriptions are:
1 = Partial Small Business
2 = Partial HBCU / MI
3 = Service-Disabled Veteran-Owned Small Business
4 = Total Women-owned Business
5 = HUBZone
6 = Total Small Disadvantage Business
7 = Total Small Business
8 = Veteran-Owned Small Business
9 = Total HBCU / MI
10 = Partial Women-owned Business
11 = Partial HUB-Zone
12 = Partial Small Disadvantage Business
13 = Very Small Business
14 = Competitive 8(a)
15 = Emerging Small Business
16 = Woman Owned Small Business
17 = Economically Disadvantaged Woman Owned Small Business
18 = Indian Economic Enterprises
19 = Indian Small Business Economic Enterprises
Modern Set Aside codes & their descriptions are:
1000001 = Total Small Business Set-Aside (FAR 19.5)
1000002 = Partial Small Business Set-Aside (FAR 19.5)
1000003 = 8(a) Set-Aside (FAR 19.8)
1000004 = 8(a) Sole Source (FAR 19.8)
1000005 = Historically Underutilized Business (HUBZone) Set-Aside (FAR 19.13)
1000006 = Historically Underutilized Business (HUBZone) Sole Source (FAR 19.13)
1000007 = Service-Disabled Veteran-Owned Small Business (SDVOSB) Set-Aside (FAR 19.14)
1000008 = Service-Disabled Veteran-Owned Small Business (SDVOSB) Sole Source (FAR 19.14)
1000009 = Women-Owned Small Business (WOSB) Program Set-Aside (FAR 19.15)
1000010 = Women-Owned Small Business (WOSB) Program Sole Source (FAR 19.15)
1000011 = Economically Disadvantaged WOSB (EDWOSB) Program Set-Aside (FAR 19.15)
1000012 = Economically Disadvantaged WOSB (EDWOSB) Program Sole Source (FAR 19.15)
1000013 = Local Area Set-Aside (FAR 26.2)
2000001 = Indian Economic Enterprise (IEE) Set-Aside (specific to Department of Interior)
2000002 = Indian Small Business Economic Enterprise (ISBEE) Set-Aside (specific to Department of Interior)
2000003 = Buy Indian Set-Aside (specific to Department of Health and Human Services, Indian Health Services)
2000004 = Veteran-Owned Small Business Set-Aside (specific to Department of Veterans Affairs)
2000005 = Veteran-Owned Small Business Sole source (specific to Department of Veterans Affairs)
Note: Backend is making a transition to the modern set aside codes in phases. Hence the document lists both the setAside codes for now |No |String
+typeOfSetAside| [Refer Set-Aside Value Section](#set-aside-values) |No |String
typeOfSetAsideDescription |Set Aside code Description. See above descriptions mentioned against each of the Set Aside Code| No| String
ncode| NAICS Code. This code is maximum of 6 digits| No| String
ccode| Classification Code| No| String
@@ -421,11 +421,12 @@ User clicks on the description link available in the response and description co
Date | Version | Description
------|---------------|---------
-5/20/19 | v1.0 | Base Version
-8/6/19 | v1.1| Format Updated
-10/17/19 | v1.2| Added Set-Aside Code
-10/23/19 | v1.3| Set-Aside Values Updated
-10/24/19| v1.4| Office Address Description Updated
-11/1/19| v1.5| - Street Address 1 & 2 removed from Response
- Status and Description removed from request
- Limit changed to "Required"
- Asynchronous opportunities file download feature disabled
- Response returns only the latest active version of a notice
+5/20/19 | v0.1 | Base Version
+8/6/19 | v0.2| Format Updated
+10/17/19 | v0.3| Added Set-Aside Code
+10/23/19 | v0.4| Set-Aside Values Updated
+10/24/19| v0.5| Office Address Description Updated
+11/1/19| v1.0| Initial Release Finalized
+
{
- "data":
- {
+ "data": {
"type": "o",
"solicitationNumber": "test-12345678901",
"title": "Test submit solicitation",
"organizationId": "100186612",
"classificationCode": "1260",
"naics": [
- {
- "type": "primary",
- "code": ["111150"]
- }],
+ {
+ "type": "primary",
+ "code": [
+ "111150"
+ ]
+ }
+ ],
"pointOfContact": [
- {
- "type": "primary",
- "title": "",
- "fullName": "test contact",
- "email": "test@test.com",
- "phone": "",
- "fax": "",
- "additionalInfo":
{
- "content": "Primary contact info"
+ "type": "primary",
+ "title": "",
+ "fullName": "test contact",
+ "email": "test@test.com",
+ "phone": "",
+ "fax": "",
+ "additionalInfo": {
+ "content": "Primary contact info"
+ }
}
- }],
- "placeOfPerformance":
- {
+ ],
+ "placeOfPerformance": {
"streetAddress": "1234 XYZ street",
"streetAddress2": "",
"city": {
@@ -457,85 +458,74 @@ Examples
},
"country": {
"code": "USA",
- "name":"USA"
- }
-,
+ "name": "USA"
+ },
"zip": ""
},
- "archive":
- {
+ "archive": {
"type": "autocustom",
"date": "2022-09-09"
},
- "permissions":
- {
- "IVL":
- {
+ "permissions": {
+ "IVL": {
"create": false,
"delete": false,
"read": false,
"update": false
}
},
- "solicitation":
- {
+ "solicitation": {
"setAside": "SBA",
- "deadlines":
- {
+ "deadlines": {
"response": "2022-08-08"
}
},
- "award":
- {
+ "award": {
"date": "",
"number": "",
"deliveryOrderNumber": "",
"amount": "",
"lineItemNumber": "",
- "awardee":
- {
+ "awardee": {
"manual": false,
"name": "",
"duns": "",
- "location":
- {
+ "location": {
"streetAddress": "",
"streetAddress2": "",
- "city":
- {
+ "city": {
"code": "",
"name": ""
},
- "state":
- {
+ "state": {
"code": "",
"name": ""
},
"zip": "",
- "country":
- {
+ "country": {
"code": "",
"name": ""
}
}
- }
},
- "justificationAuthority":
- {
+ "justificationAuthority": {
"modificationNumber": "",
"authority": "dictionary"
- },
- "additionalReporting": ["none"]
+ }
},
- "description": [
+ "additionalReporting": [
+ "none"
+ ]
+ },
+ "description": [
{
"body": "test description"
- }],
- "related":
- {
- "opportunityId": "bc14e9f810a44e468c31fd120dd41b4f"
}
+ ],
+ "related": {
+ "opportunityId": "bc14e9f810a44e468c31fd120dd41b4f"
}
+}
@@ -574,7 +564,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
{
@@ -616,7 +606,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Create and Publish Request for a 'SOLICITATION' Opportunity with attachments/links related to a 'PRESOL' notice:
+Create and Publish Request for a 'SOLICITATION' Opportunity with attachments/links related to a 'PRESOL' notice
{
@@ -709,12 +699,12 @@ Examples
"name": ""
}
}
+ },
+ "justificationAuthority": {
+ "modificationNumber": "",
+ "authority": "dictionary"
}
},
- "justificationAuthority": {
- "modificationNumber": "",
- "authority": "dictionary"
- },
"additionalReporting": [
"none"
]
@@ -779,7 +769,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Revise Opportunity Request:
+Revise Opportunity Request
{
@@ -826,109 +816,109 @@ Examples
{
- "data": {
- "solicitationNumber": "ITB_Test1_Update",
- "title": "TST_T1_update",
- "type": "i",
- "classificationCode": "13",
- "organizationId": "100120624",
- "naics": [
- {
- "type": "primary",
- "code": [
- "111150"
- ]
- }
- ],
- "pointOfContact": [
- {
- "additionalInfo": {
- "content": ""
+ "data": {
+ "solicitationNumber": "ITB_Test1_Update",
+ "title": "TST_T1_update",
+ "type": "i",
+ "classificationCode": "13",
+ "organizationId": "100186612",
+ "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": ""
},
- "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"
+ },
+ "additionalReporting": [
+ "none"
+ ]
},
- "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": ""
- }
+ "description": [
+ {
+ "body": "Description_updated"
}
- }
- },
- "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"
- },
- "additionalReporting": [
- "none"
]
- },
- "description": [
- {
- "body": "Description_updated"
- }
- ]
}
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
+Response Element | Response Type | 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:
+History Response
{
@@ -1264,7 +1254,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
-_NA_
+N/A
@@ -1296,7 +1286,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Delete latest version of a notice:
+Delete latest version of a notice
{
@@ -1349,6 +1339,8 @@ size | query | integer | No | Size limit is 10 by default
solNumber | query | string | No | Solicitation Number
sortBy | query | string | No | Sort (-createdOn, -modifiedOn)
status| query | Array[string] | No | Active - All Published Active Notice
Draft - All Draft Notice
Published - All Published Notice
Inactive - All archived/Inactive Notice (before archive)
Cancelled - All Cancelled Notice
(comma separated)
+orgStatus| query | Array | No| Organization Status: Active, Inactive, Mapped, Unmapped
+Links | query | boolean | |No | Links; Default Value = True
@@ -1358,122 +1350,122 @@ 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 | |
+Response Element | Response Type | 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 Delivery 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 | (**Planned to be deprecate by October 2020**) Awardee UEI DUNS
+data.award.awardee.ueiSAM | string | (**Planned to replace Duns# by October 2020 and usable by December 2019**) Awardee UEI SAM
+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
+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 |
Examples
Get List of Opportunities Response:
+Get List of Opportunities Response
{
@@ -1753,13 +1745,13 @@ 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
+PostedFrom | query | string | No | Posted Date
Responses
-See Responses for Get List of Opportunity - link to the above display
+See Response for Get List of Opportunities
Examples
@@ -1912,7 +1904,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Cancel Request:
+Cancel Request
{
@@ -2028,7 +2020,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Archive Request:
+Archive Request
{
@@ -2298,7 +2290,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
-_NA_
+N/A
@@ -2332,7 +2324,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
-_NA_
+N/A
@@ -2383,38 +2375,40 @@ 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 #)
+entityId | query | string | No | (**Planned to be deprecate by October 2020**) Entity ID - UEI DUNS #
+ueiSAM | query | string | No | (**Planned to replace Duns# by October 2020 and usable by December 2019**) UEI SAM #
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
+HTTP Status Code | Response Type | Description
+-----------------|---------------|------------
+ivl | JSON |
+ivl.duns | string | (**Planned to be deprecate by October 2020**) UEI DUNS number for the business entity
+ivl.ueiSAM | string | (**Planned to replace Duns# by October 2020 and usable by December 2019**) UEI SAM 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
+Get IVL Response
ivl": [
@@ -2472,7 +2466,7 @@ ivl": [
-### Download Metadata for an Attachment by Resource ID ###
+### Download Metadata for All Attachments by Resource ID ###
------- | -------
**Request Type** | GET
@@ -2499,7 +2493,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Response
+Get Attachments details by Resource Id Response
{
@@ -2555,7 +2549,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Response
+Get Attachments details by Opportunity Id Response
{
@@ -2618,7 +2612,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Request - IVL Settings
+IVL Settings Request
{
@@ -2659,7 +2653,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Response – Get Authorized Party
+Get Authorized Party List Response
{
@@ -2704,7 +2698,7 @@ Examples
"cageCode": "1DJP1”
}
]
- },
+ }
}
Request – Add Authorized Party
+Add Authorized Party Request
{
@@ -2780,7 +2774,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Response – Check Unique Solicitation Number
+Check Unique Solicitation Number Response
{
@@ -2820,7 +2814,7 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Response – Get Related Opportunities
+Get Related Opportunities Response
{
@@ -2960,12 +2954,12 @@ Examples
"name": ""
}
}
+ },
+ "justificationAuthority": {
+ "modificationNumber": "",
+ "authority": "dictionary"
}
},
- "justificationAuthority": {
- "modificationNumber": "",
- "authority": "dictionary"
- },
"additionalReporting": [
"none"
]
@@ -2989,76 +2983,78 @@ Examples
Name | Data Type |Field Length | Allowed Values | Required (Create/Update) | Required (Publish) | Description
-----|-----------|-------|-------------------|------------|------------ |----------
-type | string | 1 character| [Refer Notice Types](#notice-types) | Yes | Yes | Notice Type
-solicitationNumber | string | 128 characters |a-z A-Z 0-9 - _ ( ) {} |No | Yes (No for type = s (Special Notice)) | Solicitation Number
-title | string | 256 characters | |Yes | Yes | Title of the Opportunity
-organizationId | string | 32 characters | | Yes | Yes | FH Organization Id/AAC code of the office where an Opportunity is being submitted
-classificationCode | string | | | No | Yes (No for type = r, g, a (SourcesSought, Sale of Surplus, Awards)) | Product Service Code (PSC)
-naics | JSON Array | NA |NA | NA | NA |
-naics.code | Array of String | | NAICS Reference| No | Yes for type = k, o (Combined Synopsis, Solicitation) | Valid NAICS Code
-naics.type | string | |primary| No | Yes | NAICS Type Note: 'p' must be in lower case
-pointOfContact | JSON Array | NA |NA | NA | NA |
-pointOfContact.type | string | | primary
secondary | No | Yes (No for type = a, s (Award, Special Notice)) | Contact Type Note: 'p' and 's' must be in lower case
-pointOfContact.title | string | | | No | No | Contact title
-pointOfContact.fullname | string | 255 characters| | No | Yes (No for type = a (Award))| Contact Full Name
-pointOfContact.email | string |255 characters | | No | Yes (No for type = a (Award)) | Contact email
-pointOfContact.phone | string |255 characters | | No | No | Contact Phone
-pointOfContact.fax | string | 255 characters | | No | No | Contact Fax
-pointOfContact.additionalInfo | JSON |NA |NA | NA | NA | Any additional information on Point of Contact
-pointOfContact.additionalInfo.
content | String | | | No | No | Details of the additional information on Point of Contact
-placeOfPerformance | JSON | NA | NA | NA | NA |
-placeOfPerformance.
streetAddess | string | | | No | No | Pop Address
-placeOfPerformance.
streetAddess2 | string | | | No | No | Pop Address2
-placeOfPerformance.city | JSON | NA | 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 | 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 | 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 | NA | Contract opportunity archive policy information
-archive.type | string | | auto15
auto30
autocustom | No | Yes | Archive Type
The policy will determine the date either by validation of other dates associated to the notice or by a manually entered date that will be used for marking the notice inactive
-archive.date | date | | | No | Yes for archive.type = autocustom | Archive Date
This date will indicate when a notice will be moved to the inactive status. This date must be in the future
-permissions | JSON | NA | NA | NA | NA |
-permissions.ivl | JSON | NA | NA | NA | NA |Government determined use and visibility of the 'Interested Vendor's List' where users outside the notice can indicate a interest in the notice
-permissions.ivl.create | boolean | | | No | Yes (No for type = a (Award)) | IVL create permission
-permissions.ivl.read | boolean | | | No | Yes (No for type = a (Award)) | IVL read permission
-permissions.ivl.update | boolean | | | No | No | IVL update permission
-permissions.ivl.delete | boolean | | | No | No | IVL delete permission
-solicitation | JSON |NA | NA | NA | NA |
-solicitation.setAside | string | |[Refer Set-Aside Values](#set-aside-values) | No | No | Set-Aside code
The designator for type of set aside determined for the contract action
-solicitation.deadlines | JSON | NA | NA | NA | NA |Response deadline date for Contract opportunity
-solicitation.
deadlines.response | date | |YYYY-MM-DDTHH:MM:SS-05:00 | No | 1) Yes for type = k, o (Combine Synopsis, Solicitation)
2) Yes if archive.type=auto15 except type = a (Award) | Deadline Date
-solicitation.deadlines.
responseTz |string | | | No | No | Time Zone for
Solicitation Deadline Date
-award | JSON | NA | NA | NA | NA | This section is mainly used for providing award information that is required for Award, Justification and Intent to Bundle opportunity types
-award.date | date | |YYYY-MM-DD |No | Yes only for type = a (Award) | Award Date
-award.number | string | 255 characters | |No | Yes only for type= i, j, a (Intent to Bundle, Justification, Award) | Award Number
-award.deliverOrderNumber | string | 255 characters| | No | Yes only for type = j (Justification) | Award Delivery Order Number
-award.amount | number |64 digits | | No | Yes only for type = a (Award) | Award Amount
-award.lineitemNumber | string |255 characters | | No | No | Contract Line item Number
-award.awardee | JSON | NA| NA | NA | NA |Awardee details; Only for type = a (Award)
-award.awardee.name | string | 255 characters | | No | No; Either awardee.name or awardee.duns is required | Awardee Name
-award.awardee.duns | string | 9 digits | | No | No; Either awardee.name or awardee.duns is required | Awardee Duns
-award.awardee.location | JSON |NA | NA | NA | NA | Awardee Location details; **Required if awardee.name is provided**
-award.awardee.location.
streetAddress | string | | | No | No | Awardee Street Address
-award.awardee.location.
streetAddress2 | string | | | No | No | Awardee Street Address 2
-award.awardee.location.
city | JSON |NA |NA |NA | NA | Awardee City details
-award.awardee.location.
city.code | string | | | No | Yes | Awardee City code
-award.awardee.location.
city.name | string | | | No | No | Awardee City name
-award.awardee.location.
state | JSON | NA | NA | NA | NA | Awardee State details
-award.awardee.location.
state.code | string | | | No | Yes | Awardee State code
-award.awardee.location.
state.name | string | | | No | No | Awardee State name
-award.awardee.location.
country | JSON | NA| NA | NA | NA |Awardee Country details
-award.awardee.location.
country.code | string | | | No | Yes | Awardee Country code
-award.awardee.location.
country.name | string | | | No | No | Awardee Country Name
-award.awardee.location.
zip | string | | | No | No | Awardee Country Zip code
-justificationAuthority | JSON |NA |NA | NA | NA | Only for type = j (Justification)
-justificationAuthority.
modificationNumber | string | 32 characters| | No | No | Justification Authority Modification Number
-justificationAuthority.
authority | string| | | No | Yes | Justification Authority
-additionalReporting | string | |None,
auto_recovery | No | Yes; No for type = s (Special Notice) | Initiative that applies to the notice
+data | JSON |NA | NA | NA | NA |
+data.type | string | 1 character| [Refer Notice Types](#notice-types) | Yes | Yes | Notice Type
+data.solicitationNumber | string | 128 characters |a-z A-Z 0-9 - _ ( ) {} |No | Yes (No for type = s (Special Notice)) | Solicitation Number
+data.title | string | 256 characters | |Yes | Yes | Title of the Opportunity
+data.organizationId | string | 32 characters | | Yes | Yes | FH Organization Id/AAC code of the office where an Opportunity is being submitted
+data.classificationCode | string | | | No | Yes (No for type = r, g, a (SourcesSought, Sale of Surplus, Awards)) | Product Service Code (PSC)
+data.naics | JSON Array | NA |NA | NA | NA |
+data.naics.code | Array of String | | NAICS Reference| No | Yes for type = k, o (Combined Synopsis, Solicitation) | Valid NAICS Code
+data.naics.type | string | |primary| No | Yes | NAICS Type Note: 'p' must be in lower case
+data.pointOfContact | JSON Array | NA |NA | NA | NA |
+data.pointOfContact.type | string | | primary,
secondary | No | Yes (No for type = a, s (Award, Special Notice)) | Contact Type Note: 'p' and 's' must be in lower case
+data.pointOfContact.title | string | | | No | No | Contact title
+data.pointOfContact.fullname | string | 500 characters| | No | Yes (No for type = a (Award))| Contact Full Name
+data.pointOfContact.email | string |255 characters | | No | Yes (No for type = a (Award)) | Contact email
+data.pointOfContact.phone | string |255 characters | | No | No | Contact Phone
+data.pointOfContact.fax | string | 255 characters | | No | No | Contact Fax
+data.pointOfContact.additionalInfo | JSON |NA |NA | NA | NA | Any additional information on Point of Contact
+data.pointOfContact.additionalInfo.
content | String | | | No | No | Details of the additional information on Point of Contact
+data.placeOfPerformance | JSON | NA | NA | NA | NA |
+data.placeOfPerformance.
streetAddess | string | | | No | No | Pop Address
+data.placeOfPerformance.
streetAddess2 | string | | | No | No | Pop Address2
+data.placeOfPerformance.city | JSON | NA | NA | NA | NA | Pop City
+data.placeOfPerformance.city.
code | string | | | No | No | Pop City code
+data.placeOfPerformance.city.
name | string | | | No | No | Pop City name
+data.placeOfPerformance.state | JSON |NA | NA | NA | NA | Pop City state
+data.placeOfPerformance.state.
code | string | | | No | No | Pop city state code
+data.placeOfPerformance.state.
name | string | | | No | No | Pop city state name
+data.placeOfPerformance.country | JSON | NA | NA | NA | NA | Pop Country
+data.placeOfPerformance.
country.code | string | | | No | No | Pop Country Code
+data.placeOfPerformance.
country.name | string | | | No | No | Pop Country name
+data.placeOfPerformance.zip | string | | | No | No | Pop Country zip
+data.archive | JSON |NA | NA | NA | NA | Contract opportunity archive policy information
+data.archive.type | string | | auto15,
auto30,
autocustom | No | Yes | Archive Type
The policy will determine the date either by validation of other dates associated to the notice or by a manually entered date that will be used for marking the notice inactive
+data.archive.date | date | | | No | Yes for archive.type = autocustom | Archive Date
This date will indicate when a notice will be moved to the inactive status. This date must be in the future
+data.permissions | JSON | NA | NA | NA | NA |
+data.permissions.ivl | JSON | NA | NA | NA | NA |Government determined use and visibility of the 'Interested Vendor's List' where users outside the notice can indicate a interest in the notice
+data.permissions.ivl.create | boolean | | | No | Yes (No for type = a (Award)) | IVL create permission
+data.permissions.ivl.read | boolean | | | No | Yes (No for type = a (Award)) | IVL read permission
+data.permissions.ivl.update | boolean | | | No | No | IVL update permission
+data.permissions.ivl.delete | boolean | | | No | No | IVL delete permission
+data.solicitation | JSON |NA | NA | NA | NA |
+data.solicitation.setAside | string | |[Refer Set-Aside Values](#set-aside-values) | No | No | Set-Aside code
The designator for type of set aside determined for the contract action
+data.solicitation.deadlines | JSON | NA | NA | NA | NA |Response deadline date for Contract opportunity
+data.solicitation.
deadlines.response | date | |YYYY-MM-DDTHH:MM:SS-05:00 | No | 1) Yes for type = k, o (Combine Synopsis, Solicitation)
2) Yes if archive.type=auto15 except type = a (Award) | Deadline Date
+data.solicitation.deadlines.
responseTz |string | | | No | No | Time Zone for
Solicitation Deadline Date
+data.award | JSON | NA | NA | NA | NA | This section is mainly used for providing award information that is required for Award, Justification and Intent to Bundle opportunity types
+data.award.date | date | |YYYY-MM-DD |No | Yes only for type = a (Award) | Award Date
+data.award.number | string | 255 characters | |No | Yes only for type= i, j, a (Intent to Bundle, Justification, Award) | Award Number
+data.award.deliverOrderNumber | string | 255 characters| | No | No | Award Delivery Order Number
+data.award.amount | number |64 digits | | No | Yes only for type = a (Award) | Award Amount
+data.award.lineitemNumber | string |255 characters | | No | No | Contract Line item Number
+data.award.awardee | JSON | NA| NA | NA | NA |Awardee details; Only for type = a (Award)
+data.award.awardee.name | string | 1000 characters | | No | No; Either awardee.name or awardee.duns is required | Awardee Name
+data.award.awardee.duns | string | 9 digits | | No | No; Either awardee.name or awardee.duns is required |(**Planned to be deprecate by October 2020**) Awardee UEI Duns
+data.award.awardee.ueiSAM | string | 12 characters | | No | No; **Requirements will be set at a later date** |(**Planned to replace Duns# by October 2020 and usable by December 2019**) Awardee UEI SAM
+data.award.awardee.location | JSON |NA | NA | NA | NA | Awardee Location details; **Required if awardee.name is provided**
+data.award.awardee.location.
streetAddress | string | | | No | No | Awardee Street Address
+data.award.awardee.location.
streetAddress2 | string | | | No | No | Awardee Street Address 2
+data.award.awardee.location.
city | JSON |NA |NA |NA | NA | Awardee City details
+data.award.awardee.location.
city.code | string | | | No | Yes | Awardee City code
+data.award.awardee.location.
city.name | string | | | No | No | Awardee City name
+data.award.awardee.location.
state | JSON | NA | NA | NA | NA | Awardee State details
+data.award.awardee.location.
state.code | string | | | No | Yes | Awardee State code
+data.award.awardee.location.
state.name | string | | | No | No | Awardee State name
+data.award.awardee.location.
country | JSON | NA| NA | NA | NA |Awardee Country details
+data.award.awardee.location.
country.code | string | | | No | Yes | Awardee Country code
+data.award.awardee.location.
country.name | string | | | No | No | Awardee Country Name
+data.award.awardee.location.
zip | string | | | No | No | Awardee Country Zip code
+data.award.justificationAuthority | JSON |NA |NA | NA | NA | Only for type = j (Justification)
+data.award.justificationAuthority.
modificationNumber | string | 32 characters| | No | No | Justification Authority Modification Number
+data.award.justificationAuthority.
authority | string| | | No | Yes for type = j (Justification) | Justification Authority
+data.additionalReporting | string | |None,
auto_recovery | No | Yes; No for type = s (Special Notice) | Initiative that applies to the notice
description | JSON | NA | NA | NA | NA |
description.body | string | 65535 characters| | No | Yes; No for type = a (Award) | Description of the notice
related | JSON | NA | NA | NA | NA | Related Notice information
@@ -3189,12 +3185,12 @@ reason | string | | No | Publish reason
"name": ""
}
}
+ },
+ "justificationAuthority": {
+ "modificationNumber": "",
+ "authority": "dictionary"
}
},
- "justificationAuthority": {
- "modificationNumber": "",
- "authority": "dictionary"
- },
"additionalReporting": [
"none"
]
@@ -3232,76 +3228,78 @@ reason | string | | No | Publish reason
Name | Data Type |Field Length | Allowed Values| Required | Description
-----|-----------|-------|-------------------|------------|------------
-type | string | 1 character| [Refer Notice Types](#notice-types) | Yes | Notice Type
-solicitationNumber | string | 128 characters |a-z A-Z 0-9 - _ ( ) {}| Yes (No for type = s (Special Notice)) | Solicitation Number
-title | string | 256 characters | | Yes | Title of the Opportunity
-organizationId | string | 32 characters | | Yes | FH Organization Id/AAC code of the office where an Opportunity is being submitted
-classificationCode | string | | | Yes (No for type = r, g, a (SourcesSought, Sale of Surplus, Awards)) | Product Service Code (PSC)
-naics | JSON Array | NA |NA | NA |
-naics.code | Array of String | | NAICS Reference| Yes for type = k, o (Combined Synopsis, Solicitation) | Valid NAICS Code
-naics.type | string | |primary|Yes | NAICS Type Note: 'p' must be in lower case
-pointOfContact | JSON Array | NA |NA | NA |
-pointOfContact.type | string | | primary
secondary | Yes (No for type = a, s (Award, Special Notice)) | Contact Type Note: 'p' and 's' must be in lower case
-pointOfContact.title | string | | | No | Contact title
-pointOfContact.fullname | string | 255 characters| | Yes (No for type = a (Award))| Contact Full Name
-pointOfContact.email | string |255 characters | | Yes (No for type = a (Award)) | Contact email
-pointOfContact.phone | string |255 characters | | No | Contact Phone
-pointOfContact.fax | string | 255 characters | | No | Contact Fax
-pointOfContact.additionalInfo | JSON |NA |NA | NA | Any additional information on Point of Contact
-pointOfContact.additionalInfo.
content | String | | | No | Details of the additional information on Point of Contact
-placeOfPerformance | JSON | NA | NA | NA |
-placeOfPerformance.
streetAddess | string | | |No | Pop Address
-placeOfPerformance.
streetAddess2 | string | | | No | Pop Address2
-placeOfPerformance.city | JSON | NA | NA |NA | Pop City
-placeOfPerformance.city.
code | string | | |No | Pop City code
-placeOfPerformance.city.
name | string | | |No | Pop City name
-placeOfPerformance.state | JSON |NA | NA |NA | Pop City state
-placeOfPerformance.state.
code | string | | | No | Pop city state code
-placeOfPerformance.state.
name | string | | | No | Pop city state name
-placeOfPerformance.country | JSON | NA | NA | NA | Pop Country
-placeOfPerformance.
country.code | string | | |No | Pop Country Code
-placeOfPerformance.
country.name | string | | |No | Pop Country name
-placeOfPerformance.zip | string | | |No | Pop Country zip
-archive | JSON |NA | NA | NA | Contract opportunity archive policy information
-archive.type | string | | auto15
auto30
autocustom | Yes | Archive Type
The policy will determine the date either by validation of other dates associated to the notice or by a manually entered date that will be used for marking the notice inactive
-archive.date | date | | |Yes for archive.type = autocustom | Archive Date
This date will indicate when a notice will be moved to the inactive status. This date must be in the future
-permissions | JSON | NA | NA | NA
-permissions.ivl | JSON | NA | NA | NA |Government determined use and visibility of the 'Interested Vendor's List' where users outside the notice can indicate a interest in the notice
-permissions.ivl.create | boolean | | | Yes (No for type = a (Award)) | IVL create permission
-permissions.ivl.read | boolean | | |Yes (No for type = a (Award)) | IVL read permission
-permissions.ivl.update | boolean | | | No | IVL update permission
-permissions.ivl.delete | boolean | | |No | IVL delete permission
-solicitation | JSON |NA | NA | NA
-solicitation.setAside | string | |[Refer Set-Aside Values](#set-aside-values) | No | Set-Aside code
The designator for type of set aside determined for the contract action
-solicitation.deadlines | JSON | NA | NA | NA |Response deadline date for Contract opportunity
-solicitation.
deadlines.response | date | |YYYY-MM-DDTHH:MM:SS-05:00 | 1) Yes for type = k, o (Combine Synopsis, Solicitation)
2) Yes if archive.type=auto15 except type = a (Award) | Deadline Date
-solicitation.deadlines.
responseTz |string | | |No | Time Zone for
Solicitation Deadline Date
-award | JSON | NA | NA | NA| This section is mainly used for providing award information that is required for Award, Justification and Intent to Bundle opportunity types
-award.date | date | |YYYY-MM-DD | Yes only for type = a (Award) | Award Date
-award.number | string | 255 characters | |Yes only for type= i, j, a (Intent to Bundle, Justification, Award) | Award Number
-award.deliverOrderNumber | string | 255 characters| | Yes only for type = j (Justification) | Award Delivery Order Number
-award.amount | number |64 digits | | Yes only for type = a (Award) | Award Amount
-award.lineitemNumber | string |255 characters | | No | Contract Line item Number
-award.awardee | JSON | NA| NA | NA |Awardee details; Only for type = a (Award)
-award.awardee.name | string | 255 characters | | No; Either awardee.name or awardee.duns is required | Awardee Name
-award.awardee.duns | string | 9 digits | | No; Either awardee.name or awardee.duns is required | Awardee Duns
-award.awardee.location | JSON |NA | NA | NA | Awardee Location details; **Required if awardee.name is provided**
-award.awardee.location.
streetAddress | string | | | No | Awardee Street Address
-award.awardee.location.
streetAddress2 | string | | | No | Awardee Street Address 2
-award.awardee.location.
city | JSON |NA |NA |NA | Awardee City details
-award.awardee.location.
city.code | string | | | Yes | Awardee City code
-award.awardee.location.
city.name | string | | | No | Awardee City name
-award.awardee.location.
state | JSON | NA | NA | NA | Awardee State details
-award.awardee.location.
state.code | string | | | Yes | Awardee State code
-award.awardee.location.
state.name | string | | | No | Awardee State name
-award.awardee.location.
country | JSON | NA| NA | NA |Awardee Country details
-award.awardee.location.
country.code | string | | | Yes | Awardee Country code
-award.awardee.location.
country.name | string | | | No | Awardee Country Name
-award.awardee.location.
zip | string | | | No | Awardee Country Zip code
-justificationAuthority | JSON |NA |NA | NA | Only for type = j (Justification)
-justificationAuthority.
modificationNumber | string | 32 characters| | No | Justification Authority Modification Number
-justificationAuthority.
authority | string| | | Yes | Justification Authority
-additionalReporting | string | |none,
auto_recovery | Yes; No for type = s (Special Notice) | Initiative that applies to the notice
+data | JSON |NA | NA | NA |
+data.type | string | 1 character| [Refer Notice Types](#notice-types) | Yes | Notice Type
+data.solicitationNumber | string | 128 characters |a-z A-Z 0-9 - _ ( ) {}| Yes (No for type = s (Special Notice)) | Solicitation Number
+data.title | string | 256 characters | | Yes | Title of the Opportunity
+data.organizationId | string | 32 characters | | Yes | FH Organization Id/AAC code of the office where an Opportunity is being submitted
+data.classificationCode | string | | | Yes (No for type = r, g, a (SourcesSought, Sale of Surplus, Awards)) | Product Service Code (PSC)
+data.naics | JSON Array | NA |NA | NA |
+data.naics.code | Array of String | | NAICS Reference| Yes for type = k, o (Combined Synopsis, Solicitation) | Valid NAICS Code
+data.naics.type | string | |primary|Yes | NAICS Type Note: 'p' must be in lower case
+data.pointOfContact | JSON Array | NA |NA | NA |
+data.pointOfContact.type | string | | primary,
secondary | Yes (No for type = a, s (Award, Special Notice)) | Contact Type Note: 'p' and 's' must be in lower case
+data.pointOfContact.title | string | | | No | Contact title
+data.pointOfContact.fullname | string | 500 characters| | Yes (No for type = a (Award))| Contact Full Name
+data.pointOfContact.email | string |255 characters | | Yes (No for type = a (Award)) | Contact email
+data.pointOfContact.phone | string |255 characters | | No | Contact Phone
+data.pointOfContact.fax | string | 255 characters | | No | Contact Fax
+data.pointOfContact.additionalInfo | JSON |NA |NA | NA | Any additional information on Point of Contact
+data.pointOfContact.additionalInfo.
content | String | | | No | Details of the additional information on Point of Contact
+data.placeOfPerformance | JSON | NA | NA | NA |
+data.placeOfPerformance.
streetAddess | string | | |No | Pop Address
+data.placeOfPerformance.
streetAddess2 | string | | | No | Pop Address2
+data.placeOfPerformance.city | JSON | NA | NA |NA | Pop City
+data.placeOfPerformance.city.
code | string | | |No | Pop City code
+data.placeOfPerformance.city.
name | string | | |No | Pop City name
+data.placeOfPerformance.state | JSON |NA | NA |NA | Pop City state
+data.placeOfPerformance.state.
code | string | | | No | Pop city state code
+data.placeOfPerformance.state.
name | string | | | No | Pop city state name
+data.placeOfPerformance.country | JSON | NA | NA | NA | Pop Country
+data.laceOfPerformance.
country.code | string | | |No | Pop Country Code
+data.placeOfPerformance.
country.name | string | | |No | Pop Country name
+data.placeOfPerformance.zip | string | | |No | Pop Country zip
+data.archive | JSON |NA | NA | NA | Contract opportunity archive policy information
+data.archive.type | string | | auto15,
auto30,
autocustom | Yes | Archive Type
The policy will determine the date either by validation of other dates associated to the notice or by a manually entered date that will be used for marking the notice inactive
+data.archive.date | date | | |Yes for archive.type = autocustom | Archive Date
This date will indicate when a notice will be moved to the inactive status. This date must be in the future
+data.permissions | JSON | NA | NA | NA
+data.permissions.ivl | JSON | NA | NA | NA |Government determined use and visibility of the 'Interested Vendor's List' where users outside the notice can indicate a interest in the notice
+data.permissions.ivl.create | boolean | | | Yes (No for type = a (Award)) | IVL create permission
+data.permissions.ivl.read | boolean | | |Yes (No for type = a (Award)) | IVL read permission
+data.permissions.ivl.update | boolean | | | No | IVL update permission
+data.permissions.ivl.delete | boolean | | |No | IVL delete permission
+data.solicitation | JSON |NA | NA | NA
+data.solicitation.setAside | string | |[Refer Set-Aside Values](#set-aside-values) | No | Set-Aside code
The designator for type of set aside determined for the contract action
+data.solicitation.deadlines | JSON | NA | NA | NA |Response deadline date for Contract opportunity
+data.solicitation.
deadlines.response | date | |YYYY-MM-DDTHH:MM:SS-05:00 | 1) Yes for type = k, o (Combine Synopsis, Solicitation)
2) Yes if archive.type=auto15 except type = a (Award) | Deadline Date
+data.solicitation.deadlines.
responseTz |string | | |No | Time Zone for
Solicitation Deadline Date
+data.award | JSON | NA | NA | NA| This section is mainly used for providing award information that is required for Award, Justification and Intent to Bundle opportunity types
+data.award.date | date | |YYYY-MM-DD | Yes only for type = a (Award) | Award Date
+data.award.number | string | 255 characters | |Yes only for type= i, j, a (Intent to Bundle, Justification, Award) | Award Number
+data.award.deliverOrderNumber | string | 255 characters| | No | Award Delivery Order Number
+data.award.amount | number |64 digits | | Yes only for type = a (Award) | Award Amount
+data.award.lineitemNumber | string |255 characters | | No | Contract Line item Number
+data.award.awardee | JSON | NA| NA | NA |Awardee details; Only for type = a (Award)
+data.award.awardee.name | string | 1000 characters | | No; Either awardee.name or awardee.duns is required | Awardee Name
+data.award.awardee.duns | string | 9 digits | | No; Either awardee.name or awardee.duns is required | (**Planned to be deprecate by October 2020**) Awardee Duns
+data.award.awardee.ueiSAM | string | 12 characters | | No; **Requirements will be set at a later date** | (**Planned to replace Duns# by October 2020 and usable by December 2019**) Awardee UEI SAM
+data.award.awardee.location | JSON |NA | NA | NA | Awardee Location details; **Required if awardee.name is provided**
+data.award.awardee.location.
streetAddress | string | | | No | Awardee Street Address
+data.award.awardee.location.
streetAddress2 | string | | | No | Awardee Street Address 2
+data.award.awardee.location.
city | JSON |NA |NA |NA | Awardee City details
+data.award.awardee.location.
city.code | string | | | Yes | Awardee City code
+data.award.awardee.location.
city.name | string | | | No | Awardee City name
+data.award.awardee.location.
state | JSON | NA | NA | NA | Awardee State details
+data.award.awardee.location.
state.code | string | | | Yes | Awardee State code
+data.award.awardee.location.
state.name | string | | | No | Awardee State name
+data.award.awardee.location.
country | JSON | NA| NA | NA |Awardee Country details
+data.award.awardee.location.
country.code | string | | | Yes | Awardee Country code
+data.award.awardee.location.
country.name | string | | | No | Awardee Country Name
+data.award.awardee.location.
zip | string | | | No | Awardee Country Zip code
+data.award.justificationAuthority | JSON |NA |NA | NA | Only for type = j (Justification)
+data.award.justificationAuthority.
modificationNumber | string | 32 characters| | No | Justification Authority Modification Number
+data.award.justificationAuthority.
authority | string| | | Yes for type = j (Justification) | Justification Authority
+data.additionalReporting | string | |none,
auto_recovery | Yes; No for type = s (Special Notice) | Initiative that applies to the notice
description | JSON | NA | NA | NA |
description.body | string | 65535 characters| | Yes; No for type = a (Award) | Description of the notice
related | JSON | NA | NA | NA | Related Notice information
@@ -3407,7 +3405,7 @@ description | string | | Yes | Description for uncanceling
newContractAwardDate | date | YYYY-MM-DD | Yes only for type = a (Award)| 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 | 1) Yes for types = k, o (Combined Synopsis/Solicitation) 2) Yes if newArchive.type=auto15 except for type = a (Award) | New Response Date
+newResponseDate | date | YYYY-MM-DDTHH:MM:SS-05:00 | 1) Yes for types = k, o (Combined Synopsis/Solicitation)
2) Yes if newArchive.type=auto15 except for type = a (Award) | New Response Date
newResponseTz | string | | No | New Response Time Zone
@@ -3469,7 +3467,7 @@ requestType | string | unarchive_request | Yes | Type of request
newContractAwardDate | date | YYYY-MM-DD | Yes for type = a (Award)| 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 | 1) Yes for types = k, o (Combined Synopsis/Solicitation) 2) Yes if newArchive.type=auto15 except for type = a (Award) | New Response Date
+newResponseDate | date | YYYY-MM-DDTHH:MM:SS-05:00 | 1) Yes for types = k, o (Combined Synopsis/Solicitation)
2) Yes if newArchive.type=auto15 except for type = a (Award) | New Response Date
newResponseTz | string | | No | New Response Time Zone
@@ -3645,7 +3643,8 @@ 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 | | Yes | Contractor Name
-duns | string | | Yes | DUNS#
+duns | string | | Yes | (**Planned to be deprecate by October 2020**) UEI DUNS#
+ueiSAM | string | | No | (**Planned to replace Duns# by October 2020 and usable by December 2019**) UEI SAM#
cageCode | string | | Yes | Cage Code
@@ -3681,6 +3680,1993 @@ deleteOption| string| latest, all| Yes| Option to delete either the latest or al
+
+### OpenAPI Specification File
+
+You can view the full details of this API in the OpenAPI Specification file available here:
+OpenAPI File
+
+Create Draft Opportunity
+
+
+/v1/api/create:
+ post:
+ tags:
+ - Opportunity
+ summary: Create contract opportunity
+ description: Create contract opportunity.
+ operationId: createOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/*
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Create and Publish Opportunity
+
+
+/v1/api/createAndPublish:
+ post:
+ tags:
+ - Opportunity
+ summary: Create and publish contract opportunity
+ description: Create and publish contract opportunity.
+ operationId: createAndPublishOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/*
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Publish Draft Opportunity
+
+
+/v1/api/publish/{opportunityId}:
+ post:
+ tags:
+ - Opportunity
+ summary: Publish contract opportunity
+ description: Publish contract opportunity.
+ operationId: publishOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Revise Published Opportunity
+
+
+/v1/api/revise/{opportunityId}:
+ post:
+ tags:
+ - Opportunity
+ summary: Revise contract opportunity
+ description: Revise contract opportunity.
+ operationId: reviseOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false/v1/api/revise/{opportunityId}:
+ post:
+ tags:
+ - Opportunity
+ summary: Revise contract opportunity
+ description: Revise contract opportunity.
+ operationId: reviseOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Update Draft Opportunity
+
+
+ /v1/api/update/{opportunityId}:
+ patch:
+ tags:
+ - Opportunity
+ summary: Update Opportunity
+ description: Update contract opportunity.
+ operationId: updateOpportunityUsingPATCH
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '204':
+ description: No Content
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '412':
+ description: Precondition Failed
+ '428':
+ description: Precondition Required
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Get Opportunity History
+
+
+/v1/api/history/{opportunityId}:
+ get:
+ tags:
+ - Opportunity
+ summary: Get history of Opportunity
+ operationId: getOpportunityHistoryUsingGET
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - name: postedFrom
+ in: query
+ description: postedFrom
+ required: false
+ type: string
+ allowEmptyValue: false
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Delete Draft Opportunity
+
+
+/v1/api/delete/{opportunityId}:
+ delete:
+ tags:
+ - Opportunity
+ summary: Delete contract opportunity
+ description: Delete contract opportunity.
+ operationId: deleteOpportunityUsingDELETE
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '204':
+ description: No Content
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Delete Notice
+
+
+/v1/api/{opportunityId}/requests:
+ post:
+ tags:
+ - Opportunity
+ summary: Delete all versions of Opportunity
+ description: Delete all versions of Opportunity.
+ operationId: deleteOpportunitiesAllVersionsUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Get List of Opportunity
+
+
+/v1/api/search:
+ get:
+ tags:
+ - Opportunity
+ summary: Get Opportunities
+ description: Get all opportunities.
+ operationId: getOpportunitiesUsingGET
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: archivedFrom
+ in: query
+ description: archivedFrom
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: archivedTo
+ in: query
+ description: archivedTo
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: awardNumber
+ in: query
+ description: awardNumber
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: doNumber
+ in: query
+ description: doNumber
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: includeCount
+ in: query
+ description: includeCount
+ required: false
+ type: boolean
+ default: true
+ allowEmptyValue: false
+ - name: keyword
+ in: query
+ description: keyword
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: latest
+ in: query
+ description: latest
+ required: false
+ type: boolean
+ default: true
+ allowEmptyValue: false
+ - name: noticeType
+ in: query
+ description: noticeType
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: multi
+ allowEmptyValue: false
+ - name: opportunityIds
+ in: query
+ description: opportunityIds
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: multi
+ allowEmptyValue: false
+ - name: organizationId
+ in: query
+ description: organizationId
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: multi
+ allowEmptyValue: false
+ - name: page
+ in: query
+ description: page
+ required: false
+ type: integer
+ default: 0
+ format: int32
+ allowEmptyValue: false
+ - name: parentNotice
+ in: query
+ description: parentNotice
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: multi
+ allowEmptyValue: false
+ - name: postedFrom
+ in: query
+ description: postedFrom
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: postedTo
+ in: query
+ description: postedTo
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: relatedNotice
+ in: query
+ description: relatedNotice
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: multi
+ allowEmptyValue: false
+ - name: responseFrom
+ in: query
+ description: responseFrom
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: responseTo
+ in: query
+ description: responseTo
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: size
+ in: query
+ description: size
+ required: false
+ type: integer
+ default: 10
+ format: int32
+ allowEmptyValue: false
+ - name: solNumber
+ in: query
+ description: solNumber
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: sortBy
+ in: query
+ description: sortBy
+ required: false
+ type: string
+ default: '-modifiedOn'
+ allowEmptyValue: false
+ - name: status
+ in: query
+ description: status
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: multi
+ allowEmptyValue: false
+ - name: orgStatus
+ in: query
+ description: Organization Status
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: multi
+ allowEmptyValue: false
+ - name: Links
+ in: query
+ description: Link
+ required: false
+ type: boolean
+ items:
+ type: string
+ collectionFormat: multi
+ allowEmptyValue: false
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ security:
+ - Token-based Access: []
+ deprecated: false
+
Get an Opportunity by Opportunity ID
+
+
+v1/api/history/{opportunityId}:
+ get:
+ tags:
+ - Opportunity
+ summary: Get history of Opportunity
+ operationId: getOpportunityHistoryUsingGET
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - name: postedFrom
+ in: query
+ description: postedFrom
+ required: false
+ type: string
+ allowEmptyValue: false
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Cancel Published Opportunity
+
+
+/v1/api/cancel/{opportunityId}:
+ post:
+ tags:
+ - Opportunity
+ summary: Cancel contract opportunity
+ description: Cancel contract opportunity.
+ operationId: cancelOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Uncancel Canceled Opportunity
+
+
+ /v1/api/uncancel/{opportunityId}:
+ post:
+ tags:
+ - Opportunity
+ summary: UnCancel contract opportunity
+ description: UnCancel contract opportunity.
+ operationId: unCancelOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Archive Opportunity
+
+
+/v1/api/archive/{opportunityId}:
+ post:
+ tags:
+ - Opportunity
+ summary: Archive contract opportunity
+ description: Archive contract opportunity.
+ operationId: archiveOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Unarchive Archived Opportunity
+
+
+/v1/api/unarchive/{opportunityId}:
+ post:
+ tags:
+ - Opportunity
+ summary: UnArchive contract opportunity
+ description: UnArchive contract opportunity.
+ operationId: unArchiveOpportunityUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Create Resource in Draft Opportunity
+
+
+/v1/api/{opportunityId}/attachments:
+ post:
+ tags:
+ - attachments
+ summary: Add attachment to an opportunity
+ description: Add attachment to an opportunity.
+ operationId: createAttachmentUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Update Resource in Draft Opportunity
+
+
+/v1/api/{opportunityId}/attachments/{resourceId}
+patch:
+ tags:
+ - attachments
+ summary: Update attachment to an opportunity
+ description: Update attachment for an opportunity.
+ operationId: updateAttachmentUsingPATCH
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - in: body
+ name: requestJson
+ description: requestJson
+ required: false
+ schema:
+ type: string
+ - name: resourceId
+ in: path
+ description: resourceId
+ required: true
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '204':
+ description: No Content
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Delete Resource in Draft Opportunity
+
+
+/v1/api/{opportunityId}/attachments/{resourceId}:
+ delete:
+ tags:
+ - attachments
+ summary: Delete attachment for an opportunity
+ description: Delete attachment for an opportunity.
+ operationId: deleteAttachmentUsingDELETE
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: deleteAll
+ in: query
+ description: deleteAll
+ required: true
+ type: string
+ default: 'false'
+ allowEmptyValue: false
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - name: resourceId
+ in: path
+ description: resourceId
+ required: true
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '204':
+ description: No Content
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Download Attachment as Original File Type
+
+
+/v1/api/resources/files/{resourceId}/download:
+ get:
+ tags:
+ - attachments
+ summary: get attachment
+ description: get attachment.
+ operationId: getAttachmentUsingGET
+ produces:
+ - '*/*'
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: resourceId
+ in: path
+ description: resourceId
+ required: true
+ type: string
+ - name: status
+ in: query
+ description: status
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: token
+ in: query
+ description: token
+ required: false
+ type: string
+ allowEmptyValue: false
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Download All Attachments as Zip for an Opportunity
+
+
+/v1/api/{opportunityId}/resources/download/zip:
+ get:
+ tags:
+ - attachments
+ summary: Download Opportunity's attachments as zip
+ description: Download Opportunity's attachments as zip.
+ operationId: downloadAttachmentsAsZipUsingGET
+ produces:
+ - application/zip
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Download Metadata for All Attachments by Resource ID
+
+
+/v1/api/resource:
+ get:
+ tags:
+ - attachments
+ summary: Download all attachments from resource Id
+ description: Download attachments for an Resource.
+ operationId: downloadAttachmentsByResourceUsingGET
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: excludeDeleted
+ in: query
+ description: 'excludeDeleted '
+ required: false
+ type: boolean
+ allowEmptyValue: false
+ - name: resourceId
+ in: query
+ description: 'resourceId '
+ required: true
+ type: string
+ allowEmptyValue: false
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Download Metadata for All Attachments by Opportunity ID
+
+
+/v1/api/resources:
+ get:
+ tags:
+ - attachments
+ summary: Download all attachments from an opportunity
+ description: Download attachments for an opportunity.
+ operationId: downloadAttachmentsByOpportunityUsingGET
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: excludeDeleted
+ in: query
+ description: 'excludeDeleted '
+ required: false
+ type: boolean
+ allowEmptyValue: false
+ - name: opportunityId
+ in: query
+ description: opportunityId
+ required: true
+ type: string
+ allowEmptyValue: false
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Get Related Opportunities
+
+
+ /v1/api/opportunities/{opportunityId}/relatedopportunities/{type}:
+ get:
+ tags:
+ - Opportunity
+ summary: Get related contract opportunities
+ operationId: getRelatedOpportunitiesGET
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ - name: page
+ in: query
+ description: page
+ required: false
+ type: integer
+ default: 0
+ format: int32
+ allowEmptyValue: false
+ - name: size
+ in: query
+ description: size
+ required: false
+ type: integer
+ default: 10
+ format: int32
+ allowEmptyValue: false
+ - name: sortBy
+ in: query
+ description: sortBy
+ required: false
+ type: string
+ default: '-modifiedOn'
+ allowEmptyValue: false
+ - name: type
+ in: path
+ description: type
+ required: true
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Check Unique Solicitation Number
+
+
+ /v1/api/isSolicitationNumberUnique/{parent}/{solicitationNumber}/{type}:
+ get:
+ tags:
+ - Opportunity
+ 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.'
+ operationId: getOpportunityHistoryUsingGET_1
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: parent
+ in: query
+ description: parent
+ required: false
+ type: string
+ allowEmptyValue: false
+ - name: solicitationNumber
+ in: path
+ description: solicitationNumber
+ required: true
+ type: string
+ - name: type
+ in: path
+ description: type
+ required: true
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ deprecated: false
+
Add Authorized Party
+
+
+/v1/api/opportunities/access/{opportunityId}/accessRequest
+post:
+ consumes:
+ - application/json
+ deprecated: false
+ description: "Add Authorized Party to the Opportunity"
+ operationId: createAndApproveRequestUsingPOST
+ parameters:
+ -
+ description: Authorization
+ in: header
+ name: Authorization
+ required: true
+ type: string
+ -
+ description: api_key
+ in: query
+ name: api_key
+ required: true
+ type: string
+ -
+ description: opportunityId
+ in: path
+ name: opportunityId
+ required: true
+ type: string
+ -
+ description: requestJson
+ in: body
+ name: requestJson
+ required: false
+ schema:
+ type: string
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: OK
+ schema:
+ type: object
+ "201":
+ description: Created
+ "400":
+ description: "Bad Request"
+ schema:
+ type: string
+ "401":
+ description: Unauthorized
+ schema:
+ type: string
+ "403":
+ description: Forbidden
+ schema:
+ type: string
+ "404":
+ description: "Not Found"
+ "500":
+ description: "Internal Server Error"
+ schema:
+ type: string
+ "501":
+ description: "Not Implemented"
+ schema:
+ type: string
+ summary: "Add Authorized Party to the Opportunity"
+ tags:
+ - attachments
+
Get Authorized Party
+
+
+/v1/api/opportunities/access/{opportunityId}/accessRequest:
+ get:
+ tags:
+ - attachments
+ summary: Get Request Access List for the opportunity
+ description: Get Request Access List for the opportunity.
+ operationId: getRequestAccessList
+ produces:
+ - application/json
+ parameters:
+ - name: Authorization
+ in: header
+ description: Authorization
+ required: true
+ type: string
+ - name: api_key
+ in: query
+ description: api_key
+ required: true
+ type: string
+ - name: opportunityId
+ in: path
+ description: opportunityId
+ required: true
+ type: string
+ responses:
+ '200':
+ description: OK
+ schema:
+ type: object
+ '400':
+ description: Bad Request
+ schema:
+ type: string
+ '401':
+ description: Unauthorized
+ schema:
+ type: string
+ '403':
+ description: Forbidden
+ schema:
+ type: string
+ '404':
+ description: Not Found
+ '500':
+ description: Internal Server Error
+ schema:
+ type: string
+ '501':
+ description: Not Implemented
+ schema:
+ type: string
+ security:
+ - Token-based Access: []
+ deprecated: false
+
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
@@ -3876,9 +5865,8 @@ Date | Version | Description
10/10/2019 | v0.8 | Updated the Set-Aside values with the latest codes
10/25/2019 | v0.9 | Updated the field lengths
10/31/2019| v0.91| Delete Vendor removed
Delete Resource in Draft API added
API Specifications Updated: Delete Notice, Getlist, Download Metadata for Attachment by Resource ID, and Download Metadata for Attachment by Opportunity ID
JSON Updated: Create and Update, Create and Publish, Revise Opportunity, Cancel Notice, Uncancel Notice, Archive, Unarchive, Create Attachment, Update Attachment, IVL Settings, and Delete Notice
Error Message Section Updated
-
-
-
+11/04/2019| v0.92 | Updated the field lengths for contact full name and awardee name fields for create Opportunity, Create and Publish Opportunity Contract Jsons. Updated the Error messages for these fields
Added Future Implementation for UEI SAM# Validation and Type of Connection. Task/Delivery Order number is updated to be a non required field for Justification submission
+11/12/2019| v1.0 | Initial Release Finalized
diff --git a/_apidocs/opportunities-api/v1/OpenAPI.zip b/_apidocs/opportunities-api/v1/OpenAPI.zip
new file mode 100644
index 000000000..2dec7ee42
Binary files /dev/null and b/_apidocs/opportunities-api/v1/OpenAPI.zip differ
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 02c986e1f..a72487eb3 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -166,6 +166,7 @@ far13 | FAR 13.5 - Simplified Procedures for One Source
### Award Notice (submitAward)
This method is used to submit an award notice.
+If there are multiple awards with same Solicitation Number and Award Number, any revisions must be done from REST Services or from User Interface
Input parameters:
@@ -197,9 +198,9 @@ awdamt | string | Yes | Award Amount | 64 digits
linenbr | string | No | Line Number | 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
awddate | date | Yes | Award Date | YYYYMMDD
archdate | date | No | Archive Date | YYYYMMDD
-awardee | string | No - Either awardee or awardee_duns is required | Awardee | 255 characters
+awardee | string | No - Either awardee or awardee_duns is required | Awardee | 1000 characters
awardee_duns | string | No - Either awardee or awardee_duns is required | Awardee DUNS | 9 digits with optional plus 4
-contact | string | No | Contact Info | 255 characters
+contact | string | No | Contact Info | 500 characters
desc | string | No | Description | 65535 characters
link | GovURL | No | Government Link |
email | GovEmail | No | Government Email | 255 characters
@@ -320,7 +321,7 @@ solnbr |string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9
ntype | string | No | [Refer Notice Types](#notice-types) |
awdnbr | string | No | Award # |255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
archdate | date | No | Archive Date | YYYYMMDD
-contact | string | No | Contact Info | 255 characters
+contact | string | No | Contact Info | 500 characters
desc | string | Yes | Cancellation Description | 65535 characters
## Contracting Officer/Contracting
Specialist Method Details
@@ -355,7 +356,7 @@ subject | string | Yes| Subject| 256 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | No - either respdate or archdate is required | Response Date | YYYYMMDD
archdate | date | No - either respdate or archdate is required | Archive Date | YYYYMMDD
-contact | string | Yes | Contact Info | 255 characters
+contact | string | Yes | Contact Info | 500 characters
desc |string |Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link has URL & description |
email | GovEmail – complex type | Yes | Government Email |
@@ -426,7 +427,7 @@ solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-
subject | string | Yes | Subject | 256 characters
respdate | date | Yes | Response Date | YYYYMMDD
archdate | date | No | Archive Date | YYYYMMDD
-contact | string |Yes | Contact Info | 255 characters
+contact | string |Yes | Contact Info | 500 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link |
email | GovEmail – complex type | Yes | Government Email |
@@ -498,7 +499,7 @@ solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0
ntype | string | Yes | Notice Type | Valid values: PRESOL, COMBINE, SRCSGT, SSALE, SNOTE, SOL
respdate| date| Yes - for COMBINE, SOL
Either respdate or archdate required for SRCSGT, PRESOL, SNOTE, SSALE |Response Date |YYYYMMDD
archdate | date| No - Either respdate or archdate required for SRCSGT, PRESOL, SNOTE, SSALE| Archive Date| YYYYMMDD
-contact | string | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, SOL | Contact Info | 255 characters
+contact | string | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, SOL | Contact Info | 500 characters
desc | string | Yes - for PRESOL, COMBINE, SRCSGT, SSALE, SOL, SNOTE | Description | 65535 characters
link | GovURL – complex type | No | Government Link |
email | GovEmail – complex type | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, SOL | Government Email |
@@ -573,9 +574,9 @@ awdnbr | String | Yes | Award Number | 255 characters from the set: a-z A-Z 0-9
modnbr | String | No | Mod Number | 32 characters
awdamt | String | No | Award Amount (Not in Use) | 64 digits
awddate | Date | No | Award Date | YYYYMMDD
-donbr | String | Yes | Task/Delivery Order Number | 255 characters from the set: a-z A-Z 0-9 - _ ( )
+donbr | String | No | Task/Delivery Order Number | 255 characters from the set: a-z A-Z 0-9 - _ ( )
archdate | Date | No | Archive Date | YYYYMMDD
-contact | String | Yes | Contact Info | 255 characters
+contact | String | Yes | Contact Info | 500 characters
desc | String | No | Description | 65535 characters
link | GovURL | No | Government Link | 255 characters
links | DocumentLink[] | No | Array Of links |
@@ -643,7 +644,7 @@ subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | No - either respdate or archdate is required | Response Date | YYYYMMDD
archdate | date | No - either respdate or archdate is required | Archive Date | YYYYMMDD
-contact | string | Yes | Contact Info | 255 characters
+contact | string | Yes | Contact Info | 500 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link |
email | GovEmail – complex type | Yes | Government Email |
@@ -717,7 +718,7 @@ offadd | String | No | Office Address (Deprecated). The Contracting office addre
subject | String | Yes | Subject | 256 characters
solnbr | String | No | Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
archdate | Date | Yes | Archive Date | YYYYMMDD
-contact | String | No | Contact Info | 255 characters
+contact | String | No | Contact Info | 500 characters
desc | String | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link |
email | GovEmail – complex type | Yes if contact provided | Government Email |
@@ -783,7 +784,7 @@ offadd| string| No |Office Address (Deprecated). The Contracting office address
subject| string| Yes| Subject |256 characters
solnbr| string |Yes |Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
archdate| date| Yes| Archive Date| YYYYMMDD
-contact| string| Yes| Contact Info| 255 characters
+contact| string| Yes| Contact Info| 500 characters
desc| string |Yes| Description |65535 characters
link |GovURL – complex type| No| Government Link |
email |GovEmail – complex type |Yes| Government Email|
@@ -850,7 +851,7 @@ subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | Yes | Response Date | YYYYMMDD
archdate | date | No | Archive Date | YYYYMMDD
-contact | string |Yes | Contact Info | 255 characters
+contact | string |Yes | Contact Info | 500 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link |
email | GovEmail – complex type | Yes | Government Email |
@@ -923,7 +924,7 @@ ntype |String |No| [Refer Related Notices](#related-notices)
awdnbr| String |Yes |Award Number| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
donbr| String| No |Task/Delivery Order Number |255 characters from the set: a-z A-Z 0-9 - _ ( )
archdate |Date |No |Archive Date| YYYYMMDD
-contact| String| Yes| Contact Info |255 characters; Default value = Primary, Other types are: Secondary, Owner
+contact| String| Yes| Contact Info |500 characters
desc |String |Yes |Description| 65535 characters
link| GovURL| No| Government Link |255 characters
links |DocumentLink[]| No| Array Of links |
@@ -996,16 +997,16 @@ subject| string| Yes| Subject| 256 characters
solnbr| string| Yes, EXCEPT No - Only for SNOTE| Solicitation # |128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
ntype |string |No | [Refer Related Notices](#related-notices)
awdnbr| string| Yes - for AWARD, ITB & JA | Award # |255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-donbr |string |Yes - for JA| Delivery/Task Order Number | 255 characters from the set: a-z A-Z 0-9 - _ ( )
+donbr |string |No| Delivery/Task Order Number | 255 characters from the set: a-z A-Z 0-9 - _ ( )
awdamt |string| Yes - for AWARD |Award Amount| 64 digits
linenbr| string |No| Award Line Item Number |255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
awddate |date| Yes - for AWARD| Award Date |YYYYMMDD
stauth |string |Yes - for JA |J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy| [Refer Stauth Valid Values](#stauth-valid-values)
respdate| date| Yes - for COMBINE, SOL
Either respdate or archdate required for SRCSGT, PRESOL, SSALE |Response Date |YYYYMMDD
archdate | date| No; Either respdate or archdate required for SRCSGT, PRESOL, SSALE, SNOTE| Archive Date| YYYYMMDD
-awardee| string| Yes – for AWARD | Awardee |255 characters
+awardee| string| Yes – for AWARD | Awardee |1000 characters
awardee_duns| string |Yes - for AWARD |Awardee DUNS |9 digits with optional plus 4
-contact| string| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL| Contact Info| 255 characters
+contact| string| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL| Contact Info| 500 characters
desc |string| Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE| Main Description| 65535 characters
link| GovernmentURL| No| Government Link |255 characters
email| GovernmentEmail| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL, SNOTE (Required only for SNOTE if contact is provided)| Government Email |255 characters
@@ -2421,7 +2422,7 @@ Note: This service gets a list of all notices
2. If submitting a notice with a duplicate solnbr, then system throws an error
3. If solnbr is in invalid format, then service throws an error
4. If solnbr & ntype combination is not matched, then service throws an error
| 1. Notice Id is required
2. Notice ID must be unique based on selected notice type.
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Opportunity not found with given solicitation number and ntype
ntype |1. When user tries to convert a notice and the solicitation number/ntype do not match the notice, then the service throws an error
2. If an invalid ntype is provided, then service throws an error
3. If the solicitation is related to ntype that is not allowed, then the system throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
3.The Related Notice's Type is invalid for this Opportunity
awdnbr| 1. This field is required where applicable
2. If value provided does not meet the character limit/restrictions, then service throws an error| 1. Contract Award Number is a required field
2.Contract Award Number max length is 255 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
-donbr |1. This field is required where applicable
2. If value provided does not meet the character limit/restrictions, then service throws an error| 1. Task/Delivery Order Number is required field
2. Task/Delivery Order Number max length is 255 characters and allows only alphanumeric and - _ ( ) characters with no spaces
+donbr | 1. If value provided does not meet the character limit/restrictions, then service throws an error| 1. Task/Delivery Order Number max length is 255 characters and allows only alphanumeric and - _ ( ) characters with no spaces
awdamt| 1. This field is required where applicable
2. If an invalid integer values= is given, then service throws an error
3. If value provided does not meet the character limit/restrictions, then service throws an error |1. Base and All Options Value is a required field
2. Base and All Options Value - Invalid input: Please enter a valid number
3. Base and All Options Value max length is 64 digits
linenbr| 1.If value provided does not meet the character limit/restrictions, then service throws an error |1. The Contract Line Item number max length is 255 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
awddate | 1. This field is required where applicable
2. This field should meet the character limit/restrictions
3. If the Contract Award Date is 15 days prior to the current date and the archive date is not provided then the service throws an error| 1. Contract Award Date is required field
2. DATE field in unexpected format. Expects YYYYMMDD
3. Contract Award Date set would result in inactive date being in the past
stauth| 1. This field is required where applicable
2. This field accepts only valid values listed. If invalid values are provided, then system throws an error| 1. Authority is a required field
2. Invalid Authority Fields, please refer to Contract Opportunities SOAP Web Service Tech Document valid authority fields
-respdate| 1. This field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future. If the given date is in past, then system throws an error
3. If the date provided exceeds 5 years from the current date, then the system throws an error
4. Either respdate or archdate required for SRCSGT, PRESOL, SSALE.If none is provided, then the service throws the error | 1. DATE field in unexpected format. Expects YYYYMMDD
2. Response date provided is in the past
3. Response Date cannot exceed 5 years from current date
4. One of Response date or Archive date is required
-archdate| 1. This field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future
3. Either respdate or archdate required for SRCSGT, PRESOL, SSALE.If none is provided, then the service throws the error | 1. DATE field in unexpected format Expects YYYYMMDD
2. Archive date provided is in the past
3. One of Response date or Archive date is required
-awardee_duns| 1. Must provide a valid DUNS| 1. Unique Entity Identifier (duns) is invalid
-contact | 1. This field is required where applicable |1. Primary Contact is Required
+respdate| 1. This field should meet the character limit/restrictions
2. If the date provided exceeds 5 years from the current date, then the system throws an error
3. Either respdate or archdate required for SRCSGT, PRESOL, SSALE.If none is provided, then the service throws the error | 1. DATE field in unexpected format. Expects YYYYMMDD
2. Response Date cannot exceed 5 years from current date
3. One of Response date or Archive date is required
+archdate| 1. This field should meet the character limit/restrictions
2. This date cannot be in the past
3. Either respdate or archdate required for SRCSGT, PRESOL, SSALE.If none is provided, then the service throws the error | 1. DATE field in unexpected format Expects YYYYMMDD
2. Archive date provided is in the past
3. One of Response date or Archive date is required
+awardee| 1. This field is required where applicable
2. This field should meet the character limit/restrictions| 1. Contractor Awarded Name is a required field
2. Contractor Awarded Name max character length is 1000
+contact | 1. This field is required where applicable
2. This field should meet the character limit/restrictions |1. Primary Contact is Required
2. Primary Contact - Name limit is 500 characters
desc| 1. This field is required where applicable.| 1. Description is required
link| 1. If a link is with same name and url is added to the notice during modification/amendment, then the service throws an error | 1. Link with the display text {} already exists
email |1. This field is required where applicable
2. If an invalid email address is provided, then the service throws an error | 1. Primary Contact - Email is required
2. Primary Contact - Please enter a valid Internet email address. Format: username@host.domain
@@ -4165,7 +4166,7 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | -------
-date| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
+date| 1. Date field should meet the expected format |1. DATE field in unexpected format. Expects YYYYMMDD
officeid| 1. If an invalid officeid is given, then service throws an error
2. If contracting officer does not have access to an office but is trying to make a submission to that office, then the service throws an error
3. Office ID must be associated with user account |1. Invalid officeid provided
2. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
solnbr| 1. This field is required where applicable. If no value is provided, then service throws an error
2. If invalid combination of ntype and solnbr is provided, then system throws an error
|1. Multiple notices found. Please input more details
2. Notice not found
ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
@@ -4193,7 +4194,7 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
+date| 1. Date field should meet the expected format |1. DATE field in unexpected format. Expects YYYYMMDD
solnbr| 1. This field is required where applicable. If no value is provided, then service throws an error
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error | 1. Solicitation Number is required
2. Notice not found
3. Multiple notices found. Please input more details
officeid | Office ID must be associated with user account |NA
ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
@@ -4211,7 +4212,7 @@ solnbr| 1. This field is required where applicable. If no value is provided, th
officeid| Office ID must be associated with user account |NA
ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
awdnbr | NA| NA
-archdate| 1. If this value is available, this field should meet the character limit/restrictions
2. If current date or a past date is provided, then the system throws an error
3. If no archive date is given, then the system throws an error| 1. DATE field in unexpected format. Expects YYYYMMDD
2. New archive date provided is in the past
3. New archive date is required
+archdate| 1. If this value is available, this field should meet the character limit/restrictions
2. If a past date is provided, then the system throws an error
3. If no archive date is given, then the system throws an error| 1. DATE field in unexpected format. Expects YYYYMMDD
2. New archive date provided is in the past
3. New archive date is required
#### cancelNotice
@@ -4221,7 +4222,7 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
+date| 1. Date field should meet the expected format |1. DATE field in unexpected format. Expects YYYYMMDD
officeid| Office ID must be associated with user account |NA
subject| NA| NA
solnbr| 1. This field is required where applicable. If no value is provided, then service throws an error
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error | 1. Solicitation Number is required
2. Notice not found
3. Multiple notices found. Please input more details
@@ -4237,9 +4238,9 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-notice_id | notice_id is required| notice_id from getList is required
+notice_id | 1. notice_id is required| 1. notice_id from getList is required
get_changes| NA| NA
-get_changes_from_date| Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
+get_changes_from_date| 1. Date field should meet the expected format| 1. DATE field in unexpected format. Expects YYYYMMDD
get_file_data |NA |NA
#### getList
@@ -4249,11 +4250,11 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-notice_type | Valid Notice Type must be provided | Notice Type is not recognized. Expects one of the following: PRESOL, COMBINE, MOD, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL
+notice_type | 1. Valid Notice Type must be provided |1. Notice Type is not recognized. Expects one of the following: PRESOL, COMBINE, MOD, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL
solnbr| NA| NA
awdnbr| NA| NA
-posted_from | Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
-posted_to|Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
+posted_from | 1. Date field should meet the expected format| 1. DATE field in unexpected format. Expects YYYYMMDD
+posted_to|1. Date field should meet the expected format |1. DATE field in unexpected format. Expects YYYYMMDD
documents_to_search| NA| NA
#### getFileData
@@ -4400,6 +4401,8 @@ Date | Version | Description
9/25/2019 | v0.6 | Updated required fields for DocumentLink, DocumentFile, ArchiveNotice, UnArchiveNotice, CancelNotice and DeleteNoticeOrDocumentPackage ComplexType definitions
10/10/2019 | v0.7 | Updated the Set-Aside values with the latest codes
10/28/2019 | v0.8| Documentation updates only. No change to Implementation
- Production WSDL link added
- Redundant Character Limit and Required columns removed from Specific Business Rules and Error Messages section
- Notice Types and Related Notices sections added for reference
- Consolidated and summarized list of deprecated methods
- Far13 added to Stauth Valid Values section
- Updated character limits
- Updated required column for submitAward, archiveNotice, submitPresol, submitCombined, submitMod, submitJA, submitSourcesSought, submitSpecialNotice, submitSaleofSurplus, submitITB, submitNotice, submitdocumentsandlinkstonotice
- Remove foja from getnoticedata response
+11/04/2019 | v0.9| Updated the character limits for contact and awardee fields for all the submit methods. Modified "donbr" as a not required field for Justification notice submission
+11/12/2019| v1.0| Initial Release Finalized
diff --git a/_config.yml b/_config.yml
old mode 100755
new mode 100644
diff --git a/_data/api-list.yml b/_data/api-list.yml
index 288b92fdf..abfb04b7b 100644
--- a/_data/api-list.yml
+++ b/_data/api-list.yml
@@ -61,9 +61,6 @@
- title: Go.USA.gov API
description: Go.USA.gov is a URL shortener for government employees. The API can shorten, preview, and show clicks on short URLs.
url: https://go.usa.gov/api
-- title: Government Jobs API (Deprecation planned)
- description: This API returns job openings on USAJobs.gov that are open to the public and located in the United States. This API is planned to be deprecated.
- url: https://search.gov/developer/jobs.html
- title: GSA.gov Content API
description: The GSA.gov content API is an XML feed which supplies the public with a means to extract data out of the GSA.gov website. When the API returns multiple content items, it list them with the newest item(s) first, and oldest last.
url: https://open.gsa.gov/api/gsa-content/
diff --git a/_data/search.yml b/_data/search.yml
index 7f75e5ac5..cbc7a8ca4 100644
--- a/_data/search.yml
+++ b/_data/search.yml
@@ -13138,16 +13138,6 @@
- API
- URL shortener
- Sharing
-- title: Government Jobs API (Deprecation planned)
- body: This API returns job openings on USAJobs.gov that are open to the public and located in the United States. This API is planned to be deprecated.
- url: https://search.gov/developer/jobs.html
- category: APIs
- tags:
- - GSA
- - DigitalGovSearch
- - search
- - indexing
- - jobs
- title: GSA.gov Content API
body: The GSA.gov content API is an XML feed which supplies the public with a means to extract data out of the GSA.gov website. When the API returns multiple content items, it list them with the newest item(s) first, and oldest last.
url: https://www.gsa.gov/about-us/gsa-content-api
diff --git a/_navigation.json b/_navigation.json
old mode 100755
new mode 100644
diff --git a/data.json b/data.json
index e86b4bad5..247b2f433 100644
--- a/data.json
+++ b/data.json
@@ -3573,7 +3573,7 @@
"@type": "dcat:Dataset",
"title": "GSA Enterprise Data Inventory (EDI)",
"description": "GSA Enterprise Data Inventory (EDI)",
- "modified": "2019-10-16",
+ "modified": "2019-11-13",
"accessLevel": "public",
"identifier": "GSA-2015-11-13-01",
"dataQuality": true,
@@ -3596,8 +3596,8 @@
"mediaType": "application/json",
"format": "JSON",
"title": "EDI JSON",
- "description": "EDI JSON 10/16/19",
- "downloadURL": "https://inventory.data.gov/dataset/acf8e47e-24d2-4e4d-a786-847643f101fd/resource/32606067-7bfa-4040-b089-f790c2c01473/download/edi-10-16-19.json"
+ "description": "EDI JSON 11/13/19",
+ "downloadURL": "https://inventory.data.gov/dataset/acf8e47e-24d2-4e4d-a786-847643f101fd/resource/32606067-7bfa-4040-b089-f790c2c01473/download/edi-json-11-13-19.json"
}
],
"keyword": ["EDI", "Enterprise Data Inventory", "GSA EDI", "JSON"],
@@ -3903,7 +3903,7 @@
"@type": "dcat:Dataset",
"title": "Inventory of Owned and Leased Properties (IOLP)",
"description": "The Inventory of Owned and Leased Properties (IOLP) allows users to search properties owned and leased by the General Services Administration (GSA) across the United States, Puerto Rico, Guam and American Samoa.\r\n\r\nThe Owned and Leased Data Sets include the following data except where noted below for Leases:\r\n\r\n- Location Code - GSA’s alphanumeric identifier for the building \r\n- Owned or Leased - Indicates the building is Federally Owned (F) or Leased (L) \r\n- GSA Region - GSA assigned region for building location. \r\n- Street Address/City/State/Zip Code - Building Address. \r\n- Latitude and Longitude - Map coordinates of the building. \r\n- Building Rentable Square Feet - Total Rentable Square Feet in building. \r\n- Available Square Feet - Vacant Space in building. \r\n- Construction Date - Date of year built. \r\n- Congressional District - Congressional District building is located. -\r\n Senator/Representative/URL - Senator/Representative of the Congressional District and their web address.\r\n\r\nThe Leased Data set also includes the following: \r\n\r\n- Lease Number - GSA’s alphanumeric identifier for the lease. \r\n- Lease Effective Date - Date lease starts. \r\n- Lease Expiration Date - Date lease expires.",
- "modified": "2019-10-16",
+ "modified": "2019-11-13",
"accessLevel": "public",
"identifier": "GSA-4495",
"dataQuality": true,
@@ -5604,6 +5604,41 @@
"programCode": ["023:019"],
"language": ["en-US"],
"theme": ["Telecommunications Services"]
+ }, {
+ "@type": "dcat:Dataset",
+ "title": "Networx Business Volume FY2019, 4th Qtr",
+ "description": "The dataset represents the Networx Universal and Enterprise business volume of each government agency that has ordered telecommunications services from the Networx Contact, by Fiscal Year, Contract, Contract Vehicle, Agency and Month for the Central and Direct billing accounts.",
+ "modified": "2019-11-13",
+ "accessLevel": "public",
+ "identifier": "GSA-2019-11-13-06",
+ "dataQuality": true,
+ "issued": "2015-11-13",
+ "license": "https://creativecommons.org/publicdomain/zero/1.0/",
+ "publisher": {
+ "@type": "org:Organization",
+ "name": "General Services Administration"
+ },
+ "accrualPeriodicity": "R/P3M",
+ "isPartOf": "GSA-2015-08-27P",
+ "contactPoint": {
+ "@type": "vcard:Contact",
+ "fn": "Toni L Holloway",
+ "hasEmail": "mailto:toni.holloway@gsa.gov"
+ },
+ "distribution": [{
+ "@type": "dcat:Distribution",
+ "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+ "format": "xlsx",
+ "title": "TotRevFY19_4thQtr",
+ "description": "4th Quarter Total Revenue FY19",
+ "downloadURL": "https://inventory.data.gov/dataset/7e3391d0-fe71-4fa6-b427-4151c8fd4be6/resource/71a794d4-c577-4259-a54c-ab58b2798f41/download/totrevfy194thqtr.xlsx"
+ }
+ ],
+ "keyword": ["Contract", "Networx Telecommunications", "Telecommunications"],
+ "bureauCode": ["023:00"],
+ "programCode": ["023:019"],
+ "language": ["en-US"],
+ "theme": ["Telecommunications Services"]
}, {
"@type": "dcat:Dataset",
"title": "New Construction and Repair and Alteration (R&A) Projects",
@@ -8080,6 +8115,186 @@
"programCode": ["023:010"],
"language": ["en-us"],
"theme": ["Card Services Program"]
+ }, {
+ "@type": "dcat:Dataset",
+ "title": "Purchase Card Transactions - CBCA July-Sept 2019, 4th Qtr",
+ "description": "The GSA SmartPay® purchase card program provides cards to federal employees to make official government purchases. These are transactions made by the GSA Board of Contract Appeals.",
+ "modified": "2019-11-13",
+ "accessLevel": "public",
+ "identifier": "GSA-2019-11-13-01",
+ "dataQuality": true,
+ "issued": "2014-10-01",
+ "license": "https://creativecommons.org/publicdomain/zero/1.0/",
+ "rights": "N/A",
+ "publisher": {
+ "@type": "org:Organization",
+ "name": "General Services Administration"
+ },
+ "accrualPeriodicity": "R/P3M",
+ "isPartOf": "GSA-2016-01-06-1",
+ "contactPoint": {
+ "@type": "vcard:Contact",
+ "fn": "James G Parks",
+ "hasEmail": "mailto:greg.parks@gsa.gov"
+ },
+ "distribution": [{
+ "@type": "dcat:Distribution",
+ "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+ "format": "xlsx",
+ "title": "2019-4th Qtr (July-Sept)_CBCA PC Transactions US Bank",
+ "description": "4th Quarter CBCA PC Transactions US Bank July-Sept 2019",
+ "downloadURL": "https://inventory.data.gov/dataset/a3152c25-6be2-4acd-a676-7cca57d7b518/resource/79ca678d-c345-4653-b3e6-78b0e85d215d/download/2019-4th-qtr-july-septcbca-pc-transactions-us-bank.xlsx"
+ }
+ ],
+ "keyword": ["August", "BOCA", "Contract Board", "GSA SmartPay", "July", "Purchase Card", "September", "Transactions"],
+ "bureauCode": ["023:00"],
+ "programCode": ["023:010"],
+ "language": ["en-us"],
+ "theme": ["Card Services Program"]
+ }, {
+ "@type": "dcat:Dataset",
+ "title": "Purchase Card Transactions - CBCA Apr-Jun 2019, 3rd Qtr",
+ "description": "The GSA SmartPay® purchase card program provides cards to federal employees to make official government purchases. These are transactions made by the GSA Board of Contract Appeals.",
+ "modified": "2019-11-13",
+ "accessLevel": "public",
+ "identifier": "GSA-2019-11-13-02",
+ "dataQuality": true,
+ "issued": "2014-10-01",
+ "license": "https://creativecommons.org/publicdomain/zero/1.0/",
+ "rights": "N/A",
+ "publisher": {
+ "@type": "org:Organization",
+ "name": "General Services Administration"
+ },
+ "accrualPeriodicity": "R/P3M",
+ "isPartOf": "GSA-2016-01-06-1",
+ "contactPoint": {
+ "@type": "vcard:Contact",
+ "fn": "James G Parks",
+ "hasEmail": "mailto:greg.parks@gsa.gov"
+ },
+ "distribution": [{
+ "@type": "dcat:Distribution",
+ "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+ "format": "xlsx",
+ "title": "2019-3rd Qtr (Apr-Jun) CBCA PC transactions",
+ "description": "3rd Quarter CBCA PC transactions Apr-Jun 2019",
+ "downloadURL": "https://inventory.data.gov/dataset/c1cb14ea-5e8c-44f4-b403-5e9a3cdfc5b1/resource/0fdc3072-1793-4a00-82ce-a897a660daaf/download/2019-3rd-qtr-apr-jun-cbca-pc-transactionsus-bank.xlsx"
+ }
+ ],
+ "keyword": ["April", "BOCA", "Contract Board", "GSA SmartPay", "June", "May", "Purchase Card", "Transactions"],
+ "bureauCode": ["023:00"],
+ "programCode": ["023:010"],
+ "language": ["en-us"],
+ "theme": ["Card Services Program"]
+ }, {
+ "@type": "dcat:Dataset",
+ "title": "Purchase Card Transactions - CBCA Jan-Mar 2019, 2nd Qtr",
+ "description": "The GSA SmartPay® purchase card program provides cards to federal employees to make official government purchases. These are transactions made by the GSA Board of Contract Appeals.",
+ "modified": "2019-11-13",
+ "accessLevel": "public",
+ "identifier": "GSA-2019-11-13-03",
+ "dataQuality": true,
+ "issued": "2014-10-01",
+ "license": "https://creativecommons.org/publicdomain/zero/1.0/",
+ "rights": "N/A",
+ "publisher": {
+ "@type": "org:Organization",
+ "name": "General Services Administration"
+ },
+ "accrualPeriodicity": "R/P3M",
+ "isPartOf": "GSA-2016-01-06-1",
+ "contactPoint": {
+ "@type": "vcard:Contact",
+ "fn": "James G Parks",
+ "hasEmail": "mailto:greg.parks@gsa.gov"
+ },
+ "distribution": [{
+ "@type": "dcat:Distribution",
+ "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+ "format": "xlsx",
+ "title": "2019-2nd Qtr (Jan-Mar) CBCA PC transactions",
+ "description": "2nd Quarter CBCA PC transactions January-March 2019",
+ "downloadURL": "https://inventory.data.gov/dataset/da897366-ddba-4da6-b8b7-039d440ed55a/resource/2cf101b4-f8a6-4636-b642-10b16196abd9/download/2019-2nd-qtr-jan-mar-cbca-pc-transactionsus-bank.xlsx"
+ }
+ ],
+ "keyword": ["BOCA", "Contract Board", "February", "GSA SmartPay", "January", "March", "Purchase Card", "Transactions"],
+ "bureauCode": ["023:00"],
+ "programCode": ["023:010"],
+ "language": ["en-us"],
+ "theme": ["Card Services Program"]
+ }, {
+ "@type": "dcat:Dataset",
+ "title": "Purchase Card Transactions - CBCA Oct-Dec 2019, 1st Qtr Citibank",
+ "description": "The GSA SmartPay® purchase card program provides cards to federal employees to make official government purchases. These are transactions made by the GSA Board of Contract Appeals.",
+ "modified": "2019-11-13",
+ "accessLevel": "public",
+ "identifier": "GSA-2019-11-13-04",
+ "dataQuality": true,
+ "issued": "2014-10-01",
+ "license": "https://creativecommons.org/publicdomain/zero/1.0/",
+ "rights": "N/A",
+ "publisher": {
+ "@type": "org:Organization",
+ "name": "General Services Administration"
+ },
+ "accrualPeriodicity": "R/P3M",
+ "isPartOf": "GSA-2016-01-06-1",
+ "contactPoint": {
+ "@type": "vcard:Contact",
+ "fn": "James G Parks",
+ "hasEmail": "mailto:greg.parks@gsa.gov"
+ },
+ "distribution": [{
+ "@type": "dcat:Distribution",
+ "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+ "format": "xlsx",
+ "title": "2019-1st Qtr (Oct-Dec) CBCA PC transactions_Citibank",
+ "description": "1st Quarter CBCA PC transactions Citibank",
+ "downloadURL": "https://inventory.data.gov/dataset/678e1717-0dda-495f-b995-7c1a6b015744/resource/a7b8c8dc-e10d-45ba-a193-1e13e1f9cc0f/download/2019-1st-qtr-oct-dec-cbca-pc-transactionsctibank.xlsx"
+ }
+ ],
+ "keyword": ["BOCA", "Contract Board", "December", "GSA SmartPay", "November", "October", "Purchase Card", "Transactions"],
+ "bureauCode": ["023:00"],
+ "programCode": ["023:010"],
+ "language": ["en-us"],
+ "theme": ["Card Services Program"]
+ }, {
+ "@type": "dcat:Dataset",
+ "title": "Purchase Card Transactions - CBCA Oct-Dec 2019, 1st Qtr US Bank",
+ "description": "The GSA SmartPay® purchase card program provides cards to federal employees to make official government purchases. These are transactions made by the GSA Board of Contract Appeals.",
+ "modified": "2019-11-13",
+ "accessLevel": "public",
+ "identifier": "GSA-2019-11-13-05",
+ "dataQuality": true,
+ "issued": "2014-10-01",
+ "license": "https://creativecommons.org/publicdomain/zero/1.0/",
+ "rights": "N/A",
+ "publisher": {
+ "@type": "org:Organization",
+ "name": "General Services Administration"
+ },
+ "accrualPeriodicity": "R/P3M",
+ "isPartOf": "GSA-2016-01-06-1",
+ "contactPoint": {
+ "@type": "vcard:Contact",
+ "fn": "James G Parks",
+ "hasEmail": "mailto:greg.parks@gsa.gov"
+ },
+ "distribution": [{
+ "@type": "dcat:Distribution",
+ "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+ "format": "xlsx",
+ "title": "2019-1st Qtr (Oct-Dec) CBCA PC transactions_US Bank",
+ "description": "1st Quarter CBCA PC transactions October-December \r\n2019 US Bank",
+ "downloadURL": "https://inventory.data.gov/dataset/d30e84dd-45e5-4020-8b70-007dfa57d7df/resource/0ddff4d4-d41d-4e76-97ba-361816ec08f0/download/2019-1st-qtr-oct-dec-cbca-pc-transactionsus-bank.xlsx"
+ }
+ ],
+ "keyword": ["BOCA", "Contract Board", "December", "GSA SmartPay", "November", "October", "Purchase Card", "Transactions"],
+ "bureauCode": ["023:00"],
+ "programCode": ["023:010"],
+ "language": ["en-us"],
+ "theme": ["Card Services Program"]
}, {
"@type": "dcat:Dataset",
"title": "Purchase Card Transactions - OIG Apr-June 2014, 3rd Qtr",
@@ -8218,7 +8433,7 @@
"@type": "dcat:Dataset",
"title": "Real Estate Across the United States (REXUS) Inventory (Building)",
"description": "Real Estate Across the United States (REXUS) is the primary tool used by PBS to track and manage the government's real property assets and to store inventory data, building data, customer data, and lease information. STAR manages aspects of real property space management, including identification of all building space and daily management of 22,000 assignments for all property to its client Federal agencies. This data set contains PBS building inventory that consists of both owned and leased buildings with active and excess status.",
- "modified": "2019-10-16",
+ "modified": "2019-11-13",
"accessLevel": "public",
"identifier": "GSA-25251",
"dataQuality": true,
@@ -8241,7 +8456,7 @@
"mediaType": "text/csv",
"format": "csv",
"title": "data_gov_bldg_rexus",
- "description": "October - Rexus Building file",
+ "description": "November - Rexus Building file",
"downloadURL": "https://inventory.data.gov/dataset/04247624-1d6b-4e03-84eb-9eda1a6ea638/resource/e8972de5-310c-49e2-be42-c1089eee98fd/download/datagovbldgrexus.csv"
}
],
@@ -8252,7 +8467,7 @@
"@type": "dcat:Dataset",
"title": "Real Estate Across the United States (REXUS) (Lease)",
"description": "Real Estate Across the United States (REXUS) is the primary tool used by PBS to track and manage the government's real property assets and to store inventory data, building data, customer data, and lease information. STAR manages aspects of real property space management, including identification of all building space and daily management of 22,000 assignments for all property to its client Federal agencies. This data set contains PBS building inventory that consists of both owned and leased buildings with active and excess status.",
- "modified": "2019-10-16",
+ "modified": "2019-11-13",
"accessLevel": "public",
"identifier": "GSA-25261",
"dataQuality": true,
@@ -8275,7 +8490,7 @@
"mediaType": "text/csv",
"format": "csv",
"title": "data_gov_lse_rexus",
- "description": "October - Rexus Lease file",
+ "description": "November - Rexus Lease file",
"downloadURL": "https://inventory.data.gov/dataset/2cdc97b5-3029-4ec3-b3bf-baec7948bad1/resource/dc2e6239-5c72-465d-a23e-43ee976a0910/download/datagovlserexus.csv"
}
],
diff --git a/robots.txt b/robots.txt
old mode 100755
new mode 100644
diff --git a/sitemap.xml b/sitemap.xml
old mode 100755
new mode 100644