From f2f20da9e629e2f5e3623d66bbe49f5e0cc32e5f Mon Sep 17 00:00:00 2001
From: kcho01 <49658475+kcho01@users.noreply.github.com>
Date: Wed, 2 Oct 2019 09:54:25 -0400
Subject: [PATCH 001/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 742c8897d..90aa025ff 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -2939,7 +2939,7 @@ reason | string | | Yes | Reason for revision
Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
-Reason | string | | Yes | Reason for cancelation
+reason | string | | Yes | Reason for cancelation
requestType | string | cancel_request | Yes | Type of request
description | string | | Yes | Description for cancelation
From 14e65b59caf74e26baf2dc2dbb255604c41da093 Mon Sep 17 00:00:00 2001
From: kcho01 <49658475+kcho01@users.noreply.github.com>
Date: Thu, 3 Oct 2019 12:24:39 -0400
Subject: [PATCH 002/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index cf997e5a4..6f71ff6c6 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -13,7 +13,7 @@ The Opportunity Management SOAP APIs will allow authorized users to submit and r
## Web Services
Description Language (WSDL)
To view the WSDL for all available methods and object definitions, refer below links:
-* Alpha WSDL Link: https://api-alpha.sam.gov/prodlike/ws/services.wsdl
Download
+* Alpha WSDL Link: https://api-alpha.sam.gov/prodlike/ws/services.wsdl or https://api-alpha.sam.gov/prodlike/ws/fbo.wsdl
* Beta WSDL Link: Coming Soon
## SOAP Web Services Workflow Chart
From dfa4f8bd0f997dabb4977f34ee79246312346274 Mon Sep 17 00:00:00 2001
From: kcho01 <49658475+kcho01@users.noreply.github.com>
Date: Thu, 3 Oct 2019 14:51:29 -0400
Subject: [PATCH 003/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 90aa025ff..ec8310810 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -1094,7 +1094,7 @@ _NA_
------- | -------
**Request Type** | POST
-**URL** | /opps/v1/opportunities/{opportunityId}/requests
+**URL** | /opps/v1/api/{opportunityId}/requests
**Summary** | Deletes all the versions or latest version of a notice
**Consumes** | application/json
**Produces** | JSON
@@ -2395,7 +2395,7 @@ N/A
------- | -------
**Request Type** | GET
-**URL** | /v1/opportunities/access/{opportunityId}/accessRequest
+**URL** | /opps/v1/api/opportunities/access/{opportunityId}/accessRequest
**Summary** | Summary Get Authorized Party list for the explicit access requests submitted to an Opportunity
**Consumes** | application/json
**Produces** | JSON
@@ -2475,7 +2475,7 @@ Examples
------- | -------
**Request Type** | POST
-**URL** | /v1/opportunities/access/{opportunityId}/accessRequest
+**URL** | /opps/v1/api/opportunities/access/{opportunityId}/accessRequest
**Summary** | Add a Vendor as an Authorized Party for a notice to grant access to all the secured attachments across all the versions . This API will create and approve the request for the vendor.
**Consumes** | application/json
**Produces** | JSON
From e72a178436d2af2b9f1a3fa224f190a4fbee3cad Mon Sep 17 00:00:00 2001
From: kcho01 <49658475+kcho01@users.noreply.github.com>
Date: Thu, 3 Oct 2019 15:35:02 -0400
Subject: [PATCH 004/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index ec8310810..c9feb0645 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -522,7 +522,7 @@ Examples
------- | -------
**Request Type** | POST
-**URL** | /opps/v1/opportunities/createAndPublish
+**URL** | /opps/v1/api/createAndPublish
**Summary** | Creates and publishes contract opportunity; JSON same as Create and Update API
**Consumes** | application/json
**Produces** | JSON
From 3d4d91d66aa1ba7a2ad7f76e7fd9c7ac4349ab3a Mon Sep 17 00:00:00 2001
From: kcho01 <49658475+kcho01@users.noreply.github.com>
Date: Wed, 9 Oct 2019 11:31:18 -0400
Subject: [PATCH 005/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index c9feb0645..7d35d724d 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -1154,7 +1154,6 @@ api_key | query | string | Yes | Valid System Account API Key
archivedFrom | query | date-time | No | Archive From UTC Date and Time
Example: 2018-11-01 00:00:00
archivedTo | query | date-time | No | Archive To UTC Date and Time
Example: 2018-11-01 00:00:00
awardNumber | query | string | No | Award Number
-cancelled (will be deprecated) | query | boolean | No | True or false
doNumber | query | string | No | Delivery Order Number
includeCount | query | boolean | No | True or false
keyword | query | string | No | Enter any keyword from the description
@@ -1172,7 +1171,7 @@ responseTo | query | date-time | No | ResponseTo UTC Date and Time
Example
size | query | integer | No | Size limit is 10 by default
solNumber | query | string | No | Solicitation Number
sortBy | query | string | No | Sort (-createdOn, -modifiedOn)
-status (To be updated) | query | Array[string] | No | 1.status= active (published, unarchive and uncancelled records)
2.status=inactive (published, archive and uncancelled records)
3.status=draft (draft records)
4.status=published (published and unarchive)
5.status=active_cancelled(published, unarchive and cancelled records)
6.status=inactive_cancelled(published, archive and cancelled records)
7. status=archived(published and archived)
(comma separated)
+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)
{
"attType": "file",
"packageAccessLevel": "private",
- "explicitAccess": "1",
- "content": "SGVsbG8=",
- "fileType": "text/plain"
+ "explicitAccess": "1"
}
+
{
"attType": "file",
- "packageAccessLevel": "private",
- "explicitAccess": "1",
- "content": "SGVsbG8=",
- "fileType": "text/plain"
+ "packageAccessLevel": "public",
+ "explicitAccess": "0"
+}
+
+
+
+{
+ "resourceName": "newFileName.pdf"
+}
+
+
+
+{
+ "sortOrderChanged": true,
+ "resourceIdBelow": "292dc517a19b4e43846f39d20e6f7ecf"
+}
+
+
+
+{
+ "sortOrderChanged": true
+}
+
+
+{
+ "resourceName": "New Display Text"
}
+
{
"attType": "file",
- "packageAccessLevel": "private",
- "explicitAccess": "1"
+ "packageAccessLevel": "",
+ "explicitAccess": ""
+}
+
+
+{
+ "resourceName": ""
}
{
"attType": "file",
"packageAccessLevel": "",
- "explicitAccess": ""
+ "explicitAccess": "",
+ "resourceName": "",
+ "sortOrderChanged":true ,
+ "resourceIdBelow": ""
}
+
+
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 5e278ccb0..3f6edb65a 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -261,7 +261,7 @@ DeleteNoticeOrDocumentPackage Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr | string | Yes; Solicitation # or Award # is required | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | Notice Type | [Refer Notice Types](#Notice Types)
+ntype | string | No | Notice Type | [Refer Notice Types](#notice-types)
awdnbr | string | Yes; Solicitation # or Award # is required| Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
deletetype | string | No | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod | string | No | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
@@ -288,7 +288,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | Notice Type | [Refer Notice Types](#Notice Types)
+ntype | string | No | Notice Type | [Refer Notice Types](#notice-types)
archdate | date | No | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
officeid | string | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
@@ -317,7 +317,7 @@ offadd | string | No | Office Address (Deprecated). The Contracting office addre
officeid | String | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
subject | string | No | Subject | 256 characters
solnbr |string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype | string | No | Notice Type | [Refer Notice Types](#Notice Types)
+ntype | string | No | Notice Type | [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 | Yes | Contact Info | 255 characters
@@ -1066,7 +1066,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
Date| Date| No |Posting Date |YYYYMMDD
solnbr |String |No| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype |String |No| Notice Type | [Refer Notice Types](#Notice Types)
+ntype |String |No| Notice Type | [Refer Notice Types](#notice-types)
uploadtype| String| No | Upload Type| A for amendment, S for solicitation or any title for other; 255 characters
respdate |Date |No |Response Date| YYYYMMDD
links| DocumentLin k[]| Yes; Either Links or Files needs to be provided| Array Of links |
@@ -1109,7 +1109,7 @@ UnarchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | Notice Type | [Refer Notice Types](#Notice Types)
+ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
awdnbr |string| No| Award #| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
archdate |date| Yes| New Archive Date| YYYYMMDD
@@ -1174,7 +1174,7 @@ IVLListRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | Notice Type | [Refer Notice Types](#Notice Types)
+ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
IVLListResponse Complex Type Definition:
@@ -1219,7 +1219,7 @@ AuthorizedPartyListRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes |Solicitation #. Provide an empty string for this argument if using nonfbo_solnbr below | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype| string| No| Notice Type | [Refer Notice Types](#Notice Types)
+ntype| string| No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method |
status| string |No |Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned
+
-
+
+
+
OnogR8sd0+Mn*F|PrFrXN16zkQ#F!u8xH#WS)Y~*iU@=3Vd3q^@tkMg2c=iTBv
zBc`Xn0GjybB4lVu Ji3@x1HQL-w46!sMmoyukdjkg~M2RB?;MhrJ;cC_m8EEi`xT|
z17rhI*hz~B#_@uK03v(=YcKo?Io)+_?0QTkO}?+#i5+Dadf}CiFu#y-Lh=^5kH>OQ
znz$duKC6{zgRYC^e|@*;RPgrcw%eSk(ayVAcftC~*y6<}bl8)SWEQ>g{cUmDC1Pyc
ztHMqLzBEo=t#K#MiXv| ajSrDh24P&0
{
From 2e4381820141db6b803a089eb9c44a5a7266b69e Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
streetAddress | string | | | No | No | Awardee Street Address 1
-award.awardee.location.
streetAddress2 | string | | | No | No | Awardee Street Address 1
+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 | string | | | No | No | Awardee City
award.awardee.location.
city.code | string | | | No | No | Awardee City code
award.awardee.location.
city.name | string | | | No | No | Awardee City name
From 5ea05b752206ee1b3418780e1676a63bd26d5fc9 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
streetAddress2 | string | | | No | No | Awardee Stre
award.awardee.location.
city | string | | | No | No | Awardee City
award.awardee.location.
city.code | string | | | No | No | Awardee City code
award.awardee.location.
city.name | string | | | No | No | Awardee City name
-award.awardee.location.
state | JSON | | NA | NA | NA |
+award.awardee.location.
state | JSON | NA | NA | NA | NA |
award.awardee.location.
state.code | string | | | No | No | Awardee State code
award.awardee.location.
state.name | string | | | No | No | Awardee State name
award.awardee.location.
country | JSON | | NA | NA | NA |
award.awardee.location.
country.code | string | | | No | No | Awardee Country code
award.awardee.location.
country.name | string | | | No | No | Awardee Country Name
award.awardee.location.
zip | string | | | No | No | Awardee Country Zip
-justificationAuthority | JSON | |NA | NA | NA |
+justificationAuthority | JSON |NA |NA | NA | NA |
justificationAuthority.
modificationNumber | string | 32 characters| | No | No | Justification Authority Modification Number
justificationAuthority.
authority | | string | | No | No | Justification Authority
-link | JSON | NA | NA | NA |
+link | JSON | NA |NA | NA | NA |
link.href | string | | | No | No | Url for the notice on SAM.gov
-link.additionalInfo | JSON | NA | NA | NA |
+link.additionalInfo | JSON | NA |NA | NA | NA |
link.additionalInfo.content | string | | | No | No | Additional info
-additionalReporting | string | none/
auto_recovery | No | Yes |
-description | JSON | | NA | NA | NA |
+additionalReporting | string | |none/
auto_recovery | No | Yes |
+description | JSON | NA | NA | NA | NA |
description.body | string | 65535 characters| | No | Yes | Description of notice
-resources | JSON | | NA | NA | NA |
-resources.attType | string | link, file | No |No| Type of attachment, either link or file
+resources | JSON |NA | NA | NA | NA |
+resources.attType | string | |link, file | No |No| Type of attachment, either link or file
resources.content | byte |250MB | | No|No | File content in base64 format
-resources.link | string | | |No|No | Resource link URL
+resources.link | string | 255 characters | |No|No | Resource link URL
resources.packageAccessLevel | string | | public,private(default public) | No | No| Type of access to file or link
resources.resourceName | string | 255 characters | | No|No | Name of file
postedDate| date| | |No|No| Posted Date
From 8f0df753433c183f3667ccd4b7ce167cc06df2e7 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
country.name | string | | | No | No | Awardee Countr
award.awardee.location.
zip | string | | | No | No | Awardee Country Zip
justificationAuthority | JSON |NA |NA | NA | NA |
justificationAuthority.
modificationNumber | string | 32 characters| | No | No | Justification Authority Modification Number
-justificationAuthority.
authority | | string | | No | No | Justification Authority
+justificationAuthority.
authority | string| | | No | No | Justification Authority
link | JSON | NA |NA | NA | NA |
link.href | string | | | No | No | Url for the notice on SAM.gov
link.additionalInfo | JSON | NA |NA | NA | NA |
From caaa062185869470fffd9309f169c74fa122ea4f Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Fri, 25 Oct 2019 14:45:48 -0400
Subject: [PATCH 042/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 172 +++++++++++++++++------------
1 file changed, 103 insertions(+), 69 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index e86a408e2..829eedaba 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -134,6 +134,34 @@ far5 | FAR 6.302-5 - Authorized or required by statute
far6 | FAR 6.302-6 - National security
far7 | FAR 6.302-7 - Public interest
+### Related Notices
+
+This section indicates the list of notices that can be used in the SOAP services
+
+PRESOL - Presolicitation
+COMBINE - Combined Synopsis/Solicitation
+SRCSGT - for Sources Sought
+SSALE - Sale of Surplus Property
+SNOTE - Special Notice
+JA – Justification
+ITB – Intent to Bundle
+SOL - Solicitation
+AWARD - Award
+
+This is a conversion table for notices using SOAP services
+
+||SRCSGT | PRESOL | COMBINE | SOL| AWARD | SSALE | ITB | JA | SNOTE
+-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|
+|**SRCSGT**||O|O|O|O|O|||O
+|**PRESOL**|O||O|O||O|O|O|O|O|O
+|**COMBINE**|O|O|||O||O|O|O
+|**SOL**|O|O|||O||O|O|O
+|**AWARD**|||O|O|||O|O|O
+|**SSALE**|O|O|||||O|O|O
+|**ITB**||O|O|O|O|O||O|O
+|**JA**||O|O|O|O|O|O||O
+|**SNOTE**|O|O|O|O|O|O|O|O|
+
## Contracting Officer
Method Details
### Award Notice (submitAward)
@@ -892,7 +920,7 @@ officeid| String| Yes| Office id of the office where an opportunity is being sub
offadd| String |No| Office Address| 65535 characters
subject| String| Yes| Subject |255 characters
solnbr |String |Yes| Sol # |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype |string |No| Base Notice Type| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation
+ntype |string |No| Base Notice Type| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation, "AWARD" - for Award
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
@@ -4074,16 +4102,16 @@ Note:
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date | No (Yes for Award) | YYYYMMDD |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | 1. DATE field in unexpected format. Expects YYYYMMDD
+date | No; Yes for Award) | YYYYMMDD |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | 1. DATE field in unexpected format. Expects YYYYMMDD
notice_type |Yes| Valid Options mentioned General Notice (submitNotice) section | 1. This required field should be validated | 1. Opportunity type is required
zip| No| 5 digits| NA |NA
classcod |No| Valid classification code (FAR, Section 5.207(g)) |1. This required field should be validated where applicable
2.If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
naics |No (Yes for Combined Synopsis/Solicitation & Solicitation)| Valid NAICS Code NAICS Reference |NA | NA
-offadd| No| 65535 characters| NA| NA
-officeid |No |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
+offadd| No| 65535 characters| Not-Used| NA
+officeid |Yes |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes – for all; NA – for submitDocumentAndLinks |255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| (No for Special Notice)| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. If this field is not given, then system throws an errors as shown on the right hand side
2. If duplicate solicitation number is given, then system throws an error
3. For an invalid solnbr and notice_type combination, the service throws an error| 1.Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Opportunity not found with given solicitation number and ntype
-ntype| no| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error |NTYPE value provided is not valid
+solnbr| Yes (No for Special Notice)| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. If this field is not given, then system throws an errors as shown on the right hand side
2. If duplicate solicitation number is given, then system throws an error
3. For an invalid solnbr and notice_type combination, the service throws an error| 1.Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Opportunity not found with given solicitation number and ntype
+ntype| no| [Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error |NTYPE value provided is not valid
awdnbr| Yes – For Award, ITB & JA; No – For rest| 255 characters| 1. This required field should be validated| 1. Award Details Section - Contract Award Number is a required field
donbr| Yes – For JA; No – For rest |255 characters |1. This is required field for JA |1. Award Details Section - Task/Delivery Order Number is required field
awdamt |Yes – For Award; No – For rest| 64 characters| 1. This required field should be validated |1. Award Details Section – Amount is a required field.
@@ -4118,14 +4146,14 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD |1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
zip |No |5 digits| NA| NA
-classcod| Yes – For submitpresol
No - SourcesSought | Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
+classcod| No | Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
naics |No| Valid NAICS Code NAICS Reference| NA| NA
offadd| No |65535 characters |NA| NA
officeid |Yes |20 characters | 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes |255 characters| 1. This required field should be validated| 1. $.data.title: is missing but it is required
-solnbr |No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-respdate| No for Presol and Sources Sought; Yes - for Presol IF 15 days after response is selected| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future
3. When giving future date, response date cannot exceed 5 years from the current date |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
-archdate |No |YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Inactive date provided is in the past.
+solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+respdate| No; Either Respdate or Archdate must be selected | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future
3. When giving future date, response date cannot exceed 5 years from the current date |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
+archdate |No; Either Respdate or Archdate must be selected |YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Inactive date provided is in the past.
contact| Yes| 65535 characters
Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated| 1. Primary Contact is required
desc |Yes | 65535 characters| 1. This required field should be validated |1. Description is required
link| No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA |NA
@@ -4152,7 +4180,7 @@ naics |Yes |Valid NAICS Code NAICS Reference| 1. This required field should be
officeid |Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
offadd| No| 65535 characters| NA| NA
subject |Yes| 255 characters| 1. This required field should be validated| 1. $.data.title: is missing but it is required
-solnbr |No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
respdate| Yes |YYYYMMDD |1. This required field should be validated
2. This field should meet the character limit/restrictions
3. This date cannot be in past; has to be in future
4. When giving future date, response date cannot exceed 5 years from the current date.| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
4. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact| Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated| 1. Primary Contact is Required
@@ -4181,13 +4209,13 @@ naics |No |Valid NAICS Code NAICS Reference| NA| NA
officeid| Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
offadd| No| 65535 characters| NA| NA
subject |Yes| 255 characters| 1. This required field should be validated| 1. $.data.title: is missing but it is required
-solnbr |No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
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| no| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation |1. When user tries to convert a notice to ITB and the solicitation number and ntype do not match the notice, then the service throws an error
2. This field accepts only valid values mentioned. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
+solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
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| no| [Refer Related Notices](#related-notices) |1. When user tries to convert a notice to ITB and the solicitation number and ntype do not match the notice, then the service throws an error
2. This field accepts only valid values mentioned. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
awdnbr| Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {} |1. This required field should be validated
2. This field accepts only valid characters as mentioned under character limit/restrictions column | 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
donbr| No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) | NA| NA
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
-contact| No |65535 characters
65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated | 1. Primary Contact is Required
-desc| No| 65535 characters| 1. This required field should be validated |1. Description is required
+contact| Yes |65535 characters
65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated | 1. Primary Contact is Required
+desc| Yes | 65535 characters| 1. This required field should be validated |1. Description is required
link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396) |NA |NA
link |No | | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
files| No | | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
@@ -4203,16 +4231,16 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| No| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
+date| No; Yes - for Award| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
zip| No| 5 digits| NA| NA
-classcod |Yes – For Combined/Sale of Surplus/ITB/Justification
No – For rest |Valid classification code (FAR, Section 5.207(g)) |1. This field is required and should be validated
2. If a wrong classification code is given, then service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
+classcod |Yes – For Solicitation/Combined/Sale of Surplus/ITB/Justification
No – For rest |Valid classification code (FAR, Section 5.207(g)) |1. This field is required and should be validated
2. If a wrong classification code is given, then service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
naics |Yes – For Combined/Solicitation
No – For rest| Valid NAICS Code NAICS Reference |1. For combined, this field is required and should be validated| 1. NAICS code is required
officeid| Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If contracting officer does not have access to an office but is trying to make modifications to an opportunity associated to that office, then the service throws an error
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
offadd| No |65535 characters| NA| NA
subject |Yes| 255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1a. This required field if not given, service will throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Notice not found for correction
-ntype| No|Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-respdate |Yes – for Combined/Solicitation; No – For rest (Required for Sources Sought/Presol/Sale of Surplus/Special Notice when Required when 15 Days after Response is selected) |YYYYMMDD |1. This required field is validated for combined type
2. No validation is performed on this field for rest of the types. However, if this value is available, this field should meet the character limit/restriction
3. This date cannot be in past; has to be in future| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
+solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1a. This required field if not given, service will throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Notice not found for correction
+ntype| Yes |[Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+respdate |Yes – for Combined/Solicitation; No – For rest|YYYYMMDD |1. This required field is validated for combined type
2. No validation is performed on this field for rest of the types. However, if this value is available, this field should meet the character limit/restriction
3. This date cannot be in past; has to be in future| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact| No – For Award/Special notice
Yes – For rest |65535 characters Default value: Primary
Other types: Secondary, Owner |1. This required field should be validated| 1. Primary Contact is Required
desc |Yes - for Award/Justification; No - For Rest| 65535 characters| 1. This required field should be validated |1. Description is required
@@ -4249,8 +4277,8 @@ naics| No – this may change in future |Valid NAICS Code NAICS Reference| NA|
offadd| No| 65535 characters| NA| NA
officeid| Yes| 20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue
subject |Yes| 255 characters |1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field if not given will throw an error
2. Duplicate solicitation number cannot be submitted
(Refer error #2) 3. If a space is given along with numbers in this field, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error. |1. Notice Id is required
2. Notice ID for the selected opportunity type already exits
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 |No |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation|1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
+solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field if not given will throw an error
2. Duplicate solicitation number cannot be submitted
(Refer error #2) 3. If a space is given along with numbers in this field, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error. |1. Notice Id is required
2. Notice ID for the selected opportunity type already exits
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 |No |[Refer Related Notices](#related-notices)|1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
stauth |Yes| Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Value section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’| 1. This required field should be validated
Note: Both foja & stauth values will be given under stauth in legacy |1. This opportunity cannot be published. Authority is required
awdnbr |Yes| 255 characters| 1. This required field should be validated |1. Award Details Section - Contract Award Number is a required field
modnbr| No |32 characters| NA| NA
@@ -4274,15 +4302,15 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| No |YYYYMMDD| 1. If this field is given, then this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
+date| Yes |YYYYMMDD| 1. If this field is given, then this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
zip |No| 5 digits| NA| NA
classcod| No| Valid classification code (FAR, Section 5.207(g))| 1. If a wrong classification code is given, then the service throws an error | 1. This opportunity cannot be published. Classification Code provided did not match expected codes
naics | No| Valid NAICS Code NAICS Reference| NA| NA
offadd| No |65535 characters| NA| NA
officeid |Yes |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes| 255 characters| 1. This required field should be validated |$.data.title: is missing but it is required
-solnbr |No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Opportunity not found with given solicitation number and ntype
-ntype| No| Valid values: "COMBINE" - for Combined Synopsis/Solicitation, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
+solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Opportunity not found with given solicitation number and ntype
+ntype| No| [Refer Related Notices](#related-notices)| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
awdnbr| Yes| Valid numbers| 1. This required field should be validated
2. If an invalid number is given (e.g with special characters), then service throws an error| 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
awdamt| Yes| Valid integer values| 1. This required field should be validated
2. If an invalid integer values is given, then service throws an error |1. Award Details Section - Amount is a required field
2. Award Details Section - Please enter valid integer for Amount Field
linenbr |No| 255 characters| NA| NA
@@ -4309,14 +4337,14 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| No| YYYYMMDD| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
+date| No | YYYYMMDD| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
officeid| No |20 characters| 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. Officeid 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| Yes |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-ntype |No |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
-uploadtype| No – May change in future Upload type accepts 2 types – link or file| A for amendment, S for solicitation or any title for other; 255 characters| NA| NA
-respdate|Yes – for Combined/Solicitation; No – For rest (Required for Sources Sought/Presol/Sale of Surplus/Special Notice when Required when 15 Days after Response is selected)| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
-links| No| Array of files| 1.This field is not required but if url & description fields within the links and files are empty, then the service throws an error.
2. If a link with same name already exists on the notice, then the system throws an error.
3. If the Url is empty for a link, then the system throws an error.
4. If the description is missing for a link, then the system throws an error.| 1. Links and/or files are not complete
2. Resource with the same name already exists
3. Link Resource must have a link
4. Link Resource must have a description
-files |No| Array of files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error
2. If the filename is not provided for a file, then the system throws an error
3. If the filedata is empty for a file, then the system throws an error
4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error
5. If the file size exceeds 250MB, then the system throws an error
6. If a file with same name already exists on the notice, then the system throwns an error |1. Links and/or files are not complete
2. Attachment must have a name
3. Attachment must have content
4. The file type that you are trying to upload is not supported
5. The file type that you are trying to upload is not supported
6. Resource with the same name already exists
+solnbr| No |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+ntype | No |[Refer Related Notices](#related-notices)| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
+uploadtype| No – link or file| A for amendment, S for solicitation or any title for other; 255 characters| NA| NA
+respdate| No | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
+links| Yes; Either Links or Files needs to be provided | Array of files| 1.This field is not required but if url & description fields within the links and files are empty, then the service throws an error.
2. If a link with same name already exists on the notice, then the system throws an error.
3. If the Url is empty for a link, then the system throws an error.
4. If the description is missing for a link, then the system throws an error.| 1. Links and/or files are not complete
2. Resource with the same name already exists
3. Link Resource must have a link
4. Link Resource must have a description
+files | Yes; Either Links or Files needs to be provided | Array of files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error
2. If the filename is not provided for a file, then the system throws an error
3. If the filedata is empty for a file, then the system throws an error
4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error
5. If the file size exceeds 250MB, then the system throws an error
6. If a file with same name already exists on the notice, then the system throwns an error |1. Links and/or files are not complete
2. Attachment must have a name
3. Attachment must have content
4. The file type that you are trying to upload is not supported
5. The file type that you are trying to upload is not supported
6. Resource with the same name already exists
#### submitFairOpps
@@ -4340,7 +4368,7 @@ naics| No| Valid NAICS Code NAICS Reference| NA| NA
offadd| No| 65535 characters| NA |NA
officeid| Yes |20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes| 255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| No |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}. Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+solnbr| Yes |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}. Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
archdate |No |YYYYMMDD |1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact| No| 65535 characters Default value: Primary
Other types: Secondary, Owner| NA| NA
desc| Yes |65535 characters| 1. This required field should be validated| 1. Description is required
@@ -4363,7 +4391,7 @@ naics |Yes |Valid NAICS Code NAICS Reference| 1. This required field should be
officeid |Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Invalid officeid provided
2. Insufficient privileges to create opportunity.
offadd| No| 65535 characters| NA| NA
subject |Yes| 255 characters| 1. This required field should be validated| 1. Title is a required field.
-solnbr |No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice ID is a required field
2. Notice ID must be unique based on selected notice type
3. Notice ID max length is 128 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
+solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice ID is a required field
2. Notice ID must be unique based on selected notice type
3. Notice ID max length is 128 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
respdate| Yes |YYYYMMDD |1. This required field should be validated
2. This field should meet the character limit/restrictions
3. This date cannot be in past; has to be in future
4. When giving future date, response date cannot exceed 5 years from the current date.| 1. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. Response Date cannot be in the past
4. Response Date cannot exceed 5 years from current date
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. Inactive date provided is in the past
desc| Yes | 65535 characters| 1. This required field should be validated| 1. Description is a required field
@@ -4391,7 +4419,7 @@ naics |No |Valid NAICS Code NAICS Reference| NA| NA
offadd| No| 65535 characters| NA| NA
officeid| Yes |20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue
subject| Yes |255 characters |1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr |No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact |Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated |1. Primary Contact is Required
desc| Yes| 65535 characters |1. This required field should be validated |1. Description is required
@@ -4407,9 +4435,9 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-awdnbr| Yes - for Award/ITP/JA; No - for Rest| 255 characters| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required
-ntype|No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+solnbr| Yes; Solicitation Number or Award Number is required| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+awdnbr| Yes; Solicitation Number or Award Number is required| 255 characters| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required
+ntype|No| [Refer Related Notices](#related-notices)| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
deletetype| no| Valid values: “notice” to delete the notice, “attachment” to delete attachments and links from the notice| 1. If an invalid deletetype is provided, then service throws an error | Delete type provided is not “notice” or “attachment”
deletemethod| no| Valid Values: “all” to delete all versions or “latest” to delete latest version |1. If an invalid deletemethod is provided, then service throws an error | Delete method provided is not “latest” or “all”
@@ -4423,8 +4451,8 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
date| No| YYYYMMDD| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
officeid |No| 20 characters| Officeid must be associated with user account |NA
-ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If an invalid ntype is provided, then service throws an error
2. If a valid ntype but a wrong ntype is not provided for the solnbrthen service throws an error | 1. NTYPE value provided is not valid 2. Notice not found for correction
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
+ntype| No| [Refer Related Notices](#related-notices)| 1. If an invalid ntype is provided, then service throws an error
2. If a valid ntype but a wrong ntype is not provided for the solnbrthen service throws an error | 1. NTYPE value provided is not valid 2. Notice not found for correction
+archdate| Yes | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
#### unarchiveNotice
@@ -4436,7 +4464,7 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
------ | ------- | ------- | ------- | --------
solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
officeid| No |20 characters| Officeid must be associated with user account |NA
-ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+ntype| No|[Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
awdnbr |Yes - for Award/ITB/Justification; No - for Rest| 255 characters| NA| NA
archdate| Yes| YYYYMMDD| 1. This required field should be validated
2. If this value is available, this field should meet the character limit/restrictions
3. 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. $.reason: null found, string expected. Unable to process request. Please try again
@@ -4451,12 +4479,12 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
date| No| YYYYMMDD |Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
officeid| No |20 characters| Officeid must be associated with user account |NA
subject| No| 255 characters| NA| NA
-solnbr| No |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If valid solnbr is given with a different ntype, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple Notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-ntype |No |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
+solnbr| Yes |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If valid solnbr is given with a different ntype, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple Notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+ntype |No |[Refer Related Notices](#related-notices)| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
awdnbr| Yes - for Award/ITB/Justification; No - for Rest| 255 characters| NA| NA
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be cancelled
-contact|No – For Award/Special Notice; Yes – For Rest| 65535 characters Default value: Primary
Other types: Secondary, Owner| NA| NA
-desc| No - For Award/Justification; Yes - For Rest| 65535 characters| 1. This required field should be validated | 1. Unable to process request. Please try again
+contact|Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| NA| NA
+desc| Yes| 65535 characters| 1. This required field should be validated | 1. Unable to process request. Please try again
#### getNoticeData
@@ -4464,10 +4492,10 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-notice_id |No – For Special Notice; Yes – For Rest| Unique ID found from getList call or ID’s for changes found in getNoticeData call| Notice_id is required| notice_id from getList is required
-Get_changes| No |True or False
Pass in true to get the full notice history with all changes| NA| NA
-get_changes_from_date| No| If maintaining a sync of changes, can specify a date so that only changes that have occurred since provided date will be returned| Date field should meet the expected format.| DATE field in unexpected format. Expects YYYYMMDD
-get_file_data |No |True or False
Pass in true and the method will return any file content stored in Contract Opportunities (attachment data will be retuned as Base64Encoding Format). If false, the meta details/links will still be provided |NA |NA
+notice_id |No (at least 1 field is required)| Unique ID found from getList call or ID’s for changes found in getNoticeData call| Notice_id is required| notice_id from getList is required
+Get_changes| No (at least 1 field is required) |True or False
Pass in true to get the full notice history with all changes| NA| NA
+get_changes_from_date| No (at least 1 field is required)| If maintaining a sync of changes, can specify a date so that only changes that have occurred since provided date will be returned| Date field should meet the expected format.| DATE field in unexpected format. Expects YYYYMMDD
+get_file_data |No (at least 1 field is required) |True or False
Pass in true and the method will return any file content stored in Contract Opportunities (attachment data will be retuned as Base64Encoding Format). If false, the meta details/links will still be provided |NA |NA
#### getList
@@ -4476,12 +4504,12 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-notice_type |No| Solicitation type
Valid Values: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL
Note: Searches for AWARDS, JA and ITB will return both standalone notices AND base notices that contain one of these type |Notice_type if given should be valid | Notice Type is not recognized
Expects one of the following: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB
-solnbr| No| Solicitation #| NA| NA
-awdnbr| Yes for Award/ITB/Justification; No for Rest| Award #| NA| NA
-posted_from |No |Posted From Date. YYYYMMDD| Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
-posted_to| No |Posted To Date. YYYYMMDD |Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
-documents_to_search| No |Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided| NA| NA
+notice_type |No (at least 1 field is required) | Solicitation type
Valid Values: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL
Note: Searches for AWARDS, JA and ITB will return both standalone notices AND base notices that contain one of these type |Notice_type if given should be valid | Notice Type is not recognized
Expects one of the following: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB
+solnbr| No (at least 1 field is required)| Solicitation #| NA| NA
+awdnbr| No (at least 1 field is required)| Award #| NA| NA
+posted_from |No (at least 1 field is required)|Posted From Date. YYYYMMDD| Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
+posted_to| No (at least 1 field is required) |Posted To Date. YYYYMMDD |Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
+documents_to_search| No (at least 1 field is required) |Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided| NA| NA
#### getFileData
@@ -4498,8 +4526,8 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| No| Solicitation Number| 1. If an incorrect solicitation number and ntype combination is given, the service throws an error
2a. If this required field if not given, service throws an error
2b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination |1. Notice not found
2a. Notice not found
2b. Multiple Notices found. Please input more details
-ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | NA |NA
+solnbr| Yes | Solicitation Number| 1. If an incorrect solicitation number and ntype combination is given, the service throws an error
2a. If this required field if not given, service throws an error
2b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination |1. Notice not found
2a. Notice not found
2b. Multiple Notices found. Please input more details
+ntype| No| [Refer Related Notices](#related-notices) | NA |NA
#### getAuthorizedPartyList
@@ -4507,19 +4535,21 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
+ntype| No| [Refer Related Notices](#related-notices)| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
status| No| Valid Options: approved, pending, rejected, “empty value”
If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests |1. If the status value entered doesn’t match the valid values , then the system throws an error| 1. Status value is invalid
#### approveExplicitAccessRequestByID
-Individual business rules per field are listed across each of the fields in below table.
+Individual business rules per field are listed across each of the fields in below table.
+
+ID can be obtained through getAuthorizedPartyList
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr |No | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error |1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype |No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+solnbr |Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error |1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
+ntype |No| [Refer Related Notices](#related-notices) |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
id| Yes| | 1. If the request Id is not provided, then the system throws an error
2. If the request Id provided is already approved, then the service throws an error
3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error
4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error |1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information
2. Request with Request ID: #id already approved
3. You have request that is tied to different solicitation number
4. You have request that is tied to the same solicitation number but different notice type
@@ -4527,10 +4557,13 @@ id| Yes| | 1. If the request Id is not provided, then the system throws an error
Individual business rules per field are listed across each of the fields in below table.
+Vendor can be obtained through getAuthorizedPartyList
+
+
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr |No | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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.
-ntype |No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
+solnbr |Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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.
+ntype |No| [Refer Related Notices](#related-notices) |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
vendor |Yes| Vendor Data |1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error.
2. If no match is found in the system for the vendor data provided, then the system throws an error.
3. If the Explicit Access request found for the vendor and solnum is already approved, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown.
2. No contact match on vendor data provided.
3. Request with Request ID: #id already approved.
@@ -4540,8 +4573,8 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| No | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }|1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }|1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
+ntype| No| [Refer Related Notices](#related-notices) |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr |No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
vendor| Yes| Vendor Data| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
@@ -4551,8 +4584,8 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| No | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error| 1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error| 1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
+ntype| No| [Refer Related Notices](#related-notices) | 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
id| Yes || 1. If the request Id is not provided, then the system throws an error
2. If the request Id provided is already rejected, then the service throws an error
3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error
4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error| 1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information
2. Request with Request ID: #id already rejected
3. You have request that is tied to different solicitation number
4. You have request that is tied to the same solicitation number but different notice type
reason| Yes| Rejection Reason| 1. This is a required field. If no value is provided, then the system throws an error.| 1. A reason must be provided with an explicit access rejection.
@@ -4563,7 +4596,7 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
solnbr |No | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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.
-ntype |No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
+ntype |No| [Refer Related Notices](#related-notices) |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
vendor| Yes| Vendor Data| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
reason| Yes| Rejection Reason| 1. This is a required field. If no value is provided, then the system throws an error.| 1. A reason must be provided with an explicit access rejection.
@@ -4653,3 +4686,4 @@ Date | Version | Description
10/10/2019 | v0.7 | Updated the Set-Aside values with the latest codes
+
From aa322639a937a2f90ce664c9a01e96de41b4985e Mon Sep 17 00:00:00 2001
From: Prashant Pillai
Note: Date field allows current date and also any date in past/future | 1. DATE field in unexpected format. Expects YYYYMMDD
+date | Yes - Only Award
No - Rest | YYYYMMDD |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | - Award Details Section - Contract Award Date is required field
- Award Details Section - Contract Award Date provided should have 4 digit year
- Award Details Section - Contract Award Date provided is in an invalid format
notice_type |Yes| Valid Options mentioned General Notice (submitNotice) section | 1. This required field should be validated | 1. Opportunity type is required
zip| No| 5 digits| NA |NA
-classcod |No| Valid classification code (FAR, Section 5.207(g)) |1. This required field should be validated where applicable
2.If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
-naics |No (Yes for Combined Synopsis/Solicitation & Solicitation)| Valid NAICS Code NAICS Reference |NA | NA
+classcod |No| Valid classification code (FAR, Section 5.207(g)) |1. This required field should be validated where applicable
2.If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
+naics |Yes - Combined Synopsis/Solicitation & Solicitation
No - Rest| Valid NAICS Code NAICS Reference |NA | - NAICS code is required
offadd| No| 65535 characters| Not-Used| NA
officeid |Yes |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-subject |Yes – for all; NA – for submitDocumentAndLinks |255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| Yes (No for Special Notice)| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. If this field is not given, then system throws an errors as shown on the right hand side
2. If duplicate solicitation number is given, then system throws an error
3. For an invalid solnbr and notice_type combination, the service throws an error| 1.Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Opportunity not found with given solicitation number and ntype
+subject |Yes |255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
+solnbr| Yes - Rest
No - Only Special Notice| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. If this field is not given, then system throws an errors as shown on the right hand side
2. If duplicate solicitation number is given, then system throws an error
3. For an invalid solnbr and notice_type combination, the service throws an error| 1.Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Opportunity not found with given solicitation number and ntype
ntype| no| [Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error |NTYPE value provided is not valid
-awdnbr| Yes – For Award, ITB & JA; No – For rest| 255 characters| 1. This required field should be validated| 1. Award Details Section - Contract Award Number is a required field
-donbr| Yes – For JA; No – For rest |255 characters |1. This is required field for JA |1. Award Details Section - Task/Delivery Order Number is required field
-awdamt |Yes – For Award; No – For rest| 64 characters| 1. This required field should be validated |1. Award Details Section – Amount is a required field.
-linenbr| No| 255 characters| NA |NA
-awddate |Yes – For award; No – for rest |YYYYMMDD| 1. This field should meet the character limit/restrictions (Note: Date field allows current date and also any date in past/future)
2. This required field should be validated| 1. DATE field in unexpected format. Expects YYYYMMDD
2. Award Details Section - Contract Award Date is required field.
-stauth| Yes – For JA
No – for rest | Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Values section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’ | Both foja & stauth values will be given under stauth in legacy | NA
-respdate|Yes – for Combined/Solicitation; No – For rest (Required for Sources Sought/Presol/Sale of Surplus/Special Notice when Required when 15 Days after Response is selected)| YYYYMMDD | 1. No validation is performed on this field for all services except submitCombined. However, if this value is available, 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 2 errors (#2)
3. For submitCombined this field is required | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Inactive date provided is in the past
4. Response Date is required
-archdate| No| YYYYMMDD |1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restriction
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
-awardee |Yes – for award
No – for Rest| 6553 characters| NA| NA
+awdnbr| Yes – Award, ITB & JA
No – Rest| 255 characters| 1. This required field should be validated| 1. Award Details Section - Contract Award Number is a required field
+donbr| Yes – JA
No – Rest |255 characters |1. This is required field for JA |1. Award Details Section - Task/Delivery Order Number is required field
+awdamt |Yes – Award
No – Rest| 64 characters| 1. This required field should be validated |1. Award Details Section – Amount is a required field.
+linenbr|No | 255 characters| NA |NA
+awddate |Yes – Award
No – Rest |YYYYMMDD| 1. This field should meet the character limit/restrictions (Note: Date field allows current date and also any date in past/future)
2. This required field should be validated| 1. DATE field in unexpected format. Expects YYYYMMDD
2. Award Details Section - Contract Award Date is required field.
+stauth| Yes – JA
No – Rest | Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Values section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’ | Both foja & stauth values will be given under stauth in legacy | NA
+respdate|Yes – Only Combined/Solicitation
No – Rest (Required for Sources Sought/Presol/Sale of Surplus/Special Notice when Required when 15 Days after Response is selected)| YYYYMMDD | 1. No validation is performed on this field for all services except submitCombined. However, if this value is available, 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 2 errors (#2)
3. For submitCombined this field is required | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Inactive date provided is in the past
4. Response Date is required
+**archdate** (updated needed)| No| YYYYMMDD |1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restriction
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
+awardee |Yes – Only Award
No – Rest| 6553 characters| NA| NA
awardee_duns| No |9 digits with optional plus 4| NA| NA
-contact |No - for Award & Special Notice; Yes - for Rest |65535 characters Default value = Primary Other types are: Secondary, Owner| 1. This required field should be validated |1. Primary Contact is Required
-desc| No – Justfication & Award ; Yes - for Rest |65535 characters| 1. This required field should be validated.| 1. Description is required
-link| No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA | NA
-email| Yes
No if type=Award| 128 characters| NA |NA
+contact | Yes - Rest
No - Award & Special Notice; |65535 characters Default value = Primary Other types are: Secondary, Owner| 1. This required field should be validated |1. Primary Contact is Required
+desc| Yes - Rest
No – Justfication & Award |65535 characters| 1. This required field should be validated.| 1. Description is required
+link|No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA | NA
+email| Yes - Rest
No - Only Award| 128 characters| NA |NA
links |No |Array of links |NA |NA
files| No| Array of files| NA| NA
setaside| No| See Set-Aside Values section for valid codes| NA |NA
@@ -4146,15 +4146,15 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD |1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
zip |No |5 digits| NA| NA
-classcod| No | Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
+classcod| No | Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
naics |No| Valid NAICS Code NAICS Reference| NA| NA
offadd| No |65535 characters |NA| NA
officeid |Yes |20 characters | 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes |255 characters| 1. This required field should be validated| 1. $.data.title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-respdate| No; Either Respdate or Archdate must be selected | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future
3. When giving future date, response date cannot exceed 5 years from the current date |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
-archdate |No; Either Respdate or Archdate must be selected |YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Inactive date provided is in the past.
-contact| Yes| 65535 characters
Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated| 1. Primary Contact is required
+respdate| No - However either Respdate or Archdate must be selected | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future
3. When giving future date, response date cannot exceed 5 years from the current date |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
+**archdate** (updated needed) |No - However either Respdate or Archdate must be selected |YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Inactive date provided is in the past.
+contact|Yes| 65535 characters
Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated| 1. Primary Contact is required
desc |Yes | 65535 characters| 1. This required field should be validated |1. Description is required
link| No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA |NA
email | Yes | 128 characters| | NA
@@ -4182,7 +4182,7 @@ offadd| No| 65535 characters| NA| NA
subject |Yes| 255 characters| 1. This required field should be validated| 1. $.data.title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
respdate| Yes |YYYYMMDD |1. This required field should be validated
2. This field should meet the character limit/restrictions
3. This date cannot be in past; has to be in future
4. When giving future date, response date cannot exceed 5 years from the current date.| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
4. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
+**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact| Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated| 1. Primary Contact is Required
desc| Yes | 65535 characters| 1. This required field should be validated| 1. Description is required
link |No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
@@ -4213,7 +4213,7 @@ solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This requi
ntype| no| [Refer Related Notices](#related-notices) |1. When user tries to convert a notice to ITB and the solicitation number and ntype do not match the notice, then the service throws an error
2. This field accepts only valid values mentioned. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
awdnbr| Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {} |1. This required field should be validated
2. This field accepts only valid characters as mentioned under character limit/restrictions column | 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
donbr| No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) | NA| NA
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
+**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact| Yes |65535 characters
65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated | 1. Primary Contact is Required
desc| Yes | 65535 characters| 1. This required field should be validated |1. Description is required
link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396) |NA |NA
@@ -4231,23 +4231,23 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| No; Yes - for Award| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
+date| Yes - Only Award
No - Rest| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
zip| No| 5 digits| NA| NA
-classcod |Yes – For Solicitation/Combined/Sale of Surplus/ITB/Justification
No – For rest |Valid classification code (FAR, Section 5.207(g)) |1. This field is required and should be validated
2. If a wrong classification code is given, then service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics |Yes – For Combined/Solicitation
No – For rest| Valid NAICS Code NAICS Reference |1. For combined, this field is required and should be validated| 1. NAICS code is required
+classcod |Yes – Solicitation/Combined/Sale of Surplus/ITB/Justification
No – Rest |Valid classification code (FAR, Section 5.207(g)) |1. This field is required and should be validated
2. If a wrong classification code is given, then service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
+naics |Yes – Combined & Solicitation
No – Rest| Valid NAICS Code NAICS Reference |1. For combined, this field is required and should be validated| 1. NAICS code is required
officeid| Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If contracting officer does not have access to an office but is trying to make modifications to an opportunity associated to that office, then the service throws an error
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
offadd| No |65535 characters| NA| NA
subject |Yes| 255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1a. This required field if not given, service will throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Notice not found for correction
ntype| Yes |[Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-respdate |Yes – for Combined/Solicitation; No – For rest|YYYYMMDD |1. This required field is validated for combined type
2. No validation is performed on this field for rest of the types. However, if this value is available, this field should meet the character limit/restriction
3. This date cannot be in past; has to be in future| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
-contact| No – For Award/Special notice
Yes – For rest |65535 characters Default value: Primary
Other types: Secondary, Owner |1. This required field should be validated| 1. Primary Contact is Required
-desc |Yes - for Award/Justification; No - For Rest| 65535 characters| 1. This required field should be validated |1. Description is required
+respdate |Yes – for Combined/Solicitation
No – Rest (Special Notice/Sale of Surplus/Sources Sought/Presol must have either respdate or archdate)|YYYYMMDD |1. This required field is validated for combined type
2. No validation is performed on this field for rest of the types. However, if this value is available, this field should meet the character limit/restriction
3. This date cannot be in past; has to be in future| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
+**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
+contact| Yes – Rest
No – For Award/Special notice
|65535 characters Default value: Primary
Other types: Secondary, Owner |1. This required field should be validated| 1. Primary Contact is Required
+desc |Yes - Award/Justification
No - Rest| 65535 characters| 1. This required field should be validated |1. Description is required
link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA |NA
links |No |Collection |1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
files| No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-email |Yes
No if type=Award|128 characters| NA|NA
+email |Yes - Rest
No - Only Award|128 characters| NA|NA
setaside| No| See Set-Aside Values section for valid codes| NA| NA
popaddress| No |65535 characters| NA| NA
popzip |No |5 digit |NA | NA
@@ -4273,7 +4273,7 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
date| No |YYYYMMDD |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
zip |No |5 digits| NA| NA
classcod| Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics| No – this may change in future |Valid NAICS Code NAICS Reference| NA| NA
+naics| No |Valid NAICS Code NAICS Reference| NA| NA
offadd| No| 65535 characters| NA| NA
officeid| Yes| 20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue
subject |Yes| 255 characters |1. This required field should be validated |1. $.data.title: is missing but it is required
@@ -4284,13 +4284,13 @@ awdnbr |Yes| 255 characters| 1. This required field should be validated |1. Awar
modnbr| No |32 characters| NA| NA
awddate |No – May change in future| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions| 1. DATE field in unexpected format. Expects YYYYMMDD
awdamt| No| 64 characters| NA| NA
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
+**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
contact| Yes | 65535 characters Default value: Primary
Other types: Secondary, Owner |1. This required field should be validated| 1. Primary Contact is Required
desc| No| 65535 characters| NA |NA
link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
links |No | | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
files |No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-email |Yes
No if type=Award | 128 characters| NA| NA
+email |Yes | 128 characters| NA| NA
recovery_act |No |True or False| NA |NA
correction |No |True or False
If correcting a previously submitted J&A notice, specify true and the system will lookup the j&a by award number and sol number if applicable.| If correction = true, system checks if an opportunity exists or not. If exists, then a new modified record will be posted of the same type and will be set as the latest. If No, then the request will be rejected | NA
donbr |Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( )|1. This field is required
2. In value provided for this field does not meet the character limit/restrictions mentioned, then service throws an error| 1. Award Details Section - Task/Delivery Order Number is required field
2. Award Details Section - Task/Delivery Order Number - Please enter a valid number
@@ -4342,7 +4342,7 @@ officeid| No |20 characters| 1. If an invalid officeid is given, then service th
solnbr| No |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
ntype | No |[Refer Related Notices](#related-notices)| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
uploadtype| No – link or file| A for amendment, S for solicitation or any title for other; 255 characters| NA| NA
-respdate| No | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
+respdate| No (Special Notice/Sale of Surplus/Sources Sought/Presol must have either respdate or archdate) | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
links| Yes; Either Links or Files needs to be provided | Array of files| 1.This field is not required but if url & description fields within the links and files are empty, then the service throws an error.
2. If a link with same name already exists on the notice, then the system throws an error.
3. If the Url is empty for a link, then the system throws an error.
4. If the description is missing for a link, then the system throws an error.| 1. Links and/or files are not complete
2. Resource with the same name already exists
3. Link Resource must have a link
4. Link Resource must have a description
files | Yes; Either Links or Files needs to be provided | Array of files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error
2. If the filename is not provided for a file, then the system throws an error
3. If the filedata is empty for a file, then the system throws an error
4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error
5. If the file size exceeds 250MB, then the system throws an error
6. If a file with same name already exists on the notice, then the system throwns an error |1. Links and/or files are not complete
2. Attachment must have a name
3. Attachment must have content
4. The file type that you are trying to upload is not supported
5. The file type that you are trying to upload is not supported
6. Resource with the same name already exists
@@ -4369,7 +4369,7 @@ offadd| No| 65535 characters| NA |NA
officeid| Yes |20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes| 255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
solnbr| Yes |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}. Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-archdate |No |YYYYMMDD |1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
+**archdate** (updated needed) |No |YYYYMMDD |1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact| No| 65535 characters Default value: Primary
Other types: Secondary, Owner| NA| NA
desc| Yes |65535 characters| 1. This required field should be validated| 1. Description is required
link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396) |NA| NA
@@ -4393,7 +4393,7 @@ offadd| No| 65535 characters| NA| NA
subject |Yes| 255 characters| 1. This required field should be validated| 1. Title is a required field.
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice ID is a required field
2. Notice ID must be unique based on selected notice type
3. Notice ID max length is 128 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
respdate| Yes |YYYYMMDD |1. This required field should be validated
2. This field should meet the character limit/restrictions
3. This date cannot be in past; has to be in future
4. When giving future date, response date cannot exceed 5 years from the current date.| 1. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. Response Date cannot be in the past
4. Response Date cannot exceed 5 years from current date
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. Inactive date provided is in the past
+**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. Inactive date provided is in the past
desc| Yes | 65535 characters| 1. This required field should be validated| 1. Description is a required field
link |No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
email |Yes |128 characters |1. This field is required
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
@@ -4420,7 +4420,7 @@ offadd| No| 65535 characters| NA| NA
officeid| Yes |20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue
subject| Yes |255 characters |1. This required field should be validated |1. $.data.title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
+**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact |Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated |1. Primary Contact is Required
desc| Yes| 65535 characters |1. This required field should be validated |1. Description is required
link| No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
@@ -4465,7 +4465,7 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
officeid| No |20 characters| Officeid must be associated with user account |NA
ntype| No|[Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-awdnbr |Yes - for Award/ITB/Justification; No - for Rest| 255 characters| NA| NA
+awdnbr |Yes - Award/ITB/Justification; No - Rest| 255 characters| NA| NA
archdate| Yes| YYYYMMDD| 1. This required field should be validated
2. If this value is available, this field should meet the character limit/restrictions
3. 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. $.reason: null found, string expected. Unable to process request. Please try again
#### cancelNotice
@@ -4481,7 +4481,7 @@ officeid| No |20 characters| Officeid must be associated with user account |NA
subject| No| 255 characters| NA| NA
solnbr| Yes |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If valid solnbr is given with a different ntype, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple Notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
ntype |No |[Refer Related Notices](#related-notices)| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
-awdnbr| Yes - for Award/ITB/Justification; No - for Rest| 255 characters| NA| NA
+awdnbr| Yes - Award/ITB/Justification; No - Rest| 255 characters| NA| NA
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be cancelled
contact|Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| NA| NA
desc| Yes| 65535 characters| 1. This required field should be validated | 1. Unable to process request. Please try again
@@ -4504,7 +4504,7 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-notice_type |No (at least 1 field is required) | Solicitation type
Valid Values: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL
Note: Searches for AWARDS, JA and ITB will return both standalone notices AND base notices that contain one of these type |Notice_type if given should be valid | Notice Type is not recognized
Expects one of the following: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB
+notice_type |No (at least 1 field is required) |[Refer Related Notices](#related-notices) | Notice Type is not recognized
Expects one of the following: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB
solnbr| No (at least 1 field is required)| Solicitation #| NA| NA
awdnbr| No (at least 1 field is required)| Award #| NA| NA
posted_from |No (at least 1 field is required)|Posted From Date. YYYYMMDD| Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
From 3ee7b159cad6dc01ffbee9e85888f39ede957d6c Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Fri, 25 Oct 2019 15:39:07 -0400
Subject: [PATCH 046/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index efbdb16a2..b731902c5 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -4468,7 +4468,7 @@ ntype| No|[Refer Related Notices](#related-notices) | 1. If all the required fie
awdnbr |Yes - Award/ITB/Justification; No - Rest| 255 characters| NA| NA
archdate| Yes| YYYYMMDD| 1. This required field should be validated
2. If this value is available, this field should meet the character limit/restrictions
3. 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. $.reason: null found, string expected. Unable to process request. Please try again
-#### cancelNotice
+#### cancelNotice (NEEDS FIX)
Individual business rules per field are listed across each of the fields in below table.
* Note: : If user tries to cancel already cancelled opportunity, service throws an error - This opportunity cannot be cancelled. This opportunity is already cancelled. Unable to process request. Please try again.
@@ -4684,6 +4684,7 @@ Date | Version | Description
8/19/2019 | v0.5 | SUBMITPRESOL/SOURCESSOUGHT, SUBMITCOMBINED, SUBMITAWARD, SUBMITSALEOFSURPLUS, SUBMITJA, SUBMITITB, SUBMITSPECIANOTICE, SUBMITMOD, ARCHIVENOTICE, UNARCHIVENOTICE, CANCELNOTICE, SUBMITDOCUMENTSANDLINKS, GETLIST, GETNOTICEDATA, GETFILEDATA, DELETENOTICE parameters updated
User Account Section Updated
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/25/2019 | v0.71| Updated Business Rules
From f89807f438aa7c639be161c7426b5684d7ad9023 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Fri, 25 Oct 2019 15:41:22 -0400
Subject: [PATCH 047/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index b731902c5..4d90c3610 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -153,7 +153,7 @@ This is a conversion table for notices using SOAP services
||SRCSGT | PRESOL | COMBINE | SOL| AWARD | SSALE | ITB | JA | SNOTE
-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|
|**SRCSGT**||O|O|O|O|O|||O
-|**PRESOL**|O||O|O||O|O|O|O|O|O
+|**PRESOL**|O||O|O||O|O|O|O
|**COMBINE**|O|O|||O||O|O|O
|**SOL**|O|O|||O||O|O|O
|**AWARD**|||O|O|||O|O|O
From 7b459566af2a14d9a8bb3a5dbd21c1bf545a1fce Mon Sep 17 00:00:00 2001
From: Prashant Pillai
Please use ONLY alphanumeric and - _ ( ) { } characters [no spaces]. | Yes | Award Number | 255 characters
awdamt | string | Yes | Award Amount | 64 characters
@@ -262,8 +262,8 @@ DeleteNoticeOrDocumentPackage Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr | string | Yes, if Non-Award | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | no | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
-awdnbr | string | Yes, if Award| Award # | 255 characters
+ntype | string | no | [Refer Related Notices](#related-notices)
+awdnbr | string | Yes; Solicitation Number or Award Number is required| Award # | 255 characters
deletetype | string | no | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod | string | no | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
@@ -288,12 +288,12 @@ ArchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
-archdate | date | No | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
+solnbr | string | No | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
+ntype | string | No | [Refer Related Notices](#related-notices)
+archdate | date | Yes | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
officeid | string | No | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-### Cancel Notice
(CancelNotice)
+### Cancel Notice
(CancelNotice) NEEDS FIX
This method is used to post a cancellation notice to any base notice type already in the Opportunities system. Provide a Solicitation Number or an Award Number (for stand- alone awards) and other data outlined below for the cancellation notice.
@@ -348,14 +348,14 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
zip | string | No | Zip Code | 5 digits
-classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code NAICS Reference
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
offadd | string | No | Office Address | 65535 characters
subject | string | Yes| Title of the Pre-solicitation | 255 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-respdate | date | No | Response Date | YYYYMMDD
-archdate | date | No | Archive Date | YYYYMMDD
+respdate | date | No - However either Respdate or Archdate must be selected | Response Date | YYYYMMDD
+**archdate** (update needed) | date | No - However either Respdate or Archdate must be selected | Archive Date | YYYYMMDD
contact | string | Yes | Contact Info | 65535 characters
desc |string |Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link has URL & description | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -426,7 +426,7 @@ offadd | string | No | Office Address | 65535 characters
subject | string | Yes | Subject | 255 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | Yes | Response Date | YYYYMMDD
-archdate | date | No | Archive Date | YYYYMMDD
+**archdate** (update needed) | date | No | Archive Date | YYYYMMDD
contact | string |Yes | Contact Info | 65535 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -488,21 +488,21 @@ Mod Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | No | Posting Date | YYYYMMDD
+date | date | Yes - Only Award
No - Rest | Posting Date | YYYYMMDD
zip | string | No | Zip Code | 5 digits
-classcod | string | Yes – For combined type, presol type, Sale of surplus, No – For rest | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | Yes – For combined type, No – For rest | NAICS Code | Valid NAICS Code NAICS Reference
+classcod | string | Yes – Solicitation/Combined/Sale of Surplus/ITB/Justification
No – Rest | Class-Code | Valid classification code (FAR, Section 5.207(g))
+naics | string | Yes – Combined & Solicitation
No – Rest | NAICS Code | Valid NAICS Code NAICS Reference
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
offadd | string | no | Office Address | 65535 characters
-subject | string | no | Subject | 255 characters
+subject | string | Yes | Subject | 255 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype | string | Yes | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation
-respdate | date | Yes – Combined, No – For rest | Response Date | YYYYMMDD
-archdate | date | no | Archive Date | YYYYMMDD
-contact | string | No – For Special notice, Yes – For rest | Contact Info | 65535 characters
-desc | string | Yes | Description | 65535 characters
+ntype | string | Yes | Base Notice Type | [Refer Related Notices](#related-notices)
+respdate | date | Yes – for Combined/Solicitation
No – Rest (Special Notice/Sale of Surplus/Sources Sought/Presol must have either respdate or archdate)| Response Date | YYYYMMDD
+**archdate** (update needed) | date | no | Archive Date | YYYYMMDD
+contact | string | Yes – Rest
No – For Award/Special notice| Contact Info | 65535 characters
+desc | string | Yes - Award/Justification
No - Rest | Description | 65535 characters
link | GovURL – complex type | no | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email | GovEmail – complex type | no | Government Email | 128 characters
+email | GovEmail – complex type | Yes - Rest
No - Only Award | Government Email | 128 characters
links | DocumentLink[] | no | Array Of links |
files | DocumentFile[] | no | Array of files |
setaside | string | no | Set-Aside code | See Set Aside Value Section for valid codes
@@ -568,14 +568,14 @@ offadd | String | No | Office Address | 65535 characters
officeid | String | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
subject | String | Yes | Subject | 255 characters
solnbr | String | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}.
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required
-ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation
+ntype | string | No | Base Notice Type | [Refer Related Notices](#related-notices)
stauth | String | Yes | Stat. Authority – Both foja & stauth values will be given under stauth in legacy | Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in section 4.4
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’
awdnbr | String | Yes | Award Number | 255 characters
modnbr | String | No | Mod Number | 32 characters
awdamt | String | No | Award Amount | 64 characters
-awddate | Date | No – May change in future | Award Date | YYYYMMDD
+awddate | Date | No | Award Date | YYYYMMDD
donbr | String | Yes | Task/Delivery Order Number | 255 characters from the set: a-z A-Z 0-9 - _ ( )
-archdate | Date | No | Archive Date | YYYYMMDD
+**archdate** (update needed) | Date | No | Archive Date | YYYYMMDD
contact | String | Yes | Contact Info | 65535 characters
desc | String | No | Description | 65535 characters
link | GovURL | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -643,7 +643,7 @@ offadd | string | No | Office Address | 65535 characters
subject | string | Yes | Subject | 255 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | No | Response Date | YYYYMMDD
-archdate | date | No | Archive Date | YYYYMMDD
+**archdate** (update needed) | date | No | Archive Date | YYYYMMDD
contact | string | Yes | Contact Info | 65535 characters
Default value: Primary
Other types: Secondary, Owner
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -717,7 +717,7 @@ officeid | string | Yes | Office id of the office where an opportunity is being
offadd | String | No | Office Address | 65535 characters
subject | String | Yes | Subject | 255 characters
solnbr | String | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-archdate | Date | No | Archive Date | YYYYMMDD
+**archdate** (update needed) | Date | No | Archive Date | YYYYMMDD
contact | String | No | Contact Info | 65535 characters
desc | String | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -783,7 +783,7 @@ officeid |string |Yes| Office id of the office where an opportunity is being sub
offadd| string| No |Office Address |65535 characters
subject| string| Yes| Subject |255 characters
solnbr| string |Yes |Sol #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-archdate| date| No| Archive Date| YYYYMMDD
+**archdate** (update needed)| date| No| Archive Date| YYYYMMDD
contact| string| Yes| Contact Info| 65535 characters
desc| string |Yes| Description |65535 characters
link |GovURL – complex type| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -850,7 +850,7 @@ offadd | string | No | Office Address | 65535 characters
subject | string | Yes | Subject | 255 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | Yes | Response Date | YYYYMMDD
-archdate | date | No | Archive Date | YYYYMMDD
+**archdate** (update needed) | date | No | Archive Date | YYYYMMDD
contact | string |Yes | Contact Info | 65535 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -920,10 +920,10 @@ officeid| String| Yes| Office id of the office where an opportunity is being sub
offadd| String |No| Office Address| 65535 characters
subject| String| Yes| Subject |255 characters
solnbr |String |Yes| Sol # |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype |string |No| Base Notice Type| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation, "AWARD" - for Award
+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
+**archdate** (update needed) |Date |No |Archive Date| YYYYMMDD
contact| String| Yes| Contact Info |65535 characters; Default value = Primary, Other types are: Secondary, Owner
desc |String |Yes |Description| 65535 characters
link| GovURL| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -994,31 +994,30 @@ Complete notice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date| date| No |Posting Date| YYYYMMDD
+date| date| Yes - Only Award
No - Rest |Posting Date| YYYYMMDD
notice_type |string |Yes| Notice type |Valid options outlined above
zip |string |No |Zip Code| 5 digits
classcod| string| No| Class-Code |Valid classification code (FAR, Section 5.207(g))
-naics |string |No |NAICS Code| Valid NAICS Code NAICS Reference
-officeid| String| No| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account |20 characters
+naics |string |Yes - Combined Synopsis/Solicitation & Solicitation
No - Rest |NAICS Code| Valid NAICS Code NAICS Reference
+officeid| String| Yes| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account |20 characters
offadd |string| No| Office Address |65535 characters
subject| string| Yes – For presol, combined, itb, ja, award, special, surplus
No – for rest| Subject| 255 characters
-solnbr| string| Yes – For presol, combined, itb, ja, award, special, document, surplus
No – for rest| Sol # |128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype |string |no |Base Notice Type |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
-awdnbr| string| Yes – For Award & JA, ITB
No – For rest| Award # |255 characters
-donbr |string |Yes – For JA
No – For rest| Delivery/Task Order Number |255 characters
-awdamt |string| Yes – For Award
No – For rest |Award Amount| 64 characters
+solnbr| string| Yes - Rest
No - Only Special Notice| Sol # |128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
+ntype |string |no |[Refer Related Notices](#related-notices)
+awdnbr| string| Yes – Award, ITB & JA
No – Rest| Award # |255 characters
+donbr |string |Yes – JA
No – Rest| Delivery/Task Order Number |255 characters
+awdamt |string| Yes – Award
No – Rest |Award Amount| 64 characters
linenbr| string |No| Award Line Item Number |255 characters
-awddate |date| Yes – for award; No – for rest| Award Date |YYYYMMDD
-stauth |string |Yes – for JA; No – for test |J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy| Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Value section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’
-modnbr |string |No |J&A and FairOpp Contract Modification Number| 32 digits
-respdate| date| Yes – for combined
No – for rest |Response Date |YYYYMMDD
-archdate| date| No| Archive Date| YYYYMMDD
-awardee| string| Yes - award
No – for rest| Awardee |65535 characters
+awddate |date| Yes – Award
No – Rest| Award Date |YYYYMMDD
+stauth |string |Yes – JA
No – Rest |J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy| Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Value section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’
+respdate| date| Yes – Only Combined/Solicitation
No – Rest (Required for Sources Sought/Presol/Sale of Surplus/Special Notice when Required when 15 Days after Response is selected) |Response Date |YYYYMMDD
+**archdate** (update needed) | date| No| Archive Date| YYYYMMDD
+awardee| string| Yes – Only Award
No – Rest| Awardee |65535 characters
awardee_duns| string |no |Awardee DUNS |9 digits with optional plus 4
-contact| string| Yes – for presol, submitSourcesSought, combined, itb, ja, award, saleofSurplus, Solicitation
No – for rest| Contact Info| 65535 characters
-desc |string| Yes – For presol, submitSourcesSought, combined, ITB, special and saleOfSurplus, Solicitation
No – For rest| Main Description| 65535 characters
+contact| string| Yes - Rest
No - Award & Special Notice| Contact Info| 65535 characters
+desc |string| Yes - Rest
No – Justfication & Award| Main Description| 65535 characters
link| GovernmentURL| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email| GovernmentEmail| Yes / No: Only for Award| Government Email |128 characters
+email| GovernmentEmail| Yes - Rest
No - Only Award| Government Email |128 characters
links |DocumentLink []| no |Array Of links |
files |DocumentFile[]| no| Array of files |
setaside| string| no| Set-Aside code | See Set Aside Section for valid codes
@@ -1078,12 +1077,12 @@ DocumentUpload Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
Date| Date| No |Posting Date |YYYYMMDD
-solnbr |String |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype |String |No| Base Notice Type| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation
-uploadtype| String| No – May change in future| Upload Type| A for amendment, S for solicitation or any title for other; 255 characters
-respdate |Date |No |Response Date| YYYYMMDD
-links| DocumentLin k[]| No| Array Of links |
-files |DocumentFile []| No| Array of files |
+solnbr |String |No| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
+ntype |String |No| [Refer Related Notices](#related-notices)
+uploadtype| String| No | Upload Type| A for amendment, S for solicitation or any title for other; 255 characters
+respdate |Date |No |Response Date| YYYYMMDD
+links| DocumentLin k[]| Yes; Either Links or Files needs to be provided| Array Of links |
+files |DocumentFile []| Yes; Either Links or Files needs to be provided| Array of files |
officeid |String| No| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account| 20 characters
DocumentLink Complex Type Definition:
@@ -1122,7 +1121,7 @@ UnarchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No |Base Notice Type |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
+ntype |string |No |[Refer Related Notices](#related-notices)
awdnbr |string| No| Award #| 255 characters
archdate |date| Yes| New Archive Date| YYYYMMDD
@@ -1187,7 +1186,7 @@ IVLListRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| yes| Solicitation #
-ntype |string |no |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
+ntype |string |no |[Refer Related Notices](#related-notices)
IVLListResponse Complex Type Definition:
@@ -1232,13 +1231,9 @@ AuthorizedPartyListRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| yes |Solicitation #. Provide an empty string for this argument if using nonfbo_solnbr below
-ntype| string| no| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
+ntype| string| no| V[Refer Related Notices](#related-notices)
nonfbo_solbr| string| no| Non-fbo Solicitation #. Not supported for this method
status| string |no |Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests.
-resource_name |string |Yes |Only populates if the type_of_request is a resource.
-type_of_request |string |Yes |Indicates if the id is a resource or a notice level request
-
-
AuthorizedPartyListResponse Complex Type Definition:
@@ -1280,11 +1275,10 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string |yes| Solicitation #
-ntype |string |no| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
+ntype |string |no| [Refer Related Notices](#related-notices)
nonfbo_solbr |string| no| Non-fbo Solicitation #. Not supported for this method
Id| string| yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
-vendor| VendorData| no| Complex type not used in this method
-reason |string| no| rejection reason not used in this method
+
Response:
@@ -1307,11 +1301,9 @@ ExplicitAccessRequestComplex Type Definition:
Element Name |Type |Required| Description
-----|-----|-----|----
solnbr |string |yes| Solicitation #
-ntype| string| no| Valid values: "PRESOL" - for Presolicitation
"COMBINE" - for Combined Synopsis/Solicitation
"SRCSGT" - for Sources Sought
"SSALE" - for Sale of Surplus Property
"SNOTE" - for Special Notice
“ITB” – for Intent to Bundle Requirements (DoD- Funded)
+ntype| string| no| [Refer Related Notices](#related-notices)
nonfbo_solbr| string| no| Non-fbo Solicitation #. Not supported for this method
-Id| string| no| Not used in this method
vendor| VendorData |yes| Complex type defined below
-reason |string| no |Rejection reason not used in this method
Response:
@@ -1346,11 +1338,10 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string |yes| Solicitation #
-ntype |string |no| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
+ntype |string |no|[Refer Related Notices](#related-notices)
nonfbo_solbr |string| no| Non-fbo Solicitation #. Not supported for this method
-Id| string| yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
-vendor| VendorData| no| Complex type not used in this method
-reason |string| no| rejection reason not used in this method
+Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
+reason |string| Yes| rejection reason not used in this method
Response:
@@ -1374,9 +1365,8 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| yes| Solicitation #
-ntype |string |no| Valid values: "PRESOL" - for Presolicitation
"COMBINE" - forCombined Synopsis/Solicitation
"SRCSGT" - for Sources Sought
"SSALE" - for Sale of Surplus Property
"SNOTE" - for Special Notice
“ITB” – for Intent to Bundle Requirements (DoD- Funded)
+ntype |string |no| [Refer Related Notices](#related-notices)
nonfbo_solbr |string |no |Non-fbo Solicitation #. Not supported for this method
-Id |string| no |Not used in this method
vendor |VendorData| yes| Complex type defined below
reason| string| yes |Rejection Reason
@@ -1411,11 +1401,10 @@ ExplicitAccessRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| yes| Solicitation #
-ntype |string |no |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
+ntype |string |no |[Refer Related Notices](#related-notices)
nonfbo_solbr| string| no |Non-fbo Solicitation #. Not supported for this method.
Id |string |no |Not used in this method
vendor |VendorData| yes| Complex type defined below
-reason |string |no |rejection reason not used in this method
Response:
@@ -1450,12 +1439,12 @@ NoticeListRequest Complex Type Definition:
Element Name| Type| Required| Description
-----|-----|-----|-----
-notice_type |string| No| Solicitation #. Valid Values: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL. Note:Searches for awardsj&as, itb’s and fairopps will return both standalone notices AND base notices that contain one of these type
-solnbr |string |No |Solicitation #
-awdnbr |string |No |Award #
-posted_from |date| No| Posted From Date. YYYYMMDD.
-posted_to |date| |No Posted To Date. YYYYMMDD
-documents_to_search |string| No| Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided.
+notice_type |string| No (at least 1 field is required)| [Refer Related Notices](#related-notices) Note:Searches for awardsj&as, itb’s and fairopps will return both standalone notices AND base notices that contain one of these type
+solnbr |string |No (at least 1 field is required) |Solicitation #
+awdnbr |string |No (at least 1 field is required)|Award #
+posted_from |date| No (at least 1 field is required)| Posted From Date. YYYYMMDD.
+posted_to |date| |No (at least 1 field is required)| Posted To Date. YYYYMMDD
+documents_to_search |string| No(at least 1 field is required)| Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided.
Response:
@@ -1500,10 +1489,10 @@ NoticeDataRequest Complex Type Definition:
Element Name| Type| Required| Description
-----|-----|-----|-----
-notice_id |string |Yes| Unique ID found from getList call or ID’s for changes found in getNoticeData call.
-get_changes |boolean| No| True or false
Pass in true to get the full notice history with all changes
-get_changes_from_date |date| No| If maintaining a sync of changes, can specify a date so that only changes that have occurred since provided date will be returned.
-get_file_data| boolean| No| True or False
Pass in true and the method will return any file content stored in Contract Opportunities (attachment data will be retuned as Base64Encoding Format). If false, the meta details/links will still be provided.
+notice_id |string |No (at least 1 field is required)| Unique ID found from getList call or ID’s for changes found in getNoticeData call.
+get_changes |boolean| No (at least 1 field is required)| True or false
Pass in true to get the full notice history with all changes
+get_changes_from_date |date| No (at least 1 field is required)| If maintaining a sync of changes, can specify a date so that only changes that have occurred since provided date will be returned.
+get_file_data| boolean| No (at least 1 field is required)| True or False
Pass in true and the method will return any file content stored in Contract Opportunities (attachment data will be retuned as Base64Encoding Format). If false, the meta details/links will still be provided.
Response:
@@ -2149,75 +2138,75 @@ Please note that variances may exist between SOAP requests generated by differen
Response Sample – Success
No – Rest (Required for Source
**archdate** (updated needed)| No| YYYYMMDD |1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restriction
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
awardee |Yes – Only Award
No – Rest| 6553 characters| NA| NA
awardee_duns| No |9 digits with optional plus 4| NA| NA
-contact | Yes - Rest
No - Award & Special Notice; |65535 characters Default value = Primary Other types are: Secondary, Owner| 1. This required field should be validated |1. Primary Contact is Required
+contact | Yes - Rest
No - Award & Special Notice |65535 characters Default value = Primary Other types are: Secondary, Owner| 1. This required field should be validated |1. Primary Contact is Required
desc| Yes - Rest
No – Justfication & Award |65535 characters| 1. This required field should be validated.| 1. Description is required
link|No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA | NA
email| Yes - Rest
No - Only Award| 128 characters| NA |NA
From 3a1c12622614a7e32bede16c6bdaf2de3f7380c9 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Fri, 25 Oct 2019 16:34:51 -0400
Subject: [PATCH 050/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 146 ++++++++++++++---------------
1 file changed, 73 insertions(+), 73 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 0e9f093e1..b3ecee684 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -214,8 +214,8 @@ GovURL Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | yes | Description | 255 characters
+url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | Yes | Description | 255 characters
GovEmail Complex Type Definition
@@ -262,10 +262,10 @@ DeleteNoticeOrDocumentPackage Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr | string | Yes, if Non-Award | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | no | [Refer Related Notices](#related-notices)
+ntype | string | No | [Refer Related Notices](#related-notices)
awdnbr | string | Yes; Solicitation Number or Award Number is required| Award # | 255 characters
deletetype | string | no | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
-deletemethod | string | no | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
+deletemethod | string | No | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
### Archive Notice
(ArchiveNotice)
@@ -372,15 +372,15 @@ GovURL Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | no | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | no | Description | 255 characters
+url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description | 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address | string | no |Email Address |128 characters
-desc | string | no | Description | 255 characters
+address | string | No |Email Address |128 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition: This field is not implemented
@@ -493,23 +493,23 @@ zip | string | No | Zip Code | 5 digits
classcod | string | Yes – Solicitation/Combined/Sale of Surplus/ITB/Justification
No – Rest | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes – Combined & Solicitation
No – Rest | NAICS Code | Valid NAICS Code NAICS Reference
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | string | no | Office Address | 65535 characters
+offadd | string | No | Office Address | 65535 characters
subject | string | Yes | Subject | 255 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype | string | Yes | Base Notice Type | [Refer Related Notices](#related-notices)
respdate | date | Yes – for Combined/Solicitation
No – Rest (Special Notice/Sale of Surplus/Sources Sought/Presol must have either respdate or archdate)| Response Date | YYYYMMDD
-**archdate** (update needed) | date | no | Archive Date | YYYYMMDD
+**archdate** (update needed) | date | No | Archive Date | YYYYMMDD
contact | string | Yes – Rest
No – For Award/Special notice| Contact Info | 65535 characters
desc | string | Yes - Award/Justification
No - Rest | Description | 65535 characters
-link | GovURL – complex type | no | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
email | GovEmail – complex type | Yes - Rest
No - Only Award | Government Email | 128 characters
-links | DocumentLink[] | no | Array Of links |
-files | DocumentFile[] | no | Array of files |
-setaside | string | no | Set-Aside code | See Set Aside Value Section for valid codes
-popaddress | string | no | Pop Add | 65535 characters
-popzip | string | no | Pop Zip | 5 digits
-popcountry | string | no | Pop Country | 32 characters
-recovery_act | boolean | no | Recovery Act | True or False
+links | DocumentLink[] | No | Array Of links |
+files | DocumentFile[] | No | Array of files |
+setaside | string | No | Set-Aside code | See Set Aside Value Section for valid codes
+popaddress | string | No | Pop Add | 65535 characters
+popzip | string | No | Pop Zip | 5 digits
+popcountry | string | No | Pop Country | 32 characters
+recovery_act | boolean | No | Recovery Act | True or False
GovURL Complex Type Definition:
@@ -589,15 +589,15 @@ GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | yes | Description | 255 characters
+url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | Yes | Description | 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address | string | yes | Email Address | 128 characters
-desc | string | yes | Description | 255 characters
+address | string | Yes | Email Address | 128 characters
+desc | string | Yes | Description | 255 characters
DocumentLink Complex Type Definition:
@@ -660,15 +660,15 @@ GovURL Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | yes | Description | 255 characters
+url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | Yes | Description | 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address | string | yes | Email Address | 128 characters
-desc | string | yes | Description | 255 characters
+address | string | Yes | Email Address | 128 characters
+desc | string | Yes | Description | 255 characters
DocumentLink Complex Type Definition: This field is not implemented
@@ -730,15 +730,15 @@ GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |yes| Website Address| 255 characters, consist of a restricted set of characters (see URL specification - RFC2396)
-desc| string |yes| Description| 255 characters
+url |string |Yes| Website Address| 255 characters, consist of a restricted set of characters (see URL specification - RFC2396)
+desc| string |Yes| Description| 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address |string| yes| Email Address |128 characters
-desc |string |yes |Description |255 characters
+address |string| Yes| Email Address |128 characters
+desc |string |Yes |Description |255 characters
DocumentLink Complex Type Definition:
@@ -796,15 +796,15 @@ GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |yes |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string |yes |Description |255 characters
+url |string |Yes |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc |string |Yes |Description |255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address| string| yes| Email Address |128 characters
-desc |string |yes |Description |255 characters
+address| string| Yes| Email Address |128 characters
+desc |string |Yes |Description |255 characters
DocumentLink Complex Type Definition:
@@ -937,15 +937,15 @@ GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |yes |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string| yes| Description| 255 characters
+url |string |Yes |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc |string| Yes| Description| 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address |string |yes| Email Address |128 characters
-desc| string| yes |Description| 255 characters
+address |string |Yes| Email Address |128 characters
+desc| string| Yes |Description| 255 characters
DocumentLink Complex Type Definition:
@@ -1013,14 +1013,14 @@ stauth |string |Yes – JA
No – Rest |J&A StatutoryAuthority
Not
respdate| date| Yes – Only Combined/Solicitation
No – Rest (Required for Sources Sought/Presol/Sale of Surplus/Special Notice when Required when 15 Days after Response is selected) |Response Date |YYYYMMDD
**archdate** (update needed) | date| No| Archive Date| YYYYMMDD
awardee| string| Yes – Only Award
No – Rest| Awardee |65535 characters
-awardee_duns| string |no |Awardee DUNS |9 digits with optional plus 4
+awardee_duns| string |No |Awardee DUNS |9 digits with optional plus 4
contact| string| Yes - Rest
No - Award & Special Notice| Contact Info| 65535 characters
desc |string| Yes - Rest
No – Justfication & Award| Main Description| 65535 characters
link| GovernmentURL| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
email| GovernmentEmail| Yes - Rest
No - Only Award| Government Email |128 characters
-links |DocumentLink []| no |Array Of links |
-files |DocumentFile[]| no| Array of files |
-setaside| string| no| Set-Aside code | See Set Aside Section for valid codes
+links |DocumentLink []| No |Array Of links |
+files |DocumentFile[]| No| Array of files |
+setaside| string| No| Set-Aside code | See Set Aside Section for valid codes
popaddress| string| No| POP Address |65535 characters
popzip| string |No |POP Zip |5 digits
popcountry| string| Yes – For wards; No – For rest| POP Country| 32 characters
@@ -1033,15 +1033,15 @@ GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url| string| yes| Website Address|255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc| string| yes |Description| 255 characters
+url| string| Yes| Website Address|255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc| string| Yes |Description| 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address| string| yes |Email Address| 128 characters
-desc |string| yes |Description |255 characters
+address| string| Yes |Email Address| 128 characters
+desc |string| Yes |Description |255 characters
DocumentLink Complex Type Definition:
@@ -1185,8 +1185,8 @@ IVLListRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
-solnbr| string| yes| Solicitation #
-ntype |string |no |[Refer Related Notices](#related-notices)
+solnbr| string| Yes| Solicitation #
+ntype |string |No |[Refer Related Notices](#related-notices)
IVLListResponse Complex Type Definition:
@@ -1230,10 +1230,10 @@ AuthorizedPartyListRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
-solnbr| string| yes |Solicitation #. Provide an empty string for this argument if using nonfbo_solnbr below
-ntype| string| no| V[Refer Related Notices](#related-notices)
+solnbr| string| Yes |Solicitation #. Provide an empty string for this argument if using nonfbo_solnbr below
+ntype| string| No| V[Refer Related Notices](#related-notices)
nonfbo_solbr| string| no| Non-fbo Solicitation #. Not supported for this method
-status| string |no |Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests.
+status| string |No |Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests.
AuthorizedPartyListResponse Complex Type Definition:
@@ -1274,10 +1274,10 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
-solnbr| string |yes| Solicitation #
-ntype |string |no| [Refer Related Notices](#related-notices)
+solnbr| string |Yes| Solicitation #
+ntype |string |No| [Refer Related Notices](#related-notices)
nonfbo_solbr |string| no| Non-fbo Solicitation #. Not supported for this method
-Id| string| yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
+Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
Response:
@@ -1300,10 +1300,10 @@ ExplicitAccessRequestComplex Type Definition:
Element Name |Type |Required| Description
-----|-----|-----|----
-solnbr |string |yes| Solicitation #
-ntype| string| no| [Refer Related Notices](#related-notices)
-nonfbo_solbr| string| no| Non-fbo Solicitation #. Not supported for this method
-vendor| VendorData |yes| Complex type defined below
+solnbr |string |Yes| Solicitation #
+ntype| string| No| [Refer Related Notices](#related-notices)
+nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method
+vendor| VendorData |Yes| Complex type defined below
Response:
@@ -1337,9 +1337,9 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
-solnbr| string |yes| Solicitation #
-ntype |string |no|[Refer Related Notices](#related-notices)
-nonfbo_solbr |string| no| Non-fbo Solicitation #. Not supported for this method
+solnbr| string |Yes| Solicitation #
+ntype |string |No|[Refer Related Notices](#related-notices)
+nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
reason |string| Yes| rejection reason not used in this method
@@ -1364,11 +1364,11 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
-solnbr| string| yes| Solicitation #
-ntype |string |no| [Refer Related Notices](#related-notices)
-nonfbo_solbr |string |no |Non-fbo Solicitation #. Not supported for this method
-vendor |VendorData| yes| Complex type defined below
-reason| string| yes |Rejection Reason
+solnbr| string| Yes| Solicitation #
+ntype |string |No| [Refer Related Notices](#related-notices)
+nonfbo_solbr |string |No |Non-fbo Solicitation #. Not supported for this method
+vendor |VendorData| Yes| Complex type defined below
+reason| string| Yes |Rejection Reason
Response:
@@ -1400,11 +1400,11 @@ ExplicitAccessRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
-solnbr| string| yes| Solicitation #
-ntype |string |no |[Refer Related Notices](#related-notices)
-nonfbo_solbr| string| no |Non-fbo Solicitation #. Not supported for this method.
-Id |string |no |Not used in this method
-vendor |VendorData| yes| Complex type defined below
+solnbr| string| Yes| Solicitation #
+ntype |string |No |[Refer Related Notices](#related-notices)
+nonfbo_solbr| string| No |Non-fbo Solicitation #. Not supported for this method.
+Id |string |No |Not used in this method
+vendor |VendorData| Yes| Complex type defined below
Response:
@@ -1596,7 +1596,7 @@ FileDataRequest Complex Type Definition:
Element Name| Type| Required| Description
-----|-----|-----|-----
-file_id |string| yes| Unique ID of a file found from getNoticeData call (i.e. file_id element)
+file_id |string| Yes| Unique ID of a file found from getNoticeData call (i.e. file_id element)
Response:
@@ -4100,7 +4100,7 @@ offadd| No| 65535 characters| Not-Used| NA
officeid |Yes |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes |255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
solnbr| Yes - Rest
No - Only Special Notice| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. If this field is not given, then system throws an errors as shown on the right hand side
2. If duplicate solicitation number is given, then system throws an error
3. For an invalid solnbr and notice_type combination, the service throws an error| 1.Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Opportunity not found with given solicitation number and ntype
-ntype| no| [Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error |NTYPE value provided is not valid
+ntype| No| [Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error |NTYPE value provided is not valid
awdnbr| Yes – Award, ITB & JA
No – Rest| 255 characters| 1. This required field should be validated| 1. Award Details Section - Contract Award Number is a required field
donbr| Yes – JA
No – Rest |255 characters |1. This is required field for JA |1. Award Details Section - Task/Delivery Order Number is required field
awdamt |Yes – Award
No – Rest| 64 characters| 1. This required field should be validated |1. Award Details Section – Amount is a required field.
From ae187591b0b92c695740e1692d458ff6700ce9c5 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Fri, 25 Oct 2019 16:41:05 -0400
Subject: [PATCH 051/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index b3ecee684..6578b0b03 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -31,10 +31,10 @@ To perform an operation, user who is registered with beta.sam.gov should have ei
* On beta.sam.gov, please log in and click on the profile and go to Account Details. AAC is listed under 'Organization Information' section.
* On alpha.sam.gov, please log in and click on the profile and go to Account Details. AAC is listed under 'Organization Information' section.
-### *Type of Connection Validation (Future Implementation)*
+### Type of Connection Validation
All SOAP Web Service requests will be validated against the Type of Connection within the system account profile. All requests without "SOAP" type of connection in the system account profile will be rejected with an error.
-### *IP Address Validation (Future Implementation)*
+### IP Address Validation
All SOAP Web Service requests will be validated against the IP Addresses registered within the system account profile. All requests that are not from registered IP address(es) in the system account profile will be rejected with an error.
### Authentication Methods
@@ -4668,7 +4668,7 @@ Date | Version | Description
------|---------------|---------
5/10/2019 | v0.1 | Base Version
7/22/2019 | v0.2 | Workflow Chart Added
-8/01/2019 | v0.3 | Added Future Implementation for IP Address Validation and Type of Connection
+8/01/2019 | v0.3 | Added IP Address Validation and Type of Connection
8/01/2019 | v0.4 | Added the details for the Solicitation notice type and business rules for nType
8/19/2019 | v0.5 | SUBMITPRESOL/SOURCESSOUGHT, SUBMITCOMBINED, SUBMITAWARD, SUBMITSALEOFSURPLUS, SUBMITJA, SUBMITITB, SUBMITSPECIANOTICE, SUBMITMOD, ARCHIVENOTICE, UNARCHIVENOTICE, CANCELNOTICE, SUBMITDOCUMENTSANDLINKS, GETLIST, GETNOTICEDATA, GETFILEDATA, DELETENOTICE parameters updated
User Account Section Updated
9/25/2019 | v0.6 | Updated required fields for DocumentLink, DocumentFile, ArchiveNotice, UnArchiveNotice, CancelNotice and DeleteNoticeOrDocumentPackage ComplexType definitions
From 4890569bfe7232b1b24b3cdc450e8729af831c9c Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Fri, 25 Oct 2019 16:43:14 -0400
Subject: [PATCH 052/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 6578b0b03..06a5db4db 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -138,15 +138,15 @@ far7 | FAR 6.302-7 - Public interest
This section indicates the list of notices that can be used in the SOAP services
-PRESOL - Presolicitation
-COMBINE - Combined Synopsis/Solicitation
-SRCSGT - for Sources Sought
-SSALE - Sale of Surplus Property
-SNOTE - Special Notice
-JA – Justification
-ITB – Intent to Bundle
-SOL - Solicitation
-AWARD - Award
+PRESOL - Presolicitation
+COMBINE - Combined Synopsis/Solicitation
+SRCSGT - for Sources Sought
+SSALE - Sale of Surplus Property
+SNOTE - Special Notice
+JA – Justification
+ITB – Intent to Bundle
+SOL - Solicitation
+AWARD - Award
This is a conversion table for notices using SOAP services
From c47effc14a1c0cc17397cffb89dfc5ef00250287 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Sat, 26 Oct 2019 10:21:49 -0400
Subject: [PATCH 053/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 22 ++++++++++------------
1 file changed, 10 insertions(+), 12 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 06a5db4db..dc9c8cab6 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -115,6 +115,16 @@ VSS | Veteran-Owned Small Business Sole source (specific to Department of Vetera
### Notice Types
The web service API includes specific methods to submit each of the base notice types (i.e. presolicitation, combined/synopsis, award, etc.). You will find these outlined in the sections below.
+PRESOL - Presolicitation
+COMBINE - Combined Synopsis/Solicitation
+SRCSGT - for Sources Sought
+SSALE - Sale of Surplus Property
+SNOTE - Special Notice
+JA – Justification
+ITB – Intent to Bundle
+SOL - Solicitation
+AWARD - Award
+
### Stauth Valid Values
Below table captures stauth values to use while making requests as needed.
@@ -136,18 +146,6 @@ far7 | FAR 6.302-7 - Public interest
### Related Notices
-This section indicates the list of notices that can be used in the SOAP services
-
-PRESOL - Presolicitation
-COMBINE - Combined Synopsis/Solicitation
-SRCSGT - for Sources Sought
-SSALE - Sale of Surplus Property
-SNOTE - Special Notice
-JA – Justification
-ITB – Intent to Bundle
-SOL - Solicitation
-AWARD - Award
-
This is a conversion table for notices using SOAP services
||SRCSGT | PRESOL | COMBINE | SOL| AWARD | SSALE | ITB | JA | SNOTE
From 922d3f94e816324ffeeaa966903cdf2de282a2d5 Mon Sep 17 00:00:00 2001
From: Prashant Pillai
Description Language (WSDL)
To view the WSDL for all available methods and object definitions, refer below links:
-<<<<<<< HEAD
+
* Alpha WSDL Link: https://api-alpha.sam.gov/prodlike/ws/fboendpoint/services.wsdl or https://api-alpha.sam.gov/prodlike/ws/fboendpoint/fbo.wsdl
* Beta WSDL Link: https://api.sam.gov/prod/ws/fboendpoint/services.wsdl or https://api.sam.gov/prod/ws/fboendpoint/fbo.wsdl
@@ -26,7 +26,6 @@ To view the current workflow of SOAP web service, refer below file:
### User Accounts
To perform an operation, user who is registered with beta.sam.gov should have either Contracting Officer role OR Contracting Specialist role. Note that to perform an operation, user must have only one role.
-
**Note** To submit any opportunity for an office, user should provide office org key or AAC. If office org key is known, please provide the same in the 'officeid' field in the requests. If office org key is not available, then users can provide AAC in place of office org key in 'officeid' field. In order to get AAC:
* On beta.sam.gov, please log in and click on the profile and go to Account Details. AAC is listed under 'Organization Information' section.
* On alpha.sam.gov, please log in and click on the profile and go to Account Details. AAC is listed under 'Organization Information' section.
@@ -89,9 +88,9 @@ messages | string [] - array of strings
### Set-Aside Values
Several methods pertaining to submitting Contract Opportunities involve the Set-Aside Type field. Use the Set-Aside codes to submit notices.
-Refer below table for mapping between legacy SetAside Values to modern SetAside Value:
+Refer below table for mapping between legacy Set-Aside Values to modern Set-Aside Value:
-Code | Modern SetAside Values | Legacy SetAside values
+Code | Modern Set-Aside Values | Legacy Set-Aside values
-----|------- | -------
SBA | Total Small Business Set-Aside (FAR 19.5) | Total Small Business
SBP | Partial Small Business Set-Aside (FAR 19.5) | Partial Small Business
@@ -115,15 +114,33 @@ VSS | Veteran-Owned Small Business Sole source (specific to Department of Vetera
### Notice Types
The web service API includes specific methods to submit each of the base notice types (i.e. presolicitation, combined/synopsis, award, etc.). You will find these outlined in the sections below.
-PRESOL - Presolicitation
-COMBINE - Combined Synopsis/Solicitation
-SRCSGT - for Sources Sought
-SSALE - Sale of Surplus Property
-SNOTE - Special Notice
-JA – Justification
-ITB – Intent to Bundle
-SOL - Solicitation
-AWARD - Award
+The Notice Types valid options are:
+
+* PRESOL – for Presolicitation Notices
+* COMBINE – for Combined/Synopsis Notices
+* AWARD – for Award Notices
+* JA – for Justification & Approval (J&A) Notices
+* SRCSGT – for Sources Sought Notices
+* SSALE – for Sale of Surplus Property Notices
+* SNOTE – for Special Notices
+* ITB – for Intent to Bundle Requirements (DoD-Funded) Notices
+* SOL - for Solicitation Notices
+
+#### Related Notices
+
+This is a conversion table for notices using submitNotice method.
+
+||SRCSGT | PRESOL | COMBINE | SOL| AWARD | SSALE | ITB | JA | SNOTE
+-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|
+|**SRCSGT**||O|O|O|O|O|||O
+|**PRESOL**|O||O|O||O|O|O|O
+|**COMBINE**|O|O|||O||O|O|O
+|**SOL**|O|O|||O||O|O|O
+|**AWARD**|||O|O|||O|O|O
+|**SSALE**|O|O|||||O|O|O
+|**ITB**||O|O|O|O|O||O|O
+|**JA**||O|O|O|O|O|O||O
+|**SNOTE**|O|O|O|O|O|O|O|O|
### Stauth Valid Values
Below table captures stauth values to use while making requests as needed.
@@ -143,22 +160,7 @@ far4 | FAR 6.302-4 - International agreement
far5 | FAR 6.302-5 - Authorized or required by statute
far6 | FAR 6.302-6 - National security
far7 | FAR 6.302-7 - Public interest
-
-### Related Notices
-
-This is a conversion table for notices using SOAP services
-
-||SRCSGT | PRESOL | COMBINE | SOL| AWARD | SSALE | ITB | JA | SNOTE
------|-----|-----|-----|-----|-----|-----|-----|-----|-----|
-|**SRCSGT**||O|O|O|O|O|||O
-|**PRESOL**|O||O|O||O|O|O|O
-|**COMBINE**|O|O|||O||O|O|O
-|**SOL**|O|O|||O||O|O|O
-|**AWARD**|||O|O|||O|O|O
-|**SSALE**|O|O|||||O|O|O
-|**ITB**||O|O|O|O|O||O|O
-|**JA**||O|O|O|O|O|O||O
-|**SNOTE**|O|O|O|O|O|O|O|O|
+far13 | FAR 13.5 - Simplified Procedures for One Source
## Contracting Officer
Method Details
@@ -183,15 +185,14 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | Yes | Posting Date | YYYYMMDD
zip | string | No | Zip Code | 5 digits
-classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | No | NAICS Code | Valid NAICS Code NAICS Reference
-offadd | string | No | Office Address | 65535 characters
-officeid | string | Yes | Office id of the office where an opportunity is being submitted | 20 characters
+classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
+naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
+offadd | string | No | Office Address (Not used) | 65535 characters
+officeid | string | Yes | Office ID of the office where an opportunity is being submitted | 20 characters
subject | string | Yes | Subject | 255 characters
-solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype | string | No | Base Notice Type | [Refer Related Notices](#related-notices)
-awdnbr | string | Yes | Award Number | 255 characters
-awdnbr | open text, label: Agency assigned number for control tracking and identification.
Please use ONLY alphanumeric and - _ ( ) { } characters [no spaces]. | Yes | Award Number | 255 characters
+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 | Yes | Award Number | 255 characters
Agency assigned number for control tracking and identification.
Alphanumeric and - _ ( ) { } characters [no spaces]
awdamt | string | Yes | Award Amount | 64 characters
linenbr | string | No | Line Number | 255 characters
awddate | date | Yes | Award Date | YYYYMMDD
@@ -200,41 +201,41 @@ awardee | string | Yes | Awardee | 65535 characters
awardee_duns | string | No | Awardee DUNS | 9 digits with optional plus 4
contact | string | No | Contact Info | 65535 characters
desc | string | No | Description | 65535 characters
-link | GovURL | No | Government Link 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)|
+link | GovURL | No | Government Link |255 characters| Consist of a restricted set of characters (see URL specification - RFC 2396)|
email | GovEmail | No | Government Email | 128 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
-setaside | string | No | Set-Aside code | See Set Aside Value Section for valid codes
+setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
recovery_act | boolean | No | Recovery Act | True or False
-correction | boolean | No | Correction of previous Award | True or False
If correcting a previously submitted award notice, specify true and the system will lookup the award by award number and sol number if applicable.
+correction | boolean | No | Correction of previous Award | True or False
If correcting a previously submitted Award notice, specify True and the system will lookup the award by award number and sol number if applicable.
GovURL Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description | 255 characters
+url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description | 255 characters
GovEmail Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address | string | Yes | Email Address | 128 characters
-desc | string | Yes | Description | 255 characters
+address | string | No | Email Address | 128 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-Desc | string | Yes | Description/Title | 255 characters
+url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+Desc | string | No | Description/Title | 255 characters
DocumentFile Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -259,10 +260,10 @@ DeleteNoticeOrDocumentPackage Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-solnbr | string | Yes, if Non-Award | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | [Refer Related Notices](#related-notices)
-awdnbr | string | Yes; Solicitation Number or Award Number is required| Award # | 255 characters
-deletetype | string | no | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
+solnbr | string | Yes; Solicitation # or Award # is required | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
+ntype | string | No | [Refer Notice Types](#notice-types)
+awdnbr | string | Yes; Solicitation # or Award # is required| Award # | 255 characters
+deletetype | string | No | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod | string | No | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
### Archive Notice
(ArchiveNotice)
@@ -286,12 +287,12 @@ ArchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-solnbr | string | No | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | [Refer Related Notices](#related-notices)
-archdate | date | Yes | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
-officeid | string | No | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
+solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
+ntype | string | No | [Refer Notice Types](#notice-types)
+archdate | date | No | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
+officeid | string | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-### Cancel Notice
(CancelNotice) NEEDS FIX
+### Cancel Notice
(CancelNotice)
This method is used to post a cancellation notice to any base notice type already in the Opportunities system. Provide a Solicitation Number or an Award Number (for stand- alone awards) and other data outlined below for the cancellation notice.
@@ -313,13 +314,13 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
offadd | string | No | Office Address | 65535 characters
-officeid | String | No | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
+officeid | String | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
subject | string | No | Subject | 255 characters
solnbr |string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
+ntype | string | No | [Refer Notice Types](#notice-types) |
awdnbr | string | No | Award # |255 characters
archdate | date | No | Archive Date | YYYYMMDD
-contact | string | No | Contact Info | 65535 characters
+contact | string | Yes | Contact Info | 65535 characters
desc | string | Yes | Cancellation Description | 65535 characters
## Contracting Officer/Contracting
Specialist Method Details
@@ -347,24 +348,24 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date | date | No | Posting Date | YYYYMMDD
zip | string | No | Zip Code | 5 digits
classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | No | NAICS Code | Valid NAICS Code NAICS Reference
-officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
+naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
+officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
+offadd | string | No | Office Address (Not Used) | 65535 characters
subject | string | Yes| Title of the Pre-solicitation | 255 characters
-solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-respdate | date | No - However either Respdate or Archdate must be selected | Response Date | YYYYMMDD
-**archdate** (update needed) | date | No - However either Respdate or Archdate must be selected | Archive Date | YYYYMMDD
+solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
+respdate | date | Yes - either respdate or archdate is required | Response Date | YYYYMMDD
+archdate | date | Yes - either respdate or archdate is required | Archive Date | YYYYMMDD
contact | string | Yes | Contact Info | 65535 characters
desc |string |Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link has URL & description | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
email | GovEmail – complex type | Yes | Government Email | 128 characters
links | DocumentLink[] | No | Array of links |
files | DocumentFile[] | No | Array of files |
-setaside | string | No | Set-Aside code | See Set Aside Values Section for valid codes
-popaddress | string | No | Pop Add | 65535 characters
-popzip |string | No | Pop Zip | 5 digits
-popcountry | string | No | Pop Country | 32 characters
-recovery_act | boolean | no | Recovery Act | True or False
+setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
+popaddress | string | No | Place of Performace Address | 65535 characters
+popzip |string | No | Place of Performace Zip | 5 digits
+popcountry | string | No | Place of Performace Country | 32 characters
+recovery_act | boolean | No | Recovery Act | True or False
GovURL Complex Type Definition: This field is not implemented
@@ -377,22 +378,22 @@ GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address | string | No |Email Address |128 characters
+address | string | Yes |Email Address |128 characters
desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description/Title | 255 characters
+url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description/Title | 255 characters
DocumentFile Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -418,31 +419,31 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date | date | No | Posting Date | YYYYMMDD
zip | string | No | Zip Code | 5 digits
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | Yes | NAICS Code | Valid NAICS Code NAICS Reference
-officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
+naics | string | Yes | NAICS Code | Valid NAICS Code
NAICS Reference
+officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address | 65535 characters
subject | string | Yes | Subject | 255 characters
-solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
+solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | Yes | Response Date | YYYYMMDD
-**archdate** (update needed) | date | No | Archive Date | YYYYMMDD
+archdate | date | No | Archive Date | YYYYMMDD
contact | string |Yes | Contact Info | 65535 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
email | GovEmail – complex type | Yes | Government Email | 128 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
-setaside | string | No | Set-Aside code | See Set Aside Values section for valid codes
-popaddress | string | No | Pop Add | 65535 characters
-popzip | string | No | Pop Zip | 5 digits
-popcountry | string | No | Pop Country | 32 characters
+setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
+popaddress | string | No | Place of Performace Address | 65535 characters
+popzip | string | No | Place of Performace Zip | 5 digits
+popcountry | string | No | Place of Performace Country | 32 characters
recovery_act | boolean | No | Recovery Act | True or False
GovURL Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description | 255 characters
+url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description | 255 characters
GovEmail Complex Type Definition:
@@ -455,15 +456,15 @@ DocumentLink Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description/Title | 255 characters
+url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description/Title | 255 characters
DocumentFile Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -486,56 +487,56 @@ Mod Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | Yes - Only Award
No - Rest | Posting Date | YYYYMMDD
+date | date | Yes - for AWARD | Posting Date | YYYYMMDD
zip | string | No | Zip Code | 5 digits
-classcod | string | Yes – Solicitation/Combined/Sale of Surplus/ITB/Justification
No – Rest | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | Yes – Combined & Solicitation
No – Rest | NAICS Code | Valid NAICS Code NAICS Reference
-officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
+classcod | string | Yes - for SOL, COMBINE, SSALE, ITB, JA | Class-Code | Valid classification code (FAR, Section 5.207(g))
+naics | string | Yes - for COMBINE, SOL | NAICS Code | Valid NAICS Code
NAICS Reference
+officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
+offadd | string | No | Office Address (Not Used)| 65535 characters
subject | string | Yes | Subject | 255 characters
-solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype | string | Yes | Base Notice Type | [Refer Related Notices](#related-notices)
-respdate | date | Yes – for Combined/Solicitation
No – Rest (Special Notice/Sale of Surplus/Sources Sought/Presol must have either respdate or archdate)| Response Date | YYYYMMDD
-**archdate** (update needed) | date | No | Archive Date | YYYYMMDD
-contact | string | Yes – Rest
No – For Award/Special notice| Contact Info | 65535 characters
-desc | string | Yes - Award/Justification
No - Rest | Description | 65535 characters
+solnbr | string | Yes, EXCEPT No - Only for SNOTE | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
+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 SNOTE, SSALE, SRCSGT, PRESOL | Response Date | YYYYMMDD
+archdate | date | Yes | Archive Date | YYYYMMDD
+contact | string | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL | Contact Info | 65535 characters
+desc | string | Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email | GovEmail – complex type | Yes - Rest
No - Only Award | Government Email | 128 characters
+email | GovEmail – complex type | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL, SNOTE | Government Email | 128 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
-setaside | string | No | Set-Aside code | See Set Aside Value Section for valid codes
-popaddress | string | No | Pop Add | 65535 characters
-popzip | string | No | Pop Zip | 5 digits
-popcountry | string | No | Pop Country | 32 characters
+setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
+popaddress | string | No | Place of Performace Address | 65535 characters
+popzip | string | No | Place of Performace Zip | 5 digits
+popcountry | string | No | Place of Performace Country | 32 characters
recovery_act | boolean | No | Recovery Act | True or False
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description | 255 characters
+url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description | 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address | string | Yes | Email Address | 128 characters
-desc | string | Yes | Description | 255 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description/Title | 255 characters
+url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -561,19 +562,19 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date | Date | No | Posting Date | YYYYMMDD
zip | String | No | Zip Code | 5 digits
classcod | String | Yes | Class-Code | Valid classification code
-naics | String | No | NAICS Code | Valid NAICS Code NAICS Reference
+naics | String | No | NAICS Code | Valid NAICS Code
NAICS Reference
offadd | String | No | Office Address | 65535 characters
-officeid | String | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
+officeid | String | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
subject | String | Yes | Subject | 255 characters
-solnbr | String | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}.
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required
-ntype | string | No | Base Notice Type | [Refer Related Notices](#related-notices)
-stauth | String | Yes | Stat. Authority – Both foja & stauth values will be given under stauth in legacy | Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in section 4.4
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’
+solnbr | String | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
+ntype | string | No | Notice Type | Valid Value: JA
+stauth | String | Yes | J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy | [Refer Stauth Valid Values](#stauth-valid-values)
awdnbr | String | Yes | Award Number | 255 characters
modnbr | String | No | Mod Number | 32 characters
awdamt | String | No | Award Amount | 64 characters
awddate | Date | No | Award Date | YYYYMMDD
donbr | String | Yes | Task/Delivery Order Number | 255 characters from the set: a-z A-Z 0-9 - _ ( )
-**archdate** (update needed) | Date | No | Archive Date | YYYYMMDD
+archdate | Date | Yes | Archive Date | YYYYMMDD
contact | String | Yes | Contact Info | 65535 characters
desc | String | No | Description | 65535 characters
link | GovURL | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -581,35 +582,35 @@ links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
email | GovEmail | Yes | Government Email | 128 characters
recovery_act | boolean | No | Recovery Act | True or False;
-correction | boolean | No | Correction of previous J&A | True or False
If correcting a previously submitted j&a notice, specify true and the system will lookup the j&a by award number and sol number if applicable.
+correction | boolean | No | Correction of previous J&A | True or False
If correcting a previously submitted J&A notice, specify True and the system will lookup the j&a by award number and sol number if applicable.
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description | 255 characters
+url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description | 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address | string | Yes | Email Address | 128 characters
-desc | string | Yes | Description | 255 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description/Title | 255 characters
+url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -635,59 +636,59 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date | date | No | Posting Date | YYYYMMDD
zip | string | No | Zip Code | 5 digits
classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | No | NAICS Code | Valid NAICS Code
-officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
+naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
+officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address | 65535 characters
subject | string | Yes | Subject | 255 characters
-solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-respdate | date | No | Response Date | YYYYMMDD
-**archdate** (update needed) | date | No | Archive Date | YYYYMMDD
-contact | string | Yes | Contact Info | 65535 characters
Default value: Primary
Other types: Secondary, Owner
+solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
+respdate | date | Yes - either respdate or archdate is required | Response Date | YYYYMMDD
+archdate | date | Yes - either respdate or archdate is required | Archive Date | YYYYMMDD
+contact | string | Yes | Contact Info | 65535 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
email | GovEmail – complex type | Yes | Government Email | 128 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
-setaside | string | No | Set-Aside code | See Set Aside Value Section for valid codes
-popaddress | string | No | Pop Add | 65535 characters
-popzip | string | No | Pop Zip | 5 digits
-popcountry | string | No | Pop Country | 32 characters
+setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
+popaddress | string | No | Place of Performace Address | 65535 characters
+popzip | string | No | Place of Performace Zip | 5 digits
+popcountry | string | No | Place of Performace Country | 32 characters
recovery_act | boolean | No | Recovery Act | True or False
GovURL Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description | 255 characters
+url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description | 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address | string | Yes | Email Address | 128 characters
-desc | string | Yes | Description | 255 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description/Title | 255 characters
+url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description/Title | 255 characters
DocumentFile Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
### Foreign Government Standard
(submitForeignGovernment)
-This service is now deprecated. Hence no longer available.
+This service is deprecated.
### Special Notice
(submitSpecialNotice)
@@ -710,12 +711,12 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date | Date | No | Posting Date | YYYYMMDD
zip | String | No | Zip Code | 5 digits
classcod | String | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | String | No | NAICS Code | Valid NAICS Code NAICS Reference
-officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
+naics | String | No | NAICS Code | Valid NAICS Code
NAICS Reference
+officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | String | No | Office Address | 65535 characters
subject | String | Yes | Subject | 255 characters
-solnbr | String | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-**archdate** (update needed) | Date | No | Archive Date | YYYYMMDD
+solnbr | String | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
+archdate | Date | Yes | Archive Date | YYYYMMDD
contact | String | No | Contact Info | 65535 characters
desc | String | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -728,29 +729,29 @@ GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |Yes| Website Address| 255 characters, consist of a restricted set of characters (see URL specification - RFC2396)
-desc| string |Yes| Description| 255 characters
+url |string |No| Website Address| 255 characters, consist of a restricted set of characters (see URL specification - RFC2396)
+desc| string |No| Description| 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address |string| Yes| Email Address |128 characters
-desc |string |Yes |Description |255 characters
+desc |string |No |Description |255 characters
DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string| Yes |External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string |Yes |Description/Title |255 characters
+url |string| No |External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc |string |No |Description/Title |255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -776,12 +777,12 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date | date| No| Posting Date| YYYYMMDD
zip| string| No| Zip Code| 5 digits
classcod| string| Yes |Class-Code| Valid classification code (FAR, Section 5.207(g))
-naics| string| No| NAICS Code| Valid NAICS Code NAICS Reference
-officeid |string |Yes| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
+naics| string| No| NAICS Code| Valid NAICS Code
NAICS Reference
+officeid |string |Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd| string| No |Office Address |65535 characters
subject| string| Yes| Subject |255 characters
-solnbr| string |Yes |Sol #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-**archdate** (update needed)| date| No| Archive Date| YYYYMMDD
+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| 65535 characters
desc| string |Yes| Description |65535 characters
link |GovURL – complex type| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -794,29 +795,29 @@ GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |Yes |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string |Yes |Description |255 characters
+url |string |No |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc |string |No |Description |255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address| string| Yes| Email Address |128 characters
-desc |string |Yes |Description |255 characters
+desc |string |No |Description |255 characters
DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url| string| Yes| External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string| Yes| Description/Title |255 characters
+url| string| No| External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc |string| No| Description/Title |255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -842,52 +843,52 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date | date | No | Posting Date | YYYYMMDD
zip | string | No | Zip Code | 5 digits
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | Yes | NAICS Code | Valid NAICS Code NAICS Reference
-officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
+naics | string | Yes | NAICS Code | Valid NAICS Code
NAICS Reference
+officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address | 65535 characters
subject | string | Yes | Subject | 255 characters
-solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-respdate | date | Yes | Response Date | YYYYMMDD
-**archdate** (update needed) | date | No | Archive Date | YYYYMMDD
+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 | 65535 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
email | GovEmail – complex type | Yes | Government Email | 128 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
-setaside | string | No | Set-Aside code | See Set Aside Values section for valid codes
-popaddress | string | No | Pop Add | 65535 characters
-popzip | string | No | Pop Zip | 5 digits
-popcountry | string | No | Pop Country | 32 characters
+setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
+popaddress | string | No | Place of Performace Address | 65535 characters
+popzip | string | No | Place of Performace Zip | 5 digits
+popcountry | string | No | Place of Performace Country | 32 characters
recovery_act | boolean | No | Recovery Act | True or False
GovURL Complex Type Definition: This field is not implemented
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description | 255 characters
+url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description | 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address | string | Yes | Email Address | 128 characters
-desc | string | Yes | Description | 255 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | Yes | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | Yes | Description/Title | 255 characters
+url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc | string | No | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -913,15 +914,15 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date |Date |No |Posting Date |YYYYMMDD
zip |String| No| Zip Code| 5 digits
classcod| String| Yes| Class-Code| Valid classification code (FAR, Section 5.207(g))
-naics| String| No| NAICS Code| Valid NAICS Code
-officeid| String| Yes| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account| 20 characters
+naics| String| No| NAICS Code| Valid NAICS Code
NAICS Reference
+officeid| String| Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account| 20 characters
offadd| String |No| Office Address| 65535 characters
subject| String| Yes| Subject |255 characters
-solnbr |String |Yes| Sol # |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype |string |No| [Refer Related Notices](#related-notices)
+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 |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** (update needed) |Date |No |Archive Date| YYYYMMDD
+archdate |Date |Yes |Archive Date| YYYYMMDD
contact| String| Yes| Contact Info |65535 characters; Default value = Primary, Other types are: Secondary, Owner
desc |String |Yes |Description| 65535 characters
link| GovURL| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -929,33 +930,33 @@ links |DocumentLink[]| No| Array Of links |
files| DocumentFile[] |No |Array of files |
email |GovEmail| Yes| Government Email| 128 characters
recovery_act| boolean |No |Recovery Act |True or False
-correction |boolean |No |Correction of previous ITB| True or False
If correcting a previously submitted itb notice, specify true and the system will lookup the itb by award number, delivery number and sol number if applicable.
+correction |boolean |No |Correction of previous ITB| True or False
If correcting a previously submitted ITB notice, specify True and the system will lookup the itb by award number, delivery number and sol number if applicable.
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |Yes |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string| Yes| Description| 255 characters
+url |string |No |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc |string| No| Description| 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address |string |Yes| Email Address |128 characters
-desc| string| Yes |Description| 255 characters
+desc| string| No |Description| 255 characters
DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url| string| Yes |External URL| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc| string| Yes| Description/Title |255 characters
+url| string| No |External URL| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc| string| No| Description/Title |255 characters
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -966,17 +967,7 @@ This service is now deprecated. Instead, please use submitJA to perform the oper
### General Notice
(submitNotice)
-This is a general method that supports submitting all of the above notice types. The complex type for the input data consists of all possible data elements across all notice types. Users may setup their web service client to use this general method instead of calling the specific methods outlined above. The functionality is the same regardless of whether you use this general method, or the specific methods above. The valid options for this field are:
-
-* PRESOL – for Presolicitation Notices
-* COMBINE – for Combined/Synopsis Notices
-* AWARD – for Award Notices
-* JA – for Justification & Approval (J&A) Notices
-* SRCSGT – for Sources Sought Notices
-* SSALE – for Sale of Surplus Property Notices
-* SNOTE – for Special Notices
-* ITB – for Intent to Bundle Requirements (DoD-Funded) Notices
-* SOL - for Solicitation Notices
+This is a general method that supports submitting all of the above notice types. The complex type for the input data consists of all possible data elements across all notice types. Users may setup their web service client to use this general method instead of calling the specific methods outlined above. **The functionality is the same regardless of whether you use this general method, or the specific methods above. **
Input Parameter | Type | Description
------- | ------ | -------
@@ -992,66 +983,66 @@ Complete notice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date| date| Yes - Only Award
No - Rest |Posting Date| YYYYMMDD
-notice_type |string |Yes| Notice type |Valid options outlined above
+date| date| No |Posting Date| YYYYMMDD
+notice_type |string |Yes| [Refer Notice Types](#notice-types) |
zip |string |No |Zip Code| 5 digits
-classcod| string| No| Class-Code |Valid classification code (FAR, Section 5.207(g))
-naics |string |Yes - Combined Synopsis/Solicitation & Solicitation
No - Rest |NAICS Code| Valid NAICS Code NAICS Reference
-officeid| String| Yes| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account |20 characters
-offadd |string| No| Office Address |65535 characters
-subject| string| Yes – For presol, combined, itb, ja, award, special, surplus
No – for rest| Subject| 255 characters
-solnbr| string| Yes - Rest
No - Only Special Notice| Sol # |128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype |string |no |[Refer Related Notices](#related-notices)
-awdnbr| string| Yes – Award, ITB & JA
No – Rest| Award # |255 characters
-donbr |string |Yes – JA
No – Rest| Delivery/Task Order Number |255 characters
-awdamt |string| Yes – Award
No – Rest |Award Amount| 64 characters
+classcod| string| Yes - for SOL, COMBINE, SSALE, ITB, JA | Class-Code |Valid classification code (FAR, Section 5.207(g))
+naics |string |Yes - for COMBINE, SOL |NAICS Code| Valid NAICS Code
NAICS Reference
+officeid| String| Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account |20 characters
+offadd |string| No| Office Address (Not Used) |65535 characters
+subject| string| Yes| Subject| 255 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 Notice Types](#notice-types)
+awdnbr| string| Yes - for AWARD, ITB & JA | Award # |255 characters
+donbr |string |Yes - for JA| Delivery/Task Order Number |255 characters
+awdamt |string| Yes - for AWARD |Award Amount| 64 characters
linenbr| string |No| Award Line Item Number |255 characters
-awddate |date| Yes – Award
No – Rest| Award Date |YYYYMMDD
-stauth |string |Yes – JA
No – Rest |J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy| Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Value section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’
-respdate| date| Yes – Only Combined/Solicitation
No – Rest (Required for Sources Sought/Presol/Sale of Surplus/Special Notice when Required when 15 Days after Response is selected) |Response Date |YYYYMMDD
-**archdate** (update needed) | date| No| Archive Date| YYYYMMDD
-awardee| string| Yes – Only Award
No – Rest| Awardee |65535 characters
+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 SNOTE, SSALE, SRCSGT, PRESOL |Response Date |YYYYMMDD
+archdate | date| Yes| Archive Date| YYYYMMDD
+awardee| string| Yes – for AWARD | Awardee |65535 characters
awardee_duns| string |No |Awardee DUNS |9 digits with optional plus 4
-contact| string| Yes - Rest
No - Award & Special Notice| Contact Info| 65535 characters
-desc |string| Yes - Rest
No – Justfication & Award| Main Description| 65535 characters
+contact| string| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL| Contact Info| 65535 characters
+desc |string| Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE| Main Description| 65535 characters
link| GovernmentURL| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email| GovernmentEmail| Yes - Rest
No - Only Award| Government Email |128 characters
+email| GovernmentEmail| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL, SNOTE| Government Email |128 characters
links |DocumentLink []| No |Array Of links |
files |DocumentFile[]| No| Array of files |
-setaside| string| No| Set-Aside code | See Set Aside Section for valid codes
-popaddress| string| No| POP Address |65535 characters
-popzip| string |No |POP Zip |5 digits
-popcountry| string| Yes – For wards; No – For rest| POP Country| 32 characters
+setaside| string| No| [Refer Set-Aside Values](#set-aside-values) |
+popaddress| string| No| Place of Performace Addressress |65535 characters
+popzip| string |No |Place of Performace Zip |5 digits
+popcountry| string| Yes – For wards; No – For rest| Place of Performace Country| 32 characters
city| string| No |City |NA
state| string| No| State |NA
recovery_act |boolean| No| Recovery Act| True or False
-correction| boolean| No| Correction of previous notice for the following types: Award #, Delivery Order #) – Awards, J&A’s, Intent to Bundle Requirements (DoD-Funded), Limited Source Justification
This is used to modify/correct notice types that whose uniqueness is potentially determined by fields other than Solicitation # (i.e. Award #, Delivery Order #) |True or False
If correcting a previously submitted award notice, specify true and the system will lookup the notice by award number, delivery order number, and sol number if applicable.
+correction| boolean| No| Correction of previous notice for the following types: Award #, Delivery Order #) – Awards, J&A’s, Intent to Bundle Requirements (DoD-Funded), Limited Source Justification
This is used to modify/correct notice types where uniqueness is potentially determined by fields other than Solicitation # (i.e. Award #, Delivery Order #) |True or False
If correcting a previously submitted notice, specify True and the system will lookup the notice by award number, delivery order number, and sol number if applicable.
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url| string| Yes| Website Address|255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc| string| Yes |Description| 255 characters
+url| string| No| Website Address|255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc| string| No |Description| 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address| string| Yes |Email Address| 128 characters
-desc |string| Yes |Description |255 characters
+desc |string| No |Description |255 characters
DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string| Yes |External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc| string| Yes| Description/Title| 255 characters
+url |string| No |External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+desc| string| No| Description/Title| 255 characters
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
-filedata | base64binary | Yes | File Data | 100 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 100 MB
desc | string | No | Description | 255 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -1076,12 +1067,12 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
Date| Date| No |Posting Date |YYYYMMDD
solnbr |String |No| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype |String |No| [Refer Related Notices](#related-notices)
+ntype |String |No| [Refer Notice Types](#notice-types)
uploadtype| String| No | Upload Type| A for amendment, S for solicitation or any title for other; 255 characters
respdate |Date |No |Response Date| YYYYMMDD
links| DocumentLin k[]| Yes; Either Links or Files needs to be provided| Array Of links |
files |DocumentFile []| Yes; Either Links or Files needs to be provided| Array of files |
-officeid |String| No| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account| 20 characters
+officeid |String| No| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account| 20 characters
DocumentLink Complex Type Definition:
@@ -1119,49 +1110,49 @@ UnarchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No |[Refer Related Notices](#related-notices)
+ntype |string |No |[Refer Notice Types](#notice-types)
awdnbr |string| No| Award #| 255 characters
archdate |date| Yes| New Archive Date| YYYYMMDD
### Secure Document Package
(attachSecureDocumentPackagesToNotice)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Non-FBO Solicitation
(createNonFBOSolicitation)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Secure Document Packages
(attachSecureDocumentPackagesToNonFBOSolicitation)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Remove Secure Document Package
(removeSecureDocumentPackagesFromNonFBOSolicitation)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Non-FBO Solicitation Release
(releaseNonFBOSolicitation)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Un-Release-Non-FBO-Solicitation
(unreleaseNonFBOSolicitation)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Secure Technical Document Package
(createSecureDocumentPackage)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Add Files to Secure Document Package
(addFilesToSecureDocumentPackage)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Delete Files from Secure Document Package
(deleteFilesFromSecureDocumentPackage)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
### Delete Secure Document Package
(deleteSecureDocumentPackage)
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
## Methods Available
to All Office Location Users
@@ -1184,7 +1175,7 @@ IVLListRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| Yes| Solicitation #
-ntype |string |No |[Refer Related Notices](#related-notices)
+ntype |string |No |[Refer Notice Types](#notice-types)
IVLListResponse Complex Type Definition:
@@ -1208,7 +1199,7 @@ duns| string| DUNS #
cage_code |string| Cage Code
address |string |Address
bus_types| string| Business Types
-naics_codes| string |Naics Codes
+naics_codes| string |Naics Codes
NAICS Reference
### Authorized Parties List
(getAuthorizedPartyList)
@@ -1229,8 +1220,8 @@ AuthorizedPartyListRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| Yes |Solicitation #. Provide an empty string for this argument if using nonfbo_solnbr below
-ntype| string| No| V[Refer Related Notices](#related-notices)
-nonfbo_solbr| string| no| Non-fbo Solicitation #. Not supported for this method
+ntype| string| No| [Refer Notice Types](#notice-types)
+nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method
status| string |No |Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests.
AuthorizedPartyListResponse Complex Type Definition:
@@ -1273,8 +1264,8 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string |Yes| Solicitation #
-ntype |string |No| [Refer Related Notices](#related-notices)
-nonfbo_solbr |string| no| Non-fbo Solicitation #. Not supported for this method
+ntype |string |No| [Refer Notice Types](#notice-types)
+nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
@@ -1299,7 +1290,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name |Type |Required| Description
-----|-----|-----|----
solnbr |string |Yes| Solicitation #
-ntype| string| No| [Refer Related Notices](#related-notices)
+ntype| string| No| [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method
vendor| VendorData |Yes| Complex type defined below
@@ -1336,7 +1327,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string |Yes| Solicitation #
-ntype |string |No|[Refer Related Notices](#related-notices)
+ntype |string |No|[Refer Notice Types](#notice-types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
reason |string| Yes| rejection reason not used in this method
@@ -1363,7 +1354,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| Yes| Solicitation #
-ntype |string |No| [Refer Related Notices](#related-notices)
+ntype |string |No| [Refer Notice Types](#notice-types)
nonfbo_solbr |string |No |Non-fbo Solicitation #. Not supported for this method
vendor |VendorData| Yes| Complex type defined below
reason| string| Yes |Rejection Reason
@@ -1399,7 +1390,7 @@ ExplicitAccessRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| Yes| Solicitation #
-ntype |string |No |[Refer Related Notices](#related-notices)
+ntype |string |No |[Refer Notice Types](#notice-types)
nonfbo_solbr| string| No |Non-fbo Solicitation #. Not supported for this method.
Id |string |No |Not used in this method
vendor |VendorData| Yes| Complex type defined below
@@ -1437,12 +1428,12 @@ NoticeListRequest Complex Type Definition:
Element Name| Type| Required| Description
-----|-----|-----|-----
-notice_type |string| No (at least 1 field is required)| [Refer Related Notices](#related-notices) Note:Searches for awardsj&as, itb’s and fairopps will return both standalone notices AND base notices that contain one of these type
+notice_type |string| No (at least 1 field is required)| [Refer Notice Types](#notice-types) Note:Searches for award, j&a, itb and fairopps will return both standalone notices AND base notices that contain one of these type
solnbr |string |No (at least 1 field is required) |Solicitation #
awdnbr |string |No (at least 1 field is required)|Award #
posted_from |date| No (at least 1 field is required)| Posted From Date. YYYYMMDD.
-posted_to |date| |No (at least 1 field is required)| Posted To Date. YYYYMMDD
-documents_to_search |string| No(at least 1 field is required)| Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided.
+posted_to |date| No (at least 1 field is required)| Posted To Date. YYYYMMDD
+documents_to_search |string| No (at least 1 field is required)| Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided.
Response:
@@ -1521,7 +1512,7 @@ classcod| string| Class-Code
naics |string| NAICS Code
offadd |string |Office Address
subject |string |Subject
-solnbr| string |Sol #
+solnbr| string |Solicitation #
awdnbr| string| Award #
donbr |string |Delivery/Task Order Number
awdamt |string |Award Amount
@@ -1540,9 +1531,9 @@ link| GovernmentURL |Government Link
email| Government Email| Government Email
files |DocumentPack ageData[]| Array of package data if applicable
setaside |string |Set-Aside value
-popaddress |string |POP Address
-popzip |string| POP Zip
-popcountry| string| POP Country
+popaddress |string |Place of Performace Addressress
+popzip |string| Place of Performace Zip
+popcountry| string| Place of Performace Country
recovery_act |boolean |Recovery Act
correction| boolean |Correction of previous notice for the following types: Award #, Delivery Order #) – Awards, J&A’s, Intent to Bundle Requirements (DoD-Funded), Fair Opportunity / Limited Source Justification.
changes |NoticeData[] |This element will only be present on the base/original posting and will contain an array of changes (for any mods/awards/etc.). Each change uses the same complex type.
@@ -1656,7 +1647,7 @@ Please note that variances may exist between SOAP requests generated by differen
No - Rest | YYYYMMDD |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | - Award Details Section - Contract Award Date is required field
- Award Details Section - Contract Award Date provided should have 4 digit year
- Award Details Section - Contract Award Date provided is in an invalid format
-notice_type |Yes| Valid Options mentioned General Notice (submitNotice) section | 1. This required field should be validated | 1. Opportunity type is required
-zip| No| 5 digits| NA |NA
-classcod |No| Valid classification code (FAR, Section 5.207(g)) |1. This required field should be validated where applicable
2.If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
-naics |Yes - Combined Synopsis/Solicitation & Solicitation
No - Rest| Valid NAICS Code NAICS Reference |NA | - NAICS code is required
-offadd| No| 65535 characters| Not-Used| NA
-officeid |Yes |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-subject |Yes |255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| Yes - Rest
No - Only Special Notice| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. If this field is not given, then system throws an errors as shown on the right hand side
2. If duplicate solicitation number is given, then system throws an error
3. For an invalid solnbr and notice_type combination, the service throws an error| 1.Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Opportunity not found with given solicitation number and ntype
-ntype| No| [Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error |NTYPE value provided is not valid
-awdnbr| Yes – Award, ITB & JA
No – Rest| 255 characters| 1. This required field should be validated| 1. Award Details Section - Contract Award Number is a required field
-donbr| Yes – JA
No – Rest |255 characters |1. This is required field for JA |1. Award Details Section - Task/Delivery Order Number is required field
-awdamt |Yes – Award
No – Rest| 64 characters| 1. This required field should be validated |1. Award Details Section – Amount is a required field.
-linenbr|No | 255 characters| NA |NA
-awddate |Yes – Award
No – Rest |YYYYMMDD| 1. This field should meet the character limit/restrictions (Note: Date field allows current date and also any date in past/future)
2. This required field should be validated| 1. DATE field in unexpected format. Expects YYYYMMDD
2. Award Details Section - Contract Award Date is required field.
-stauth| Yes – JA
No – Rest | Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Values section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’ | Both foja & stauth values will be given under stauth in legacy | NA
-respdate|Yes – Only Combined/Solicitation
No – Rest (Required for Sources Sought/Presol/Sale of Surplus/Special Notice when Required when 15 Days after Response is selected)| YYYYMMDD | 1. No validation is performed on this field for all services except submitCombined. However, if this value is available, 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 2 errors (#2)
3. For submitCombined this field is required | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Inactive date provided is in the past
4. Response Date is required
-**archdate** (updated needed)| No| YYYYMMDD |1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restriction
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
-awardee |Yes – Only Award
No – Rest| 6553 characters| NA| NA
-awardee_duns| No |9 digits with optional plus 4| NA| NA
-contact | Yes - Rest
No - Award & Special Notice |65535 characters Default value = Primary Other types are: Secondary, Owner| 1. This required field should be validated |1. Primary Contact is Required
-desc| Yes - Rest
No – Justfication & Award |65535 characters| 1. This required field should be validated.| 1. Description is required
-link|No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA | NA
-email| Yes - Rest
No - Only Award| 128 characters| NA |NA
-links |No |Array of links |NA |NA
-files| No| Array of files| NA| NA
-setaside| No| See Set-Aside Values section for valid codes| NA |NA
-popaddress| No| 65535 characters| This is a free Text. No validation is performed on this field |
+date |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | 1. DATE field in unexpected format. Expects YYYYMMDD
+notice_type | 1. This field is required where applicable | 1. Opportunity type is required
+zip| NA |NA
+classcod |1. This field is required where applicable
2.If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
+naics |NA | NAICS code is required
+offadd| Not Used| NA
+officeid |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If user does not have access to an office but is trying to make a submission to that office, then the service throws an error
|1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
+subject | 1. This field is required where appicable |1. $.data.title: is missing but it is required
+solnbr| 1. This field is required where applicable
2. If submitting a notice with same solnbr number, then system throws an error
3. If solnbr is in invalid format, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
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. This field accepts only valid values listed. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
+awdnbr| 1. This field is required where applicable| 1. Award Details Section - Contract Award Number is a required field
+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. Award Details Section - Task/Delivery Order Number is required field
2. Award Details Section - Task/Delivery Order Number - Please enter a valid number
+awdamt| 1. This field is required where applicable
2. If an invalid integer values is given, then service throws an error |1. Award Details Section - Amount is a required field
2. Award Details Section - Please enter valid integer for Amount Field
+linenbr| NA |NA
+awddate | 1. This field should meet the character limit/restrictions (Note: Date field allows current date and also any date in past/future)
2. This field is required where applicable| 1. DATE field in unexpected format. Expects YYYYMMDD
2. Award Details Section - Contract Award Date is required field
3. Award Details Section - Contract Award Date provided is in an invalid format
+stauth| Both foja & stauth values will be given under stauth in legacy | NA
+respdate| 1. This field is required where applicable
2. This date cannot be in past; has to be in future. If the given date is in past, then system throws errors | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
4. One of Response date or Archive date is required
5. One of Response date or Archive date is required
+archdate| 1. This field is required where applicable. Note user may receive "Auto 30
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
3. One of Response date or Archive date is required
+awardee | NA| NA
+awardee_duns| NA| NA
+contact | 1. This field is required where applicable |1. Primary Contact is Required
+desc| 1. This field is required where applicable.| 1. Description is required
+link| NA | NA
+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
+links| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
+files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
+setaside| NA |NA
+popaddress| This is a free Text. No validation is performed on this field | NA
popzip |No |5 digits| NA| NA
popcountry| No| 1. Award Details Section - Country is a required field
-city |No |NA |NA| NA
-state |No |NA| NA| NA
-recovery_act| No| True or False| NA |NA
-correction| No| True or False
If correcting a previously submitted J&A notice, specify true and the system will lookup the j&a by award number and sol number if applicable. |If correction = true, system checks if an opportunity exists or not. If exists, then a new modified record will be posted of the same type and will be set as the latest. If No, then the request will be rejected.|
-
-#### submitPresol and submitSourcesSought
-
-Individual business rules per field are listed across each of the fields in below table.
-* Note: When none of the fields are given, then the service throws an error - $.data.title: is missing but it is required
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| No| YYYYMMDD |1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No |5 digits| NA| NA
-classcod| No | Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics |No| Valid NAICS Code NAICS Reference| NA| NA
-offadd| No |65535 characters |NA| NA
-officeid |Yes |20 characters | 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-subject |Yes |255 characters| 1. This required field should be validated| 1. $.data.title: is missing but it is required
-solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-respdate| No - However either Respdate or Archdate must be selected | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future
3. When giving future date, response date cannot exceed 5 years from the current date |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
-**archdate** (updated needed) |No - However either Respdate or Archdate must be selected |YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Inactive date provided is in the past.
-contact|Yes| 65535 characters
Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated| 1. Primary Contact is required
-desc |Yes | 65535 characters| 1. This required field should be validated |1. Description is required
-link| No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA |NA
-email | Yes | 128 characters| | NA
-links| No| Array of links| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-files| No| Array of files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-setaside| No| See Set-Aside Values section for valid codes |NA |NA
-popaddress| No| 65535 characters| This is a free Text. No validation is performed on this field |
-popzip| No| 5 digits| NA| NA
-popcountry |No| 32 characters| NA| NA
-recovery_act| No |True or False| NA| NA
-
-#### submitCombined
-
-Individual business rules per field are listed across each of the fields in below table.
-* Note: When none of the fields are given, then the service throws an error - $.data.title: is missing but it is required
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| No| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No |5 digits| NA| NA
-classcod |Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
-naics |Yes |Valid NAICS Code NAICS Reference| 1. This required field should be validated |1. NAICS code is required
-officeid |Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-offadd| No| 65535 characters| NA| NA
-subject |Yes| 255 characters| 1. This required field should be validated| 1. $.data.title: is missing but it is required
-solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-respdate| Yes |YYYYMMDD |1. This required field should be validated
2. This field should meet the character limit/restrictions
3. This date cannot be in past; has to be in future
4. When giving future date, response date cannot exceed 5 years from the current date.| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
4. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
-**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
-contact| Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated| 1. Primary Contact is Required
-desc| Yes | 65535 characters| 1. This required field should be validated| 1. Description is required
-link |No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
-email |Yes |128 characters |NA | NA
-links| No |Array of links| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-files |No |Array of files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-setaside| No| See Set-Aside Values section for valid codes| NA| NA
-popaddress| No| 65535 characters| This is a free Text. No validation is performed on this field |
-popzip| No| 5 digits| NA| NA
-popcountry| No| 32 characters |NA |NA
-recovery_act |No| True or False| NA| NA
-
-#### submitITB
-
-Individual business rules per field are listed across each of the fields in below table.
-* Note: When none of the fields are given, then the service throws an error - $.data.title: is missing but it is required
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| No| YYYYMMDD |1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip| No| 5 digits| NA| NA
-classcod |Yes | Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics |No |Valid NAICS Code NAICS Reference| NA| NA
-officeid| Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-offadd| No| 65535 characters| NA| NA
-subject |Yes| 255 characters| 1. This required field should be validated| 1. $.data.title: is missing but it is required
-solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
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| no| [Refer Related Notices](#related-notices) |1. When user tries to convert a notice to ITB and the solicitation number and ntype do not match the notice, then the service throws an error
2. This field accepts only valid values mentioned. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
-awdnbr| Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {} |1. This required field should be validated
2. This field accepts only valid characters as mentioned under character limit/restrictions column | 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
-donbr| No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) | NA| NA
-**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
-contact| Yes |65535 characters
65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated | 1. Primary Contact is Required
-desc| Yes | 65535 characters| 1. This required field should be validated |1. Description is required
-link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396) |NA |NA
-link |No | | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-files| No | | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-email| Yes| 128 characters| NA |
-recovery_act| No| True or False| NA| NA
-correction| No| True or False
If correcting a previously submitted itb notice, specify true and the system will lookup the itb by award number, delivery number and sol number if applicable| 1. When user tries to convert a notice to ITB and the solicitation number and ntype do not match the notice and correction = true, then the service throws an error
2. If correction = True and the system cannot return a single record for the same delivery number/ award number / sol-number or combination of all three, then the service throws an error
3. If correction = True and the system returns more than one record for the same delivery number/ award number / sol-number or combination of all three, then service throws an error| 1. Notice could not be found for correction
2. Notice could not be found for correction
3. Multiple Notices found. Please input more details
-
-#### submitMod
-
-Individual business rules per field are listed across each of the fields in below table.
-* Note: If none of the fields are given, then service throws an error – ntype provided is not valid.
-* Note: If ntype value is provided and then submitted, then service throws an error - Multiple Notices found. Please input more details
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| Yes - Only Award
No - Rest| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
-zip| No| 5 digits| NA| NA
-classcod |Yes – Solicitation/Combined/Sale of Surplus/ITB/Justification
No – Rest |Valid classification code (FAR, Section 5.207(g)) |1. This field is required and should be validated
2. If a wrong classification code is given, then service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics |Yes – Combined & Solicitation
No – Rest| Valid NAICS Code NAICS Reference |1. For combined, this field is required and should be validated| 1. NAICS code is required
-officeid| Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If contracting officer does not have access to an office but is trying to make modifications to an opportunity associated to that office, then the service throws an error
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-offadd| No |65535 characters| NA| NA
-subject |Yes| 255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1a. This required field if not given, service will throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Notice not found for correction
-ntype| Yes |[Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-respdate |Yes – for Combined/Solicitation
No – Rest (Special Notice/Sale of Surplus/Sources Sought/Presol must have either respdate or archdate)|YYYYMMDD |1. This required field is validated for combined type
2. No validation is performed on this field for rest of the types. However, if this value is available, this field should meet the character limit/restriction
3. This date cannot be in past; has to be in future| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
-**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
-contact| Yes – Rest
No – For Award/Special notice
|65535 characters Default value: Primary
Other types: Secondary, Owner |1. This required field should be validated| 1. Primary Contact is Required
-desc |Yes - Award/Justification
No - Rest| 65535 characters| 1. This required field should be validated |1. Description is required
-link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA |NA
-links |No |Collection |1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-files| No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-email |Yes - Rest
No - Only Award|128 characters| NA|NA
-setaside| No| See Set-Aside Values section for valid codes| NA| NA
-popaddress| No |65535 characters| NA| NA
-popzip |No |5 digit |NA | NA
-popcountry| No |32 characters| NA| NA
-recovery_act| No| True or False| NA| NA
-
-#### submitJA
-
-Individual business rules per field are listed across each of the fields in below table.
-* Note: If none of the fields are given, then service throws an error – $.data.title: is missing but it is required.
-* Note: If only subject is given, then service throws multiple errors:
- * Award Details Section - Task/Delivery Order Number is required field.
- * Contracting office is required
- * PSC code is required
- * Award Details Section - Contract Award Number is a required field.
- * This opportunity cannot be published. Authority is required
- * Primary Contact is required
- * Notice Id is required
-
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| No |YYYYMMDD |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No |5 digits| NA| NA
-classcod| Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics| No |Valid NAICS Code NAICS Reference| NA| NA
-offadd| No| 65535 characters| NA| NA
-officeid| Yes| 20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue
-subject |Yes| 255 characters |1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field if not given will throw an error
2. Duplicate solicitation number cannot be submitted
(Refer error #2) 3. If a space is given along with numbers in this field, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error. |1. Notice Id is required
2. Notice ID for the selected opportunity type already exits
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 |No |[Refer Related Notices](#related-notices)|1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
-stauth |Yes| Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Value section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’| 1. This required field should be validated
Note: Both foja & stauth values will be given under stauth in legacy |1. This opportunity cannot be published. Authority is required
-awdnbr |Yes| 255 characters| 1. This required field should be validated |1. Award Details Section - Contract Award Number is a required field
-modnbr| No |32 characters| NA| NA
-awddate |No – May change in future| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions| 1. DATE field in unexpected format. Expects YYYYMMDD
-awdamt| No| 64 characters| NA| NA
-**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
-contact| Yes | 65535 characters Default value: Primary
Other types: Secondary, Owner |1. This required field should be validated| 1. Primary Contact is Required
-desc| No| 65535 characters| NA |NA
-link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
-links |No | | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-files |No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-email |Yes | 128 characters| NA| NA
-recovery_act |No |True or False| NA |NA
-correction |No |True or False
If correcting a previously submitted J&A notice, specify true and the system will lookup the j&a by award number and sol number if applicable.| If correction = true, system checks if an opportunity exists or not. If exists, then a new modified record will be posted of the same type and will be set as the latest. If No, then the request will be rejected | NA
-donbr |Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( )|1. This field is required
2. In value provided for this field does not meet the character limit/restrictions mentioned, then service throws an error| 1. Award Details Section - Task/Delivery Order Number is required field
2. Award Details Section - Task/Delivery Order Number - Please enter a valid number
-
-#### submitAward
+city |NA| NA
+state | NA| NA
+recovery_act| NA |NA
+correction| 1. When user tries to convert a notice and the solicitation number/ntype do not match the notice and correction = true, then the service throws an error
2. If correction = True and the system cannot return a single record for the same delivery number/ award number / soliciation number or combination of all three, then the service throws an error
3. If correction = True and the system returns more than one record for the same delivery number/ award number / sol-number or combination of all three, then service throws an error| 1. Notice could not be found for correction
2. Multiple Notices found. Please input more details
-Individual business rules per field are listed across each of the fields in below table.
-* Note: If none of the fields are given, then service throws an error – ntype provided is not valid.
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| Yes |YYYYMMDD| 1. If this field is given, then this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No| 5 digits| NA| NA
-classcod| No| Valid classification code (FAR, Section 5.207(g))| 1. If a wrong classification code is given, then the service throws an error | 1. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics | No| Valid NAICS Code NAICS Reference| NA| NA
-offadd| No |65535 characters| NA| NA
-officeid |Yes |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-subject |Yes| 255 characters| 1. This required field should be validated |$.data.title: is missing but it is required
-solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Opportunity not found with given solicitation number and ntype
-ntype| No| [Refer Related Notices](#related-notices)| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
-awdnbr| Yes| Valid numbers| 1. This required field should be validated
2. If an invalid number is given (e.g with special characters), then service throws an error| 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
-awdamt| Yes| Valid integer values| 1. This required field should be validated
2. If an invalid integer values is given, then service throws an error |1. Award Details Section - Amount is a required field
2. Award Details Section - Please enter valid integer for Amount Field
-linenbr |No| 255 characters| NA| NA
-awddate |Yes| YYYYMMDD |1. This required field should be validated
2. If this field is given, then this field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. Award Details Section - Contract Award Date is required field
2. DATE field in unexpected format. Expects YYYYMMDD
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
-awardee| Yes| 65535 characters| 1. This required field should be validated |1. Award Details Section - Contractor Awarded Name is a required field
-awardee_duns |No| 9 digits with optional plus 4 |NA |NA
-contact| No| 65535 characters Default value: Primary
Other types: Secondary, Owner |1. This required field should be validated| 1. Primary Contact is Required
-desc| No| 65535 characters| NA| NA
-link| No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
-email| No | 128 characters| NA| NA
-links| No| |1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-files| No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-setaside| No| See Set-Aside Values section for valid codes| NA| NA
-recovery_act |No |True or False| NA| NA
-correction| No| True or False
If correcting a previously submitted award notice, specify true and the system will lookup the award by award number and sol number if applicable| If correction = true, system checks if an opportunity exists or not. If exists, then a new modified record will be posted of the same type and will be set as the latest. If No, then the request will be rejected |
#### submitDocumentsAndLinksToNotice
@@ -4322,124 +4121,43 @@ Individual business rules per field are listed across each of the fields in belo
* Note: When none of the fields are given the service throws an error - Links and/or Files are not complete
* Note: When links/files are given but none of the other fields are given, then service throws an error - Multiple Notices found. Please input more details
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| No | YYYYMMDD| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
-officeid| No |20 characters| 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. Officeid 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| No |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-ntype | No |[Refer Related Notices](#related-notices)| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
-uploadtype| No – link or file| A for amendment, S for solicitation or any title for other; 255 characters| NA| NA
-respdate| No (Special Notice/Sale of Surplus/Sources Sought/Presol must have either respdate or archdate) | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
-links| Yes; Either Links or Files needs to be provided | Array of files| 1.This field is not required but if url & description fields within the links and files are empty, then the service throws an error.
2. If a link with same name already exists on the notice, then the system throws an error.
3. If the Url is empty for a link, then the system throws an error.
4. If the description is missing for a link, then the system throws an error.| 1. Links and/or files are not complete
2. Resource with the same name already exists
3. Link Resource must have a link
4. Link Resource must have a description
-files | Yes; Either Links or Files needs to be provided | Array of files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error
2. If the filename is not provided for a file, then the system throws an error
3. If the filedata is empty for a file, then the system throws an error
4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error
5. If the file size exceeds 250MB, then the system throws an error
6. If a file with same name already exists on the notice, then the system throwns an error |1. Links and/or files are not complete
2. Attachment must have a name
3. Attachment must have content
4. The file type that you are trying to upload is not supported
5. The file type that you are trying to upload is not supported
6. Resource with the same name already exists
+date| Date field should meet the expected format |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|1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+ntype | 1. If field is not provided OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
+uploadtype| NA| NA
+respdate| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
+links| 1.This field is not required but if url & description fields within the links and files are empty, then the service throws an error.
2. If a link with same name already exists on the notice, then the system throws an error.
3. If the Url is empty for a link, then the system throws an error.
4. If the description is missing for a link, then the system throws an error.| 1. Links and/or files are not complete
2. Resource with the same name already exists
3. Link Resource must have a link
4. Link Resource must have a description
+files | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error
2. If the filename is not provided for a file, then the system throws an error
3. If the filedata is empty for a file, then the system throws an error
4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error
5. If the file size exceeds 250MB, then the system throws an error
6. If a file with same name already exists on the notice, then the system throwns an error |1. Links and/or files are not complete
2. Attachment must have a name
3. Attachment must have content
4. The file type that you are trying to upload is not supported
5. The file type that you are trying to upload is not supported
6. Resource with the same name already exists
-#### submitFairOpps
-This service is now deprecated. Instead, please use submitJA to perform the operation.
-
-#### submitForeignGovernment
-
-This service is now deprecated.
-
-#### submitSpecialNotice
-
-Individual business rules per field are listed across each of the fields in below table.
-* Note: When none of the fields are given, then the service throws an error - $.data.title: is missing but it is required
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| No| YYYYMMDD| 1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip| No| 5 digits| NA| NA
-classcod |No| Valid classification code (FAR, Section 5.207(g))| 1. This field does not take invalid codes |1. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics| No| Valid NAICS Code NAICS Reference| NA| NA
-offadd| No| 65535 characters| NA |NA
-officeid| Yes |20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-subject |Yes| 255 characters| 1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr| Yes |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}. Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-**archdate** (updated needed) |No |YYYYMMDD |1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
-contact| No| 65535 characters Default value: Primary
Other types: Secondary, Owner| NA| NA
-desc| Yes |65535 characters| 1. This required field should be validated| 1. Description is required
-link| No |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396) |NA| NA
-links| No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-files| No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-email| Yes| 128 characters| NA| NA
-recovery_act| No| True or False| NA| NA
-
-#### submitSolicitation
-
-Individual business rules per field are listed across each of the fields in below table.
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| No| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No |5 digits| NA| NA
-classcod |Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. Product Service Code is a required field
2. Classification Code provided did not match expected codes
-naics |Yes |Valid NAICS Code NAICS Reference| 1. This required field should be validated |1. NAICS code is required
-officeid |Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Invalid officeid provided
2. Insufficient privileges to create opportunity.
-offadd| No| 65535 characters| NA| NA
-subject |Yes| 255 characters| 1. This required field should be validated| 1. Title is a required field.
-solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice ID is a required field
2. Notice ID must be unique based on selected notice type
3. Notice ID max length is 128 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
-respdate| Yes |YYYYMMDD |1. This required field should be validated
2. This field should meet the character limit/restrictions
3. This date cannot be in past; has to be in future
4. When giving future date, response date cannot exceed 5 years from the current date.| 1. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. Response Date cannot be in the past
4. Response Date cannot exceed 5 years from current date
-**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. Inactive date provided is in the past
-desc| Yes | 65535 characters| 1. This required field should be validated| 1. Description is a required field
-link |No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
-email |Yes |128 characters |1. This field is required
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
-links| No |Array of links| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-files |No |Array of files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-setaside| No| See Set-Aside Values section for valid codes| NA| NA
-popaddress| No| 65535 characters| This is a free Text. No validation is performed on this field |
-popzip| No| 5 digits| NA| NA
-popcountry| No| 32 characters |NA |NA
-recovery_act |No| True or False| NA| NA
-
-#### submitSaleofSurplus
-
-Individual business rules per field are listed across each of the fields in below table.
-* Note: When none of the fields are given, then the service throws an error - $.data.title: is missing but it is required
-
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
-date| No| YYYYMMDD |1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
-zip| No| 5 digits| NA| NA
-classcod| Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
-naics |No |Valid NAICS Code NAICS Reference| NA| NA
-offadd| No| 65535 characters| NA| NA
-officeid| Yes |20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue
-subject| Yes |255 characters |1. This required field should be validated |1. $.data.title: is missing but it is required
-solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-**archdate** (updated needed)| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
-contact |Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated |1. Primary Contact is Required
-desc| Yes| 65535 characters |1. This required field should be validated |1. Description is required
-link| No| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)| NA| NA
-links| No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error| 1. Links and/or files are not complete
-files| No| | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
-email| Yes| 128 characters| NA| NA
-recovery_act| No| True or False| NA| NA
#### deleteNoticeOrDocumentPackage
Individual business rules per field are listed across each of the fields in below table.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| Yes; Solicitation Number or Award Number is required| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-awdnbr| Yes; Solicitation Number or Award Number is required| 255 characters| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required
-ntype|No| [Refer Related Notices](#related-notices)| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-deletetype| no| Valid values: “notice” to delete the notice, “attachment” to delete attachments and links from the notice| 1. If an invalid deletetype is provided, then service throws an error | Delete type provided is not “notice” or “attachment”
-deletemethod| no| Valid Values: “all” to delete all versions or “latest” to delete latest version |1. If an invalid deletemethod is provided, then service throws an error | Delete method provided is not “latest” or “all”
+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 a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+awdnbr| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required
+ntype| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+deletetype| 1. If an invalid deletetype is provided, then service throws an error | Delete type provided is not “notice” or “attachment”
+deletemethod| 1. If an invalid deletemethod is provided, then service throws an error | Delete method provided is not “latest” or “all”
#### archiveNotice
Individual business rules per field are listed across each of the fields in below table.
* Note: : If a user tries to archive a notice that is already archived, then the service throws an error - Opportunity already archived
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| No| YYYYMMDD| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
-solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-officeid |No| 20 characters| Officeid must be associated with user account |NA
-ntype| No| [Refer Related Notices](#related-notices)| 1. If an invalid ntype is provided, then service throws an error
2. If a valid ntype but a wrong ntype is not provided for the solnbrthen service throws an error | 1. NTYPE value provided is not valid 2. Notice not found for correction
-archdate| Yes | YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
+date| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
+solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+officeid | Office ID must be associated with user account |NA
+ntype| 1. If an invalid ntype is provided, then service throws an error
2. If a valid ntype but a wrong ntype is not provided for the solnbrthen service throws an error | 1. NTYPE value provided is not valid 2. Notice not found for correction
+archdate| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
#### unarchiveNotice
@@ -4447,85 +4165,85 @@ Individual business rules per field are listed across each of the fields in belo
* Note: : If a user tries to unarchive a notice that is already unarchived, then the service throws an error - Opportunity is not archived.
* Note: If a user tries to unarchive an active notice, then the service throws an error - Opportunity is active
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
-officeid| No |20 characters| Officeid must be associated with user account |NA
-ntype| No|[Refer Related Notices](#related-notices) | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-awdnbr |Yes - Award/ITB/Justification; No - Rest| 255 characters| NA| NA
-archdate| Yes| YYYYMMDD| 1. This required field should be validated
2. If this value is available, this field should meet the character limit/restrictions
3. 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. $.reason: null found, string expected. Unable to process request. Please try again
+solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
+officeid| Office ID must be associated with user account |NA
+ntype| 1. If field is not provided OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+awdnbr | NA| NA
+archdate| 1. This field is required where applicable
2. If this value is available, this field should meet the character limit/restrictions
3. 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. $.reason: null found, string expected. Unable to process request. Please try again
-#### cancelNotice (NEEDS FIX)
+#### cancelNotice
Individual business rules per field are listed across each of the fields in below table.
* Note: : If user tries to cancel already cancelled opportunity, service throws an error - This opportunity cannot be cancelled. This opportunity is already cancelled. Unable to process request. Please try again.
* Note: - When user tries to cancel a notice without giving any input, then the service throws an error ‘Unable to process request. Please try again’
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-date| No| YYYYMMDD |Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
-officeid| No |20 characters| Officeid must be associated with user account |NA
-subject| No| 255 characters| NA| NA
-solnbr| Yes |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If valid solnbr is given with a different ntype, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple Notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-ntype |No |[Refer Related Notices](#related-notices)| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
-awdnbr| Yes - Award/ITB/Justification; No - Rest| 255 characters| NA| NA
-archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be cancelled
-contact|Yes| 65535 characters Default value: Primary
Other types: Secondary, Owner| NA| NA
-desc| Yes| 65535 characters| 1. This required field should be validated | 1. Unable to process request. Please try again
+date| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
+officeid| Office ID must be associated with user account |NA
+subject| NA| NA
+solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If valid solnbr is given with a different ntype, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple Notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+ntype | 1. If field is not provided OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
+awdnbr| NA| NA
+archdate| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be cancelled
+contact| NA| NA
+desc| 1. This field is required where applicable | 1. Unable to process request. Please try again
#### getNoticeData
Individual business rules per field are listed across each of the fields in below table.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-notice_id |No (at least 1 field is required)| Unique ID found from getList call or ID’s for changes found in getNoticeData call| Notice_id is required| notice_id from getList is required
-Get_changes| No (at least 1 field is required) |True or False
Pass in true to get the full notice history with all changes| NA| NA
-get_changes_from_date| No (at least 1 field is required)| If maintaining a sync of changes, can specify a date so that only changes that have occurred since provided date will be returned| Date field should meet the expected format.| DATE field in unexpected format. Expects YYYYMMDD
-get_file_data |No (at least 1 field is required) |True or False
Pass in true and the method will return any file content stored in Contract Opportunities (attachment data will be retuned as Base64Encoding Format). If false, the meta details/links will still be provided |NA |NA
+notice_id | notice_id is required| 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_file_data |NA |NA
#### getList
Individual business rules per field are listed across each of the fields in below table.
* Note: Although none of the individual elements are mandatory, at least one filter should be given to perform the operation. If no filters are entered, then system throws an error - Insufficient Search Criteria.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-notice_type |No (at least 1 field is required) |[Refer Related Notices](#related-notices) | Notice Type is not recognized
Expects one of the following: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB
-solnbr| No (at least 1 field is required)| Solicitation #| NA| NA
-awdnbr| No (at least 1 field is required)| Award #| NA| NA
-posted_from |No (at least 1 field is required)|Posted From Date. YYYYMMDD| Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
-posted_to| No (at least 1 field is required) |Posted To Date. YYYYMMDD |Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
-documents_to_search| No (at least 1 field is required) |Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided| NA| NA
+notice_type |
Valid Notice Type must be provided | Notice Type is not recognized
+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
+documents_to_search| NA| NA
#### getFileData
Individual business rules per field are listed across each of the fields in below table.
* Note: If a wrong combination of file_id and notice_id is given, then the service throws a success message without any data.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-file_id |Yes| Unique ID of a file found from getNoticeData call (i.e. file_id element) |1. This required field should be validated
2. If an invalid file Id is provided, then the system throws an error.| 1. file_id is required
2. File Id not found. Please enter a valid Id.
+file_id |1. This field is required where applicable
2. If an invalid file Id is provided, then the system throws an error.| 1. file_id is required
2. File Id not found. Please enter a valid Id.
#### getIVLListResponse
Individual business rules per field are listed across each of the fields in below table.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| Yes | Solicitation Number| 1. If an incorrect solicitation number and ntype combination is given, the service throws an error
2a. If this required field if not given, service throws an error
2b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination |1. Notice not found
2a. Notice not found
2b. Multiple Notices found. Please input more details
-ntype| No| [Refer Related Notices](#related-notices) | NA |NA
+solnbr| 1. If an incorrect solicitation number and ntype combination is given, the service throws an error
2a. If this required field if not given, service throws an error
2b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination |1. Notice not found
2a. Notice not found
2b. Multiple Notices found. Please input more details
+ntype| NA |NA
#### getAuthorizedPartyList
Individual business rules per field are listed across each of the fields in below table.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| No| [Refer Related Notices](#related-notices)| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
-status| No| Valid Options: approved, pending, rejected, “empty value”
If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests |1. If the status value entered doesn’t match the valid values , then the system throws an error| 1. Status value is invalid
+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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
+ntype| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
+status| 1. If the status value entered doesn’t match the valid values , then the system throws an error| 1. Status value is invalid
#### approveExplicitAccessRequestByID
@@ -4533,12 +4251,12 @@ Individual business rules per field are listed across each of the fields in belo
ID can be obtained through getAuthorizedPartyList
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr |Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error |1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype |No| [Refer Related Notices](#related-notices) |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
-id| Yes| | 1. If the request Id is not provided, then the system throws an error
2. If the request Id provided is already approved, then the service throws an error
3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error
4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error |1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information
2. Request with Request ID: #id already approved
3. You have request that is tied to different solicitation number
4. You have request that is tied to the same solicitation number but different notice type
+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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error |1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
+ntype |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
+id| 1. If the request Id is not provided, then the system throws an error
2. If the request Id provided is already approved, then the service throws an error
3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error
4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error |1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information
2. Request with Request ID: #id already approved
3. You have request that is tied to different solicitation number
4. You have request that is tied to the same solicitation number but different notice type
#### approveExplicitAccessRequestByVendorData
@@ -4547,46 +4265,46 @@ Individual business rules per field are listed across each of the fields in belo
Vendor can be obtained through getAuthorizedPartyList
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr |Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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.
-ntype |No| [Refer Related Notices](#related-notices) |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
-nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
-vendor |Yes| Vendor Data |1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error.
2. If no match is found in the system for the vendor data provided, then the system throws an error.
3. If the Explicit Access request found for the vendor and solnum is already approved, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown.
2. No contact match on vendor data provided.
3. Request with Request ID: #id already approved.
+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.
+ntype |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
+vendor |1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error.
2. If no match is found in the system for the vendor data provided, then the system throws an error.
3. If the Explicit Access request found for the vendor and solnum is already approved, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown.
2. No contact match on vendor data provided.
3. Request with Request ID: #id already approved.
#### addAuthorizedParty
Individual business rules per field are listed across each of the fields in below table.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }|1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| No| [Refer Related Notices](#related-notices) |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-nonfbo_solbr |No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
-vendor| Yes| Vendor Data| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
+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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
+ntype| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
+vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
#### rejectExplicitAccessRequestByID
Individual business rules per field are listed across each of the fields in below table.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| Yes | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error| 1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| No| [Refer Related Notices](#related-notices) | 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
-id| Yes || 1. If the request Id is not provided, then the system throws an error
2. If the request Id provided is already rejected, then the service throws an error
3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error
4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error| 1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information
2. Request with Request ID: #id already rejected
3. You have request that is tied to different solicitation number
4. You have request that is tied to the same solicitation number but different notice type
-reason| Yes| Rejection Reason| 1. This is a required field. If no value is provided, then the system throws an error.| 1. A reason must be provided with an explicit access rejection.
+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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error| 1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
+ntype| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
+id| 1. If the request Id is not provided, then the system throws an error
2. If the request Id provided is already rejected, then the service throws an error
3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error
4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error| 1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information
2. Request with Request ID: #id already rejected
3. You have request that is tied to different solicitation number
4. You have request that is tied to the same solicitation number but different notice type
+reason| 1. This is a required field. If no value is provided, then the system throws an error.| 1. A reason must be provided with an explicit access rejection.
#### rejectExplicitAccessRequestByVendorData
Individual business rules per field are listed across each of the fields in below table.
-Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
+Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr |No | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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.
-ntype |No| [Refer Related Notices](#related-notices) |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
-nonfbo_solbr | No| | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
-vendor| Yes| Vendor Data| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
-reason| Yes| Rejection Reason| 1. This is a required field. If no value is provided, then the system throws an error.| 1. A reason must be provided with an explicit access rejection.
+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.
+ntype |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
+vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
+reason| 1. This is a required field. If no value is provided, then the system throws an error.| 1. A reason must be provided with an explicit access rejection.
@@ -4605,47 +4323,54 @@ reason| Yes| Rejection Reason| 1. This is a required field. If no value is provi
-#### rejectExplicitAccessRequestByVendorData
-Details will be added in future.
+
+
+#### submitFairOpps
+
+This service is now deprecated. Instead, please use submitJA to perform the operation.
+
+#### submitForeignGovernment
+
+This service is now deprecated.
#### setBidModuleOptions
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### getBidModuleResponses
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### createSecureDocumentPackage
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### addFilesToSecureDocumentPackage
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### deleteFilesFromSecureDocumentPackage
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### deleteSecureDocumentPackage
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### releaseSecureDocumentPackage
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### attachSecureDocumentPackagesToNotice
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### createNonFBOSolicitation
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### attachSecureDocumentPackagesToNonFBOSolicitation
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### removeSecureDocumentPackagesFromNonFBOSolicitation
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### releaseNonFBOSolicitation
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
#### unreleaseNonFBOSolicitation
-Service is now deprecated. Hence no longer available.
+Service is now deprecated.
@@ -4671,7 +4396,8 @@ Date | Version | Description
8/19/2019 | v0.5 | SUBMITPRESOL/SOURCESSOUGHT, SUBMITCOMBINED, SUBMITAWARD, SUBMITSALEOFSURPLUS, SUBMITJA, SUBMITITB, SUBMITSPECIANOTICE, SUBMITMOD, ARCHIVENOTICE, UNARCHIVENOTICE, CANCELNOTICE, SUBMITDOCUMENTSANDLINKS, GETLIST, GETNOTICEDATA, GETFILEDATA, DELETENOTICE parameters updated
User Account Section Updated
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/25/2019 | v0.71| Updated Business Rules
+10/28/2019 | v0.8| Removed redundant Required and Character Limit columns from Business Rules section. Consolidated Business Rules section for all Submit methods. Updated submitMod and submitNotice methods to align with implemenation.
+
From 7d3f1e1f827458e0f7776b611a92568a08fe1bac Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Mon, 28 Oct 2019 11:26:03 -0400
Subject: [PATCH 056/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 137 +++++++++++++++--------------
1 file changed, 69 insertions(+), 68 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index be0d070c3..2367f54c9 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -2127,76 +2127,77 @@ Please note that variances may exist between SOAP requests generated by differen
Response Sample – Success
From eb07bece2788a2c03da5d1718d10894bc60ea140 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Mon, 28 Oct 2019 11:26:05 -0400
Subject: [PATCH 057/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 2f3c74559..e43e21a81 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -93,7 +93,7 @@ In order to download secure attachment, user should have at least one of the bel
* Edit Draft Attachment
* Delete Draft Attachment
-### Lookup/Meta Data
+### Lookup/Meta-Data
#### Notice Types
@@ -143,7 +143,7 @@ VSS | Veteran-Owned Small Business Sole source (specific to Department of Vetera
-#### Stauth valid values
+#### Stauth Valid Values
Below table captures stauth values to use while making requests as needed.
Code | Description
From d8eaee369a9962b4ae7a2182ccf0e5b325bfd7fc Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Mon, 28 Oct 2019 11:33:03 -0400
Subject: [PATCH 058/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index e43e21a81..212874ef7 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -2777,7 +2777,7 @@ placeOfPerformance.
country.name | string | | No | No | Pop Country name
placeOfPerformance.zip | string | | No | No | Pop Country zip
archive | JSON | NA | NA | NA |
archive.type | string | auto15, auto30, autocustom | No | Yes | Archive Type
-archive.date | date | | No (Yes for Presol, Sources Sought, Special Notice, Sale of Surplus; Either Archive Date or Response Date must be provided) | Yes (if archive.type=autocustom OR Yes for Presol, Sources Sought, Special Notice, Sale of Surplus; Either Archive Date or Response Date must be provided ) | Archive Date
+archive.date | date | | No | Yes (if archive.type=
autocustom) | Archive Date
permissions | JSON | NA | NA | NA |
permissions.ivl | JSON | NA | NA | NA |
permissions.ivl.create | boolean | | No | No | permissions.ivl.create
@@ -2787,7 +2787,7 @@ permissions.ivl.delete | boolean | Not In Use | Not In Use | Not In Use | Not In
solicitation | JSON | NA | NA | NA |
solicitation.setAside | string | See Set-Aside values table | No | No | setAside
solicitation.deadlines | JSON | NA | NA | NA |
-solicitation.
deadlines.response | date | YYYY-MM-DDTHH:MM:SS-05:00 | No (Yes for Presol, Sources Sought, Special Notice, Sale of Surplus; Either Archive Date or Response Date must be provided) | 1) Yes (for type=k,o)
2) Yes (when archive.type=auto1)
3) Yes for Presol, Sources Sought, Special Notice, Sale of Surplus; Either Archive Date or Response Date must be provided | Deadline Date
+solicitation.
deadlines.response | date | YYYY-MM-DDTHH:MM:SS-05:00 | No | 1) Yes (for type=k,o)
2) Yes (when archive.type=auto1)| Deadline Date
solicitation.deadlines.
responseresponseTz | string | | No | No | Time Zone for
Solicitation Deadline Date
award | JSON | NA | NA | NA |
award.date | date | YYYY-MM-DD |No | Yes only for type= a | Award Date
From 083fbcc0774f14167b5d1ba053fbe61d8f2c8bf8 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Mon, 28 Oct 2019 11:55:51 -0400
Subject: [PATCH 059/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 32 +++++++++++++++---------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 2367f54c9..73640cb68 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -4078,7 +4078,7 @@ Note:
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
date |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | 1. DATE field in unexpected format. Expects YYYYMMDD
notice_type | 1. This field is required where applicable | 1. Opportunity type is required
zip| NA |NA
@@ -4123,7 +4123,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: When links/files are given but none of the other fields are given, then service throws an error - Multiple Notices found. Please input more details
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
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|1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
@@ -4140,7 +4140,7 @@ files | 1. This field is not required but if url & description fields within the
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
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 a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
awdnbr| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required
ntype| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
@@ -4153,7 +4153,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: : If a user tries to archive a notice that is already archived, then the service throws an error - Opportunity already archived
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
solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
officeid | Office ID must be associated with user account |NA
@@ -4167,7 +4167,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: If a user tries to unarchive an active notice, then the service throws an error - Opportunity is active
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
officeid| Office ID must be associated with user account |NA
ntype| 1. If field is not provided OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
@@ -4181,7 +4181,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: - When user tries to cancel a notice without giving any input, then the service throws an error ‘Unable to process request. Please try again’
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
officeid| Office ID must be associated with user account |NA
subject| NA| NA
@@ -4197,7 +4197,7 @@ desc| 1. This field is required where applicable | 1. Unable to process request.
Individual business rules per field are listed across each of the fields in below table.
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
Get_changes| NA| NA
get_changes_from_date| Date field should meet the expected format.| DATE field in unexpected format. Expects YYYYMMDD
@@ -4209,7 +4209,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: Although none of the individual elements are mandatory, at least one filter should be given to perform the operation. If no filters are entered, then system throws an error - Insufficient Search Criteria.
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
solnbr| NA| NA
awdnbr| NA| NA
@@ -4223,7 +4223,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: If a wrong combination of file_id and notice_id is given, then the service throws a success message without any data.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
file_id |1. This field is required where applicable
2. If an invalid file Id is provided, then the system throws an error.| 1. file_id is required
2. File Id not found. Please enter a valid Id.
#### getIVLListResponse
@@ -4231,7 +4231,7 @@ file_id |1. This field is required where applicable
2. If an invalid file I
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
solnbr| 1. If an incorrect solicitation number and ntype combination is given, the service throws an error
2a. If this required field if not given, service throws an error
2b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination |1. Notice not found
2a. Notice not found
2b. Multiple Notices found. Please input more details
ntype| NA |NA
@@ -4240,7 +4240,7 @@ ntype| NA |NA
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
ntype| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
@@ -4253,7 +4253,7 @@ Individual business rules per field are listed across each of the fields in belo
ID can be obtained through getAuthorizedPartyList
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error |1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
ntype |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
@@ -4267,7 +4267,7 @@ Vendor can be obtained through getAuthorizedPartyList
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
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.
ntype |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
@@ -4278,7 +4278,7 @@ vendor |1. If all the elements in the Vendor Data complex definition are not pro
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
ntype| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
@@ -4289,7 +4289,7 @@ vendor| 1. If all the elements in the Vendor Data complex definition are not pr
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error| 1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
ntype| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
@@ -4300,7 +4300,7 @@ reason| 1. This is a required field. If no value is provided, then the system t
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | ------- | ------- | --------
+------ | ------- | -------
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.
ntype |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
From e4ac9bf5fc0291d13321cd170c3efe2ff82c1000 Mon Sep 17 00:00:00 2001
From: Prashant Pillai Update Attachment Request - Change Resource Order (Move resource to the bottom.(Applicable to both files and links))
+Update Attachment Request - Change Resource Order (Move resource to the bottom of the list. Applicable to both files and links)
{
From 4452656594884e8689cd9599ff6d7ab544bcdd29 Mon Sep 17 00:00:00 2001
From: Prashant Pillai
{
- "data": {
- "solicitationNumber": "ITB_Test1",
- "title": "TST_T1",
- "type": "i",
- "classificationCode": "13",
- "organizationId": "100120624",
- "naics": [
- {
- "type": "primary",
- "code": [
- "111150"
- ]
- }
- ],
- "pointOfContact": [
- {
- "additionalInfo": {
- "content": ""
+ "data": {
+ "type": "i",
+ "award": {
+ "date": "2222-02-22",
+ "number": "ContractAwardNumber123-_(){}",
+ "deliveryOrderNumber": "TaskOrderNumber1234-_()"
},
- "email": "",
- "fax": "",
- "fullName": "GSA",
- "phone": "",
- "title": "",
- "type": "primary"
- }
- ],
- "placeOfPerformance": {
- "city": {
- "code": "",
- "name": ""
- },
- "country": {
- "code": "",
- "name": ""
- },
- "state": {
- "code": "",
- "name": ""
- },
- "streetAddress": "",
- "streetAddress2": "",
- "zip": ""
+ "naics": [
+ {
+ "code": [
+ "111160"
+ ],
+ "type": "primary"
+ }
+ ],
+ "title": "Create Intent To Bundle Requirements notice",
+ "archive": {
+ "date": null,
+ "type": "auto30"
+ },
+ "permissions": {
+ "IVL": {
+ "read": false,
+ "create": false,
+ "delete": false,
+ "update": false
+ }
+ },
+ "solicitation": {
+ "deadlines": {
+ "response": null,
+ "responseTz": null
+ }
+ },
+ "organizationId": "100186612",
+ "pointOfContact": [
+ {
+ "fax": "1234567890",
+ "type": "primary",
+ "email": "test.email2@gmail.com",
+ "phone": "1234567890",
+ "title": null,
+ "fullName": "Test User"
+ },
+ {
+ "fax": "4512367890",
+ "type": "secondary",
+ "email": "test.email@gmail.com",
+ "phone": "1234567890",
+ "title": null,
+ "fullName": "Test User 2"
+ }
+ ],
+ "classificationCode": "1005",
+ "solicitationNumber": "Test-ITB-123",
+ "additionalReporting": [
+ "recovery_act"
+ ]
},
- "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": ""
- }
+ "related": {},
+ "description": [
+ {
+ "body": "Test Description"
}
- },
- "justificationAuthority": {
- "modificationNumber": "",
- "authority": "dictionary"
- },
- },
- "permissions": {
- "IVL": {
- "create": false,
- "delete": false,
- "read": false,
- "update": false
- }
- },
- "solicitation": {
- "setAside": "SBA",
- "deadlines": {
- "response": "2019-08-08T11:20:20-05:00"
- }
- },
- "archive": {
- "type": "autocustom",
- "date": "2019-09-09"
- },
- "flags": [
- {
- "code": "",
- "isSelected": true
- }
- ],
- "link": {
- "additionalInfo": {
- "content": ""
- },
- "href": ""
- },
- "additionalReporting": [
- "none"
]
- },
- "description": [
- {
- "body": "Description"
- }
- ]
}
+
{
- "data": {
- "solicitationNumber": "Test1combine1",
- "title": "TST_T1",
- "type": "k",
- "classificationCode": "13",
- "organizationId": "100000136",
- "archive": {
- "type": "autocustom",
- "date": "2019-09-09"
- },
- "naics": [
- {
- "type": "primary",
- "code": [
- "111150"
- ]
- }
- ],
- "pointOfContact": [
- {
- "additionalInfo": {
- "content": ""
- },
- "email": "",
- "fax": "",
- "fullName": "gsa",
- "phone": "",
- "title": "",
- "type": "primary"
- }
- ],
- "permissions": {
- "IVL": {
- "create": false,
- "delete": false,
- "read": false,
- "update": false
- }
- },
- "solicitation": {
- "setAside": "",
- "deadlines": {
- "responseTz": "YYYY-MM-DDTHH:MM:SS-05:00",
- "response": "2019-11-11T11:12:00-05:00"
- }
- },
- "additionalReporting": [
- "none"
- ]
- },
- "description": [
- {
- "body": "Description_TEST "
- }
- ]
-}
+ "data": {
+ "solicitationNumber": "Test1combine1",
+ "title": "TST_T1",
+ "type": "k",
+ "classificationCode": "13",
+ "organizationId": "100186612",
+ "archive": {
+ "type": "autocustom",
+ "date": "2022-09-09"
+ },
+ "naics": [
+ {
+ "type": "primary",
+ "code": [
+ "111150"
+ ]
+ }
+ ],
+ "pointOfContact": [
+ {
+ "additionalInfo": {
+ "content": ""
+ },
+ "email": "testemail@gsa.gov",
+ "fax": "",
+ "fullName": "test user",
+ "phone": "",
+ "title": "",
+ "type": "primary"
+ }
+ ],
+ "permissions": {
+ "IVL": {
+ "create": false,
+ "delete": false,
+ "read": false,
+ "update": false
+ }
+ },
+ "solicitation": {
+ "setAside": "",
+ "deadlines": {
+ "responseTz": "YYYY-MM-DDTHH:MM:SS-05:00",
+ "response": "2022-11-11T11:12:00-05:00"
+ }
+ },
+ "additionalReporting": [
+ "none"
+ ]
+ },
+ "description": [
+ {
+ "body": "Description_TEST "
+ }
+ ]
+ }
{
-
"_embedded": {
"authorizedPartyList": [
{
@@ -2570,16 +2520,16 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Response – Add Authorized Party
+Request – Add Authorized Party
{
"lname":"test",
"fname":"test123",
-"email":"reitestuser.de@gmail.com",
-"contractorName":"",
-"duns":"608999520",
-"cageCode":""
+"email":"testuser.de@gmail.com",
+"contractorName":"test contractor",
+"duns":"608999570",
+"cageCode":"4CHY"
}
{
- "data": {
- "solicitationNumber": "Test1",
- "title": "TST_T1",
- "type": "p",
- "classificationCode": "13",
- "organizationId": "100000136",
+ "data":
+ {
+ "type": "",
+ "solicitationNumber": "",
+ "title": "",
+ "organizationId": "",
"organizationLocationId": "",
- "naics": [{
+ "classificationCode": "",
+ "naics": [
+ {
"type": "primary",
- "code": ["111150"]
+ "code": [""]
}],
- "pointOfContact": [{
- "additionalInfo": {
- "content": ""
- },
- "email": "",
- "fax": "",
- "fullName": "Veera",
- "phone": "",
- "title": "",
- "type": "primary"
+ "flags": [
+ {
+ "code": "",
+ "isSelected": true
+ }],
+ "pointOfContact": [
+ {
+ "type": "primary",
+ "title": "",
+ "fullName": "",
+ "email": "",
+ "phone": "",
+ "fax": "",
+ "additionalInfo":
+ {
+ "content": ""
+ }
}],
- "placeOfPerformance": {
- "city": {
+ "placeOfPerformance":
+ {
+ "streetAddress": "",
+ "streetAddress2": "",
+ "city":
+ {
+ "code": "",
+ "name": ""
+ },
+ "country":
+ {
+ "code": "",
+ "name": ""
+ },
+ "state":
+ {
+ "code": "",
+ "name": ""
+ },
+ "zip": ""
+ },
+ "archive":
+ {
+ "type": "autocustom",
+ "date": "2019-09-09"
+ },
+ "permissions":
+ {
+ "IVL":
+ {
+ "create": false,
+ "delete": false,
+ "read": false,
+ "update": false
+ }
+ },
+ "solicitation":
+ {
+ "setAside": "SBA",
+ "deadlines":
+ {
+ "response": "2019-08-08"
+ }
+ },
+ "award":
+ {
+ "date": "",
+ "number": "",
+ "deliveryOrderNumber": "",
+ "amount": "",
+ "lineItemNumber": "",
+ "awardee":
+ {
+ "manual": false,
+ "name": "",
+ "duns": "",
+ "location":
+ {
+ "streetAddress": "",
+ "streetAddress2": "",
+ "city":
+ {
"code": "",
"name": ""
- },
- "country": {
+ },
+ "state":
+ {
"code": "",
"name": ""
- },
- "state": {
+ },
+ "zip": "",
+ "country":
+ {
"code": "",
"name": ""
- },
- "streetAddress": "",
- "streetAddress2": "",
- "zip": ""
- },
- "award": {
- "date": "",
- "number": "",
- "deliveryOrderNumber": "",
- "amount": "number",
- "lineItemNumber": "",
- "awardee": {
- "manual": false,
- "name": "",
- "duns": "",
- "location": {
- "streetAddress": "",
- "streetAddress2": "",
- "city": {
- "code": "",
- "name": ""
- },
- "state": {
- "code": "",
- "name": ""
- },
- "zip": "",
- "country": {
- "code": "",
- "name": ""
- }
- }
- },
- "justificationAuthority": {
- "modificationNumber": "",
- "authority": "dictionary"
- },
- "fairOpportunity": {
- "authority": ""
- }
- },
- "permissions": {
- "IVL": {
- "create": false,
- "delete": false,
- "read": false,
- "update": false
+ }
}
- },
- "solicitation": {
- "setAside": "SBA",
- "deadlines": {
- "response": "2019-08-08"
}
- },
- "archive": {
- "type": "autocustom",
- "date": "2019-09-09"
- },
- "flags": [{
- "code": "",
- "isSelected": true
- }],
- "link": {
- "additionalInfo": {
- "content": ""
+ },
+ "justificationAuthority":
+ {
+ "modificationNumber": "",
+ "authority": "dictionary"
+ },
+ "link":
+ {
+ "additionalInfo":
+ {
+ "content": ""
},
"href": ""
+ },
+ "additionalReporting": ["none"]
},
- "additionalReporting": [
- "none"
- ]
- },
- "description": [{
- "body": ""
- }],
- "resources": [{
- "attType": "link",
-
- "link": "http://beta.sam.gov",
-
- "description": "test beta sam link",
-
- "packageAccessLevel": null
- },
- {
- "attType": "link",
-
- "link": "https://faaco.faa.gov/index.cfm/attachment/download/84723",
-
- "description": "test attachment pdf link",
-
- "packageAccessLevel": null
-
- }],
-
- "postedDate": "20190423",
-
- "archived": false
-}
+ "description": [
+ {
+ "body": ""
+ }],
+ "related":
+ {
+ "opportunityId": ""
+ }
+ }
streetAddess | string | | | No | No | Pop Address
placeOfPerformance.
streetAddess2 | string | | | No | No | Pop Address2
@@ -2879,61 +2831,60 @@ 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 |
-archive.type | string | | auto15, auto30, autocustom | No | Yes | Archive Type
-archive.date | date | | | No | Yes (if archive.type=
autocustom) | Archive Date
+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 (if 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 |
-permissions.ivl.create | boolean | | | No | No | permissions.ivl.create
-permissions.ivl.read | boolean | | | No | No | permissions.ivl.read
-permissions.ivl.update | boolean | | Not In Use | Not In Use | Not In Use | Not In Use
-permissions.ivl.delete | boolean | | Not In Use | Not In Use | Not In Use | Not In Use
+permissions.ivl | JSON | NA | NA | NA | NA |Government determined use and visibility of the 'Inerested Vendor's List' where users outside the notice can indicate a desire to submit a proposal. This list in way binds either party
+permissions.ivl.create | boolean | | | No | No | IVL create permission
+permissions.ivl.read | boolean | | | No | No | IVL read permission
+permissions.ivl.update | boolean | | Not In Use | Not In Use | Not In Use | IVL update permission
+permissions.ivl.delete | boolean | | Not In Use | Not In Use | Not In Use | IVL delete permission
solicitation | JSON |NA | NA | NA | NA |
-solicitation.setAside | string | |See Set-Aside values table | No | No | setAside
-solicitation.deadlines | JSON | NA | NA | NA | NA |
+solicitation.setAside | string | |See Set-Aside values table | 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)
2) Yes (when archive.type=
auto1) | Deadline Date
solicitation.deadlines.
responseresponseTz |string | | | No | No | Time Zone for
Solicitation Deadline Date
-award | JSON | NA | NA | NA | NA |
+award | JSON | NA | NA | NA | NA | This section is mainly used for providing award information that is required for 'Award Notice' and 'Justification' opportunity types
award.date | date | |YYYY-MM-DD |No | Yes only for type= a | Award Date
award.number | string | 255 characters | |No | Yes only for type= i, j, a | Award Number
-award.deliverOrderNumber | string | 255 characters| | No | No | Award Deliver Order Number
+award.deliverOrderNumber | string | 255 characters| | No | No | Award Delivery Order Number
award.amount | number |64 digits | | No | No | Award Amount
-award.lineitemNumber | string |255 characters | | No | No | Award Line item Number
-award.awardee | JSON | NA| NA | NA | NA |
-award.awardee.manual | string | |boolean | Yes | Yes | Awardee
+award.lineitemNumber | string |255 characters | | No | No | Contract Line item Number
+award.awardee | JSON | NA| NA | NA | NA |Awardee details
award.awardee.name | string | 255 characters | | No | No | Awardee Name
award.awardee.duns | string | 9 digits | | No | No | Awardee Duns
-award.awardee.location | JSON | | NA | NA | NA |
+award.awardee.location | JSON |NA | NA | NA | NA | Awardee Location details
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 | string | | | No | No | Awardee City
+award.awardee.location.
city | JSON |NA |NA |NA | NA | Awardee City details
award.awardee.location.
city.code | string | | | No | No | Awardee City code
award.awardee.location.
city.name | string | | | No | No | Awardee City name
-award.awardee.location.
state | JSON | NA | NA | NA | NA |
+award.awardee.location.
state | JSON | NA | NA | NA | NA | Awardee State details
award.awardee.location.
state.code | string | | | No | No | Awardee State code
award.awardee.location.
state.name | string | | | No | No | Awardee State name
-award.awardee.location.
country | JSON | | NA | NA | NA |
+award.awardee.location.
country | JSON | NA| NA | NA | NA |Awardee Country details
award.awardee.location.
country.code | string | | | No | No | Awardee Country code
award.awardee.location.
country.name | string | | | No | No | Awardee Country Name
-award.awardee.location.
zip | string | | | No | No | Awardee Country Zip
+award.awardee.location.
zip | string | | | No | No | Awardee Country Zip code
justificationAuthority | JSON |NA |NA | NA | NA |
justificationAuthority.
modificationNumber | string | 32 characters| | No | No | Justification Authority Modification Number
justificationAuthority.
authority | string| | | No | No | Justification Authority
link | JSON | NA |NA | NA | NA |
-link.href | string | | | No | No | Url for the notice on SAM.gov
-link.additionalInfo | JSON | NA |NA | NA | NA |
-link.additionalInfo.content | string | | | No | No | Additional info
-additionalReporting | string | |none/
auto_recovery | No | Yes |
+link.href | string | | | No | No | Url for the notice on SAM.gov
+link.additionalInfo | JSON | NA |NA | NA | NA | Any additional information on the opportunity
+link.additionalInfo.content | string | | | No | No | Additional information details
+additionalReporting | string | |none/
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
description | JSON | NA | NA | NA | NA |
-description.body | string | 65535 characters| | No | Yes | Description of notice
+description.body | string | 65535 characters| | No | Yes | Description of the notice
+related | JSON | NA | NA | NA | NA | Related Notice information
+related.opportunityId | string | 32 characters| | No | No | Opportunity Id of the related notice
resources | JSON |NA | NA | NA | NA |
resources.attType | string | |link, file | No |No| Type of attachment, either link or file
resources.content | byte |250MB | | No|No | File content in base64 format
resources.link | string | 255 characters | |No|No | Resource link URL
resources.packageAccessLevel | string | | public,private(default public) | No | No| Type of access to file or link
resources.resourceName | string | 255 characters | | No|No | Name of file
-postedDate| date| | |No|No| Posted Date
-archived| boolean| | true or false |No|No| Archived Status
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 59264bb24..fc5b7e9b4 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -159,21 +159,20 @@ Award Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits
+zip | string | No | Zip Code | 5 digits.This field has been deprecated
classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code NAICS Reference
-offadd | string | No | Office Address | 65535 characters
+offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
officeid | string | Yes | Office id of the office where an opportunity is being submitted | 20 characters
subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
-awdnbr | string | Yes | Award Number | 255 characters
-awdnbr | open text, label: Agency assigned number for control tracking and identification.
Please use ONLY alphanumeric and - _ ( ) { } characters [no spaces]. | Yes | Award Number | 255 characters
+awdnbr | string | Yes | Award Number | 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
awdamt | string | Yes | Award Amount | 64 digits
-linenbr | string | No | Line Number | 255 characters
+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 | Yes | Awardee | 65535 characters
+awardee | string | Yes | Awardee | 255 characters
awardee_duns | string | No | Awardee DUNS | 9 digits with optional plus 4
contact | string | No | Contact Info | 255 characters
desc | string | No | Description | 65535 characters
@@ -212,9 +211,9 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
-explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
-export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
+desc | string | No | Description | 65535 characters. This field has been deprecated
+explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true"|
+export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation |
### Delete Notice/ Document Package
(deleteNoticeOrDocumentPackage)
@@ -238,7 +237,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr | string | Yes, if Non-Award | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation, "AWARD" - for Award
-awdnbr | string | Yes, if Award| Award # | 255 characters
+awdnbr | string | Yes, if Award| Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
deletetype | string | No | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod | string | No | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
@@ -264,7 +263,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
+ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation, "AWARD" - for Award
archdate | date | No | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
officeid | string | No | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
@@ -289,12 +288,12 @@ CancelNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-offadd | string | No | Office Address | 65535 characters
+offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
officeid | String | No | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
subject | string | No | Subject | 256 characters
solnbr |string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
-awdnbr | string | No | Award # |255 characters
+ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation, "AWARD" - for Award
+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
desc | string | Yes | Cancellation Description | 65535 characters
@@ -322,11 +321,11 @@ Presol Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits
+zip | string | No | Zip Code | 5 digits. This field has been deprecated
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code NAICS Reference
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
+offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject | string | Yes| Subject | 256 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | No | Response Date | YYYYMMDD
@@ -370,9 +369,9 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
-explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
-export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
+desc | string | No | Description | 65535 characters. This field has been deprecated
+explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true"|
+export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation |
### Combined/Synopsis
(submitCombined)
@@ -393,11 +392,11 @@ Combined Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits
+zip | string | No | Zip Code | 5 digits. This field has been deprecated
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | Yes | NAICS Code | Valid NAICS Code NAICS Reference
+naics | string | Yes | NAICS Code | Valid NAICS Code
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
+offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | Yes | Response Date | YYYYMMDD
@@ -441,9 +440,9 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
-explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
-export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
+desc | string | No | Description | 65535 characters. This field has been deprecated
+explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true"|
+export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation |
### Modification/Amendment
(submitMod)
@@ -464,11 +463,11 @@ Mod Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits
+zip | string | No | Zip Code | 5 digits. This field has been deprecated
classcod | string | Yes – For combined type, presol type, Sale of surplus, No – For rest | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes – For combined type, No – For rest | NAICS Code | Valid NAICS Code NAICS Reference
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | string | no | Office Address | 65535 characters
+offadd | string | no | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject | string | no | Subject | 256 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype | string | Yes | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation
@@ -513,9 +512,9 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
-explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
-export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
+desc | string | No | Description | 65535 characters. This field has been deprecated
+explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true"|
+export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation |
### Justification and Authorization
(J&A) Notice (submitJA)
@@ -536,16 +535,16 @@ JA Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | Date | No | Posting Date | YYYYMMDD
-zip | String | No | Zip Code | 5 digits
-classcod | String | Yes | Class-Code | Valid classification code
-naics | String | No | NAICS Code | Valid NAICS Code NAICS Reference
-offadd | String | No | Office Address | 65535 characters
+zip | String | No | Zip Code | 5 digits. This field has been deprecated
+classcod | String | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
+naics | String | No | NAICS Code | Valid NAICS Code NAICS Reference
+offadd | String | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
officeid | String | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
subject | String | Yes | Subject | 256 characters
solnbr | String | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}.
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required
ntype | string | No | Base Notice Type | Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation
stauth | String | Yes | Stat. Authority – Both foja & stauth values will be given under stauth in legacy | Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in section 4.4
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’
-awdnbr | String | Yes | Award Number | 255 characters
+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. This field has been deprecated for JA notice type | 64 digits
awddate | Date | No – May change in future | Award Date | YYYYMMDD
@@ -587,7 +586,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
+desc | string | No | Description | 65535 characters. This field has been deprecated.
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -610,11 +609,11 @@ SourcesSought Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits
+zip | string | No | Zip Code | 5 digits. This field has been deprecated
classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | No | NAICS Code | Valid NAICS Code
+naics | string | No | NAICS Code | Valid NAICS Code NAICS Reference
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
+offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | No | Response Date | YYYYMMDD
@@ -658,7 +657,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
+desc | string | No | Description | 65535 characters. This field has been deprecated
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -685,11 +684,11 @@ SpecialNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | Date | No | Posting Date | YYYYMMDD
-zip | String | No | Zip Code | 5 digits
+zip | String | No | Zip Code | 5 digits. This field has been deprecated
classcod | String | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | String | No | NAICS Code | Valid NAICS Code NAICS Reference
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | String | No | Office Address | 65535 characters
+offadd | String | No | Office Address |65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject | String | Yes | Subject | 256 characters
solnbr | String | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
archdate | Date | No | Archive Date | YYYYMMDD
@@ -728,7 +727,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
+desc | string | No | Description | 65535 characters. This field has been deprecated
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -751,11 +750,11 @@ SaleOfSurplus Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date| No| Posting Date| YYYYMMDD
-zip| string| No| Zip Code| 5 digits
+zip| string| No| Zip Code| 5 digits. This field has been deprecated
classcod| string| Yes |Class-Code| Valid classification code (FAR, Section 5.207(g))
-naics| string| No| NAICS Code| Valid NAICS Code NAICS Reference
+naics| string| No| NAICS Code| Valid NAICS Code NAICS Reference
officeid |string |Yes| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd| string| No |Office Address |65535 characters
+offadd| string| No |Office Address |65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject| string| Yes| Subject |256 characters
solnbr| string |Yes |Sol #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
archdate| date| No| Archive Date| YYYYMMDD
@@ -817,11 +816,11 @@ Solicitation Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits
+zip | string | No | Zip Code | 5 digits. This field has been deprecated
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes | NAICS Code | Valid NAICS Code NAICS Reference
officeid | string | Yes | Office id of the office where an opportunity is being submitted. Officeid must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
+offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Sol # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate | date | Yes | Response Date | YYYYMMDD
@@ -865,9 +864,9 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
-explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
-export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
+desc | string | No | Description | 65535 characters. This field has been deprecated
+explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true"|
+export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation |
### Intent to Bundle Requirements
(DoD- Funded) (submitITB)
@@ -888,15 +887,15 @@ ITB Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date |Date |No |Posting Date |YYYYMMDD
-zip |String| No| Zip Code| 5 digits
+zip |String| No| Zip Code| 5 digits. This field has been deprecated
classcod| String| Yes| Class-Code| Valid classification code (FAR, Section 5.207(g))
-naics| String| No| NAICS Code| Valid NAICS Code
+naics| String| No| NAICS Code| Valid NAICS Code NAICS Reference
officeid| String| Yes| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account| 20 characters
-offadd| String |No| Office Address| 65535 characters
+offadd| String |No| Office Address| 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject| String| Yes| Subject |256 characters
solnbr |String |Yes| Sol # |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype |string |No| Base Notice Type| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation
-awdnbr| String |Yes |Award Number| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
+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
@@ -971,18 +970,18 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date| date| No |Posting Date| YYYYMMDD
notice_type |string |Yes| Notice type |Valid options outlined above
-zip |string |No |Zip Code| 5 digits
+zip |string |No |Zip Code| 5 digits. This field has been deprecated
classcod| string| No| Class-Code |Valid classification code (FAR, Section 5.207(g))
naics |string |No |NAICS Code| Valid NAICS Code NAICS Reference
officeid| String| No| Office id of the office where an opportunity is being submitted. Officeid must be associated with user account |20 characters
-offadd |string| No| Office Address |65535 characters
+offadd |string| No| Office Address |65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
subject| string| Yes| Subject| 256 characters
solnbr| string| Yes – For presol, combined, itb, ja, award, special, document, surplus
No – for rest| Sol # |128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
ntype |string |no |Base Notice Type |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
-awdnbr| string| Yes – For Award & JA, ITB
No – For rest| Award # |255 characters
-donbr |string |Yes – For JA
No – For rest| Delivery/Task Order Number |255 characters
+awdnbr| string| Yes – For Award & JA, ITB
No – For rest| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
+donbr |string |Yes – For JA
No – For rest| Delivery/Task Order Number |255 characters from the set: a-z A-Z 0-9 - _ ( )
awdamt |string| Yes – For Award
No – For rest |Award Amount| 64 digits
-linenbr| string |No| Award Line Item Number |255 characters
+linenbr| string |No| Award Line Item Number |255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
awddate |date| Yes – for award; No – for rest| Award Date |YYYYMMDD
stauth |string |Yes – for JA; No – for test |J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy| Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Value section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’
modnbr |string |No |J&A and FairOpp Contract Modification Number| 32 digits
@@ -1030,9 +1029,9 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
-desc | string | No | Description | 65535 characters
-explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
-export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
+desc | string | No | Description | 65535 characters. This field has been deprecated.
+explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true"|
+export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation |
### Document Packages
(submitDocumentsAndLinksToNotice)
@@ -1097,8 +1096,8 @@ UnarchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No |Base Notice Type |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation
-awdnbr |string| No| Award #| 255 characters
+ntype |string |No |Base Notice Type |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation, "AWARD" - for Award
+awdnbr |string| No| Award #| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
archdate |date| Yes| New Archive Date| YYYYMMDD
### Secure Document Package
(attachSecureDocumentPackagesToNotice)
@@ -1423,7 +1422,7 @@ Element Name| Type| Required| Description | Character Limit / Restrictions
-----|-----|-----|-----|-----
notice_type |string| No| Valid Values: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL. Note:Searches for awardsj&as, itb’s and fairopps will return both standalone notices AND base notices that contain one of these type |
solnbr |string |No |Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-awdnbr |string |No |Award # | 255 characters
+awdnbr |string |No |Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
posted_from |date| No| Posted From Date. YYYYMMDD. |
posted_to |date| |No Posted To Date. YYYYMMDD |
documents_to_search |string| No| Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided. |
@@ -4075,18 +4074,18 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
------ | ------- | ------- | ------- | --------
date | No | YYYYMMDD |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | 1. DATE field in unexpected format. Expects YYYYMMDD
Notice_type |Yes| Valid Options mentioned General Notice (submitNotice) section | 1. This required field should be validated | 1. Opportunity type is required
-zip| No| 5 digits| NA |NA
+zip| No| 5 digits. This field has been deprecated| NA |NA
classcod |No| Valid classification code (FAR, Section 5.207(g)) |1. This required field should be validated where applicable
2.If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
naics |No| Valid NAICS Code NAICS Reference |NA | NA
-offadd| No| 65535 characters| NA| NA
+offadd| No| 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA| NA
officeid |No |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes – for all; NA – for submitDocumentAndLinks |256 characters| 1. This required field should be validated |1. title: is missing but it is required
solnbr| Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. If this field is not given, then system throws an errors as shown on the right hand side
2. If duplicate solicitation number is given, then system throws an error
3. For an invalid solnbr and notice_type combination, the service throws an error| 1.Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Opportunity not found with given solicitation number and ntype
ntype| no| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error |NTYPE value provided is not valid
-awdnbr| Yes – For Award, ITB & JA; No – For rest| 255 characters| 1. This required field should be validated| 1. Award Details Section - Contract Award Number is a required field
-donbr| Yes – For JA; No – For rest |255 characters |1. This is required field for JA |1. Award Details Section - Task/Delivery Order Number is required field
+awdnbr| Yes – For Award, ITB & JA; No – For rest| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated| 1. Award Details Section - Contract Award Number is a required field
+donbr| Yes – For JA; No – For rest |255 characters from the set: a-z A-Z 0-9 - _ ( ) |1. This is required field for JA |1. Award Details Section - Task/Delivery Order Number is required field
awdamt |Yes – For Award; No – For rest| 64 characters| 1. This required field should be validated |1. Award Details Section – Amount is a required field.
-linenbr| No| 255 characters| NA |NA
+linenbr| No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| NA |NA
awddate |Yes – For award; No – for rest |YYYYMMDD| 1. This field should meet the character limit/restrictions (Note: Date field allows current date and also any date in past/future)
2. This required field should be validated| 1. DATE field in unexpected format. Expects YYYYMMDD
2. Award Details Section - Contract Award Date is required field.
stauth| Yes – For JA
No – for rest | Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Values section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’ | Both foja & stauth values will be given under stauth in legacy | NA
respdate| Yes – For SubmitCombined No- For rest| YYYYMMDD | 1. No validation is performed on this field for all services except submitCombined. However, if this value is available, 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 2 errors (#2)
3. For submitCombined this field is required | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Inactive date provided is in the past
4. Response Date is required
@@ -4116,10 +4115,10 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD |1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No |5 digits| NA| NA
+zip |No |5 digits. This field has been deprecated| NA| NA
classcod| Yes – For submitpresol
No - SourcesSought | Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
naics |No| Valid NAICS Code NAICS Reference| NA| NA
-offadd| No |65535 characters |NA| NA
+offadd| No |65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy |NA| NA
officeid |Yes |20 characters | 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes |256 characters| 1. This required field should be validated| 1. title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
@@ -4145,11 +4144,11 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No |5 digits| NA| NA
+zip |No |5 digits. This field has been deprecated| NA| NA
classcod |Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
naics |Yes |Valid NAICS Code NAICS Reference| 1. This required field should be validated |1. NAICS code is required
officeid |Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-offadd| No| 65535 characters| NA| NA
+offadd| No| 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA| NA
subject |Yes| 256 characters| 1. This required field should be validated| 1. title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
respdate| Yes |YYYYMMDD |1. This required field should be validated
2. This field should meet the character limit/restrictions
3. This date cannot be in past; has to be in future
4. When giving future date, response date cannot exceed 5 years from the current date.| 1. This opportunity cannot be published. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. This opportunity cannot be published. Response date provided is in the past
4. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
@@ -4174,15 +4173,15 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD |1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip| No| 5 digits| NA| NA
+zip| No| 5 digits. This field has been deprecated| NA| NA
classcod |Yes | Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
naics |No |Valid NAICS Code NAICS Reference| NA| NA
officeid| Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-offadd| No| 65535 characters| NA| NA
+offadd| No| 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA| NA
subject |Yes| 256 characters| 1. This required field should be validated| 1. title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
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| no| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation |1. When user tries to convert a notice to ITB and the solicitation number and ntype do not match the notice, then the service throws an error
2. This field accepts only valid values mentioned. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
-awdnbr| Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {} |1. This required field should be validated
2. This field accepts only valid characters as mentioned under character limit/restrictions column | 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
+awdnbr| Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1. This required field should be validated
2. This field accepts only valid characters as mentioned under character limit/restrictions column | 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
donbr| No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) | NA| NA
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
contact| Yes |255 characters
255 characters Default value: Primary
Other types: Secondary, Owner| 1. This required field should be validated | 1. Primary Contact is Required
@@ -4203,11 +4202,11 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
-zip| No| 5 digits| NA| NA
+zip| No| 5 digits. This field has been deprecated| NA| NA
classcod |Yes – For combined type, presol type, Sale of surplus
No – For test |Valid classification code (FAR, Section 5.207(g)) |1. This field is required and should be validated
2. If a wrong classification code is given, then service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
naics |Yes – For combined type
No – For rest| Valid NAICS Code NAICS Reference |1. For combined, this field is required and should be validated| 1. NAICS code is required
officeid| Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If contracting officer does not have access to an office but is trying to make modifications to an opportunity associated to that office, then the service throws an error
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-offadd| No |65535 characters| NA| NA
+offadd| No |65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA| NA
subject |Yes| 256 characters| 1. This required field should be validated |1. title: is missing but it is required
solnbr| Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1a. This required field if not given, service will throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Notice not found for correction
ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
@@ -4242,19 +4241,19 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No |YYYYMMDD |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No |5 digits| NA| NA
+zip |No |5 digits. This field has been deprecated| NA| NA
classcod| Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
naics| No – this may change in future |Valid NAICS Code NAICS Reference| NA| NA
-offadd| No| 65535 characters| NA| NA
+offadd| No| 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA| NA
officeid| Yes| 20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue
subject |Yes| 256 characters |1. This required field should be validated |1. title: is missing but it is required
solnbr| Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field if not given will throw an error
2. Duplicate solicitation number cannot be submitted
(Refer error #2) 3. If a space is given along with numbers in this field, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error. |1. Notice Id is required
2. Notice ID for the selected opportunity type already exits
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 |No |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, "SOL" - for Solicitation|1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
stauth |Yes| Valid values: 1, 2, 3, 4, 5, brand, far1, far2, far3, far4, far5, far6, far7
Description of each of these stauth values is captured in Stauth Value section
Foja values are: Valid values: 'Urgency’, ‘Only One Source (except brand name)’, ‘Follow-on Delivery Order Following Competitive Initial Order’, ‘Minimum Guarantee’, ‘Other Statutory Authority’| 1. This required field should be validated
Note: Both foja & stauth values will be given under stauth in legacy |1. This opportunity cannot be published. Authority is required
-awdnbr |Yes| 255 characters| 1. This required field should be validated |1. Award Details Section - Contract Award Number is a required field
+awdnbr |Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated |1. Award Details Section - Contract Award Number is a required field
modnbr| No |32 characters| NA| NA
awddate |No – May change in future| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions| 1. DATE field in unexpected format. Expects YYYYMMDD
-awdamt| No| 64 characters| NA| NA
+awdamt| No| 64 digits| NA| NA
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
contact| Yes | 255 characters Default value: Primary
Other types: Secondary, Owner |1. This required field should be validated| 1. Primary Contact is Required
desc| No| 65535 characters| NA |NA
@@ -4274,17 +4273,17 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No |YYYYMMDD| 1. If this field is given, then this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No| 5 digits| NA| NA
+zip |No| 5 digits. This field has been deprecated| NA| NA
classcod| No| Valid classification code (FAR, Section 5.207(g))| 1. If a wrong classification code is given, then the service throws an error | 1. This opportunity cannot be published. Classification Code provided did not match expected codes
naics | No| Valid NAICS Code NAICS Reference| NA| NA
-offadd| No |65535 characters| NA| NA
+offadd| No |65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA| NA
officeid |Yes |20 characters |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes| 256 characters| 1. This required field should be validated | 1. title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error
3. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
3. Opportunity not found with given solicitation number and ntype
ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation| 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
-awdnbr| Yes| Valid numbers| 1. This required field should be validated
2. If an invalid number is given (e.g with special characters), then service throws an error| 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
-awdamt| Yes| Valid integer values| 1. This required field should be validated
2. If an invalid integer values is given, then service throws an error |1. Award Details Section - Amount is a required field
2. Award Details Section - Please enter valid integer for Amount Field
-linenbr |No| 255 characters| NA| NA
+awdnbr| Yes| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If an invalid number is given (e.g with special characters), then service throws an error| 1. Award Details Section - Contract Award Number is a required field
2. Award Details Section - Contract Award Number - Please enter a valid number
+awdamt| Yes| 64 digits| 1. This required field should be validated
2. If an invalid integer values is given, then service throws an error |1. Award Details Section - Amount is a required field
2. Award Details Section - Please enter valid integer for Amount Field
+linenbr |No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| NA| NA
awddate |Yes| YYYYMMDD |1. This required field should be validated
2. If this field is given, then this field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. Award Details Section - Contract Award Date is required field
2. DATE field in unexpected format. Expects YYYYMMDD
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
awardee| Yes| 65535 characters| 1. This required field should be validated |1. Award Details Section - Contractor Awarded Name is a required field
@@ -4333,10 +4332,10 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD| 1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip| No| 5 digits| NA| NA
+zip| No| 5 digits. This field has been deprecated| NA| NA
classcod |No| Valid classification code (FAR, Section 5.207(g))| 1. This field does not take invalid codes |1. This opportunity cannot be published. Classification Code provided did not match expected codes
naics| No| Valid NAICS Code NAICS Reference| NA| NA
-offadd| No| 65535 characters| NA |NA
+offadd| No| 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA |NA
officeid| Yes |20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject |Yes| 256 characters| 1. This required field should be validated |1. title: is missing but it is required
solnbr| No |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}. Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required| 1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
@@ -4356,11 +4355,11 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD| 1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future |1. DATE field in unexpected format. Expects YYYYMMDD
-zip |No |5 digits| NA| NA
+zip |No |5 digits. This field has been deprecated| NA| NA
classcod |Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error | 1. Product Service Code is a required field
2. Classification Code provided did not match expected codes
naics |Yes |Valid NAICS Code NAICS Reference| 1. This required field should be validated |1. NAICS code is required
officeid |Yes| 20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account |1. Invalid officeid provided
2. Insufficient privileges to create opportunity.
-offadd| No| 65535 characters| NA| NA
+offadd| No| 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA| NA
subject |Yes| 256 characters| 1. This required field should be validated| 1. title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated
2. If submitting a notice with same solnbr number, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Notice ID is a required field
2. Notice ID must be unique based on selected notice type
3. Notice ID max length is 128 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
respdate| Yes |YYYYMMDD |1. This required field should be validated
2. This field should meet the character limit/restrictions
3. This date cannot be in past; has to be in future
4. When giving future date, response date cannot exceed 5 years from the current date.| 1. Response date is required
2. DATE field in unexpected format. Expects YYYYMMDD
3. Response Date cannot be in the past
4. Response Date cannot exceed 5 years from current date
@@ -4385,10 +4384,10 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
date| No| YYYYMMDD |1. This field should meet the character limit/restrictions Note: Date field allows current date and also any date in past/future| 1. DATE field in unexpected format. Expects YYYYMMDD
-zip| No| 5 digits| NA| NA
+zip| No| 5 digits. This field has been deprecated| NA| NA
classcod| Yes| Valid classification code (FAR, Section 5.207(g))| 1. This required field should be validated
2. If a wrong classification code is given, then the service throws an error |1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes
naics |No |Valid NAICS Code NAICS Reference| NA| NA
-offadd| No| 65535 characters| NA| NA
+offadd| No| 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy| NA| NA
officeid| Yes |20 characters| 1. This field is required
2. If an invalid officeid is given, then service throws an error
3. 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
4. Officeid must be associated with user account| 1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue
subject| Yes |256 characters |1. This required field should be validated |1. title: is missing but it is required
solnbr |Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
Note for statutory authority FAR 6.302- 1(c) - Brand name, this is required |1. This required field should be validated
2. If a space is given along with numbers in this field, then service throws an error |1. Notice Id is required
2. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
@@ -4408,7 +4407,7 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
solnbr| Yes if non-award| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1. This required field should be validated. 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 a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-awdnbr| Yes if award| 255 characters| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required for Award Notice
+awdnbr| Yes if award| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required for Award Notice
ntype|No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation, "AWARD" - for Award | 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
deletetype| no| Valid values: “notice” to delete the notice, “attachment” to delete attachments and links from the notice| 1. If an invalid deletetype is provided, then service throws an error | Delete type provided is not “notice” or “attachment”
deletemethod| no| Valid Values: “all” to delete all versions or “latest” to delete latest version |1. If an invalid deletemethod is provided, then service throws an error | Delete method provided is not “latest” or “all”
@@ -4423,7 +4422,7 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
date| No| YYYYMMDD| Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
solnbr| Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
officeid |No| 20 characters| Officeid must be associated with user account |NA
-ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If an invalid ntype is provided, then service throws an error
2. If a valid ntype but a wrong ntype is not provided for the solnbrthen service throws an error | 1. NTYPE value provided is not valid 2. Notice not found for correction
+ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation, "AWARD" - for Award | 1. If an invalid ntype is provided, then service throws an error
2. If a valid ntype but a wrong ntype is not provided for the solnbrthen service throws an error | 1. NTYPE value provided is not valid 2. Notice not found for correction
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
#### unarchiveNotice
@@ -4436,8 +4435,8 @@ Element Name | Required | Character Limit / Restrictions | Business Rules | Erro
------ | ------- | ------- | ------- | --------
solnbr| Yes| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
officeid| No |20 characters| Officeid must be associated with user account |NA
-ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-awdnbr |No| 255 characters| NA| NA
+ntype| No| Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation, "AWARD" - for Award | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+awdnbr |No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| NA| NA
archdate| Yes| YYYYMMDD| 1. This required field should be validated
2. If this value is available, this field should meet the character limit/restrictions
3. 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. $.reason: null found, string expected. Unable to process request. Please try again
#### cancelNotice
@@ -4452,8 +4451,8 @@ date| No| YYYYMMDD |Date field should meet the expected format |DATE field in un
officeid| No |20 characters| Officeid must be associated with user account |NA
subject| No| 256 characters| NA| NA
solnbr| Yes |128 characters from the set: a-z A-Z 0-9 - _ ( ) { } |1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If valid solnbr is given with a different ntype, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple Notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-ntype |No |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
-awdnbr| No| 255 characters| NA| NA
+ntype |No |Valid values: "PRESOL" - for Presolicitation, "COMBINE" - for Combined Synopsis/Solicitation, "SRCSGT" - for Sources Sought, "SSALE" - for Sale of Surplus Property, "SNOTE" - for Special Notice, “JA” – For Justification, “ITB” – for Intent to Bundle Requirements (DoD- Funded), "SOL" - for Solicitation, "AWARD" - for Award | 1. If all the required field is given and this field is not given OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
+awdnbr| No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| NA| NA
archdate| No| YYYYMMDD| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be cancelled
contact| No| 255 characters Default value: Primary
Other types: Secondary, Owner| NA| NA
desc| Yes| 65535 characters| 1. This required field should be validated | 1. Unable to process request. Please try again
@@ -4477,8 +4476,8 @@ Individual business rules per field are listed across each of the fields in belo
Element Name | Required | Character Limit / Restrictions | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
notice_type |No| Solicitation type
Valid Values: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL
Note: Searches for awards, ja and itb’s will return both standalone notices AND base notices that contain one of these type |Notice_type if given should be valid | Notice Type is not recognized
Expects one of the following: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB
-solnbr| No| Solicitation #| NA| NA
-awdnbr| No| Award #| NA| NA
+solnbr| No| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }| NA| NA
+awdnbr| No| 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }| NA| NA
posted_from |No |Posted From Date. YYYYMMDD| Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
posted_to| No |Posted To Date. YYYYMMDD |Date field should meet the expected format |DATE field in unexpected format. Expects YYYYMMDD
documents_to_search| No |Valid Values: ‘active’ or ‘archived’. Default is ALL if nothing provided| NA| NA
From d09add7feb4873257be90fa0be72fc857da43c81 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Mon, 28 Oct 2019 19:00:08 -0400
Subject: [PATCH 064/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 225 ++++++++++++++---------------
1 file changed, 112 insertions(+), 113 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 73640cb68..a33816b5a 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -128,7 +128,7 @@ The Notice Types valid options are:
#### Related Notices
-This is a conversion table for notices using submitNotice method.
+This is a conversion table for notices using following functions: submitNotice, submitJA, submitAward, submitITB
||SRCSGT | PRESOL | COMBINE | SOL| AWARD | SSALE | ITB | JA | SNOTE
-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|
@@ -191,7 +191,7 @@ offadd | string | No | Office Address (Not used) | 65535 characters
officeid | string | Yes | Office ID of the office where an opportunity is being submitted | 20 characters
subject | string | Yes | Subject | 255 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype | string | No | [Refer Notice Types](#notice-types) |
+ntype | string | No | [Refer Related Notices](#related-notices) |
awdnbr |String | Yes | Award Number | 255 characters
Agency assigned number for control tracking and identification.
Alphanumeric and - _ ( ) { } characters [no spaces]
awdamt | string | Yes | Award Amount | 64 characters
linenbr | string | No | Line Number | 255 characters
@@ -261,7 +261,7 @@ DeleteNoticeOrDocumentPackage Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr | string | Yes; Solicitation # or Award # is required | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | [Refer Notice Types](#notice-types)
+ntype | string | No | [Refer Related Notices](#related-notices)
awdnbr | string | Yes; Solicitation # or Award # is required| Award # | 255 characters
deletetype | string | No | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod | string | No | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
@@ -288,7 +288,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | [Refer Notice Types](#notice-types)
+ntype | string | No | [Refer Related Notices](#related-notices)
archdate | date | No | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
officeid | string | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
@@ -317,7 +317,7 @@ offadd | string | No | Office Address | 65535 characters
officeid | String | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
subject | string | No | Subject | 255 characters
solnbr |string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype | string | No | [Refer Notice Types](#notice-types) |
+ntype | string | No | [Refer Related Notices](#related-notices) |
awdnbr | string | No | Award # |255 characters
archdate | date | No | Archive Date | YYYYMMDD
contact | string | Yes | Contact Info | 65535 characters
@@ -353,8 +353,8 @@ officeid | string | Yes | Office ID of the office where an opportunity is being
offadd | string | No | Office Address (Not Used) | 65535 characters
subject | string | Yes| Title of the Pre-solicitation | 255 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-respdate | date | Yes - either respdate or archdate is required | Response Date | YYYYMMDD
-archdate | date | Yes - either respdate or archdate is required | Archive Date | YYYYMMDD
+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 | 65535 characters
desc |string |Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link has URL & description | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -496,8 +496,8 @@ offadd | string | No | Office Address (Not Used)| 65535 characters
subject | string | Yes | Subject | 255 characters
solnbr | string | Yes, EXCEPT No - Only for SNOTE | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
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 SNOTE, SSALE, SRCSGT, PRESOL | Response Date | YYYYMMDD
-archdate | date | Yes | Archive Date | YYYYMMDD
+respdate| date| Yes - for COMBINE, SOL
Either respdate or archdate required for SNOTE, SSALE, SRCSGT, PRESOL |Response Date |YYYYMMDD
+archdate | date| No - Either respdate or archdate required for SNOTE, SSALE, SRCSGT, PRESOL| Archive Date| YYYYMMDD
contact | string | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL | Contact Info | 65535 characters
desc | string | Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -567,14 +567,14 @@ offadd | String | No | Office Address | 65535 characters
officeid | String | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
subject | String | Yes | Subject | 255 characters
solnbr | String | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype | string | No | Notice Type | Valid Value: JA
+ntype | string | No | [Refer Related Notices](#related-notices) |
stauth | String | Yes | J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy | [Refer Stauth Valid Values](#stauth-valid-values)
awdnbr | String | Yes | Award Number | 255 characters
modnbr | String | No | Mod Number | 32 characters
awdamt | String | No | Award Amount | 64 characters
awddate | Date | No | Award Date | YYYYMMDD
donbr | String | Yes | Task/Delivery Order Number | 255 characters from the set: a-z A-Z 0-9 - _ ( )
-archdate | Date | Yes | Archive Date | YYYYMMDD
+archdate | Date | No | Archive Date | YYYYMMDD
contact | String | Yes | Contact Info | 65535 characters
desc | String | No | Description | 65535 characters
link | GovURL | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -641,8 +641,8 @@ officeid | string | Yes | Office ID of the office where an opportunity is being
offadd | string | No | Office Address | 65535 characters
subject | string | Yes | Subject | 255 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-respdate | date | Yes - either respdate or archdate is required | Response Date | YYYYMMDD
-archdate | date | Yes - either respdate or archdate is required | Archive Date | YYYYMMDD
+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 | 65535 characters
desc | string | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -919,10 +919,10 @@ officeid| String| Yes| Office ID of the office where an opportunity is being sub
offadd| String |No| Office Address| 65535 characters
subject| String| Yes| Subject |255 characters
solnbr |String |Yes| Solicitation # |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype |string |No| [Refer Notice Types](#notice-types)
+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 |Yes |Archive Date| YYYYMMDD
+archdate |Date |No |Archive Date| YYYYMMDD
contact| String| Yes| Contact Info |65535 characters; Default value = Primary, Other types are: Secondary, Owner
desc |String |Yes |Description| 65535 characters
link| GovURL| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -984,7 +984,7 @@ Complete notice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date| date| No |Posting Date| YYYYMMDD
-notice_type |string |Yes| [Refer Notice Types](#notice-types) |
+notice_type |string |Yes| [Refer Notice Types](#notice-types) |
zip |string |No |Zip Code| 5 digits
classcod| string| Yes - for SOL, COMBINE, SSALE, ITB, JA | Class-Code |Valid classification code (FAR, Section 5.207(g))
naics |string |Yes - for COMBINE, SOL |NAICS Code| Valid NAICS Code
NAICS Reference
@@ -992,7 +992,7 @@ officeid| String| Yes| Office ID of the office where an opportunity is being sub
offadd |string| No| Office Address (Not Used) |65535 characters
subject| string| Yes| Subject| 255 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 Notice Types](#notice-types)
+ntype |string |No | [Refer Related Notices](#related-notices)
awdnbr| string| Yes - for AWARD, ITB & JA | Award # |255 characters
donbr |string |Yes - for JA| Delivery/Task Order Number |255 characters
awdamt |string| Yes - for AWARD |Award Amount| 64 characters
@@ -1000,7 +1000,7 @@ linenbr| string |No| Award Line Item Number |255 characters
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 SNOTE, SSALE, SRCSGT, PRESOL |Response Date |YYYYMMDD
-archdate | date| Yes| Archive Date| YYYYMMDD
+archdate | date| No - Either respdate or archdate required for SNOTE, SSALE, SRCSGT, PRESOL| Archive Date| YYYYMMDD
awardee| string| Yes – for AWARD | Awardee |65535 characters
awardee_duns| string |No |Awardee DUNS |9 digits with optional plus 4
contact| string| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL| Contact Info| 65535 characters
@@ -1067,7 +1067,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
Date| Date| No |Posting Date |YYYYMMDD
solnbr |String |No| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype |String |No| [Refer Notice Types](#notice-types)
+ntype |String |No| [Refer Related Notices](#related-notices)
uploadtype| String| No | Upload Type| A for amendment, S for solicitation or any title for other; 255 characters
respdate |Date |No |Response Date| YYYYMMDD
links| DocumentLin k[]| Yes; Either Links or Files needs to be provided| Array Of links |
@@ -1110,7 +1110,7 @@ UnarchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No |[Refer Notice Types](#notice-types)
+ntype |string |No | [Refer Related Notices](#related-notices)
awdnbr |string| No| Award #| 255 characters
archdate |date| Yes| New Archive Date| YYYYMMDD
@@ -1175,7 +1175,7 @@ IVLListRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| Yes| Solicitation #
-ntype |string |No |[Refer Notice Types](#notice-types)
+ntype |string |No | [Refer Related Notices](#related-notices)
IVLListResponse Complex Type Definition:
@@ -1220,7 +1220,7 @@ AuthorizedPartyListRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| Yes |Solicitation #. Provide an empty string for this argument if using nonfbo_solnbr below
-ntype| string| No| [Refer Notice Types](#notice-types)
+ntype| string| No| [Refer Related Notices](#related-notices)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method
status| string |No |Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests.
@@ -1264,7 +1264,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string |Yes| Solicitation #
-ntype |string |No| [Refer Notice Types](#notice-types)
+ntype |string |No| [Refer Related Notices](#related-notices)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
@@ -1290,7 +1290,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name |Type |Required| Description
-----|-----|-----|----
solnbr |string |Yes| Solicitation #
-ntype| string| No| [Refer Notice Types](#notice-types)
+ntype| string| No| [Refer Related Notices](#related-notices)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method
vendor| VendorData |Yes| Complex type defined below
@@ -1327,7 +1327,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string |Yes| Solicitation #
-ntype |string |No|[Refer Notice Types](#notice-types)
+ntype |string |No| [Refer Related Notices](#related-notices)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.
reason |string| Yes| rejection reason not used in this method
@@ -1354,7 +1354,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| Yes| Solicitation #
-ntype |string |No| [Refer Notice Types](#notice-types)
+ntype |string |No| [Refer Related Notices](#related-notices)
nonfbo_solbr |string |No |Non-fbo Solicitation #. Not supported for this method
vendor |VendorData| Yes| Complex type defined below
reason| string| Yes |Rejection Reason
@@ -1390,7 +1390,7 @@ ExplicitAccessRequest Complex Type Definition:
Element Name | Type | Required | Description
------ | ------- | ------- | -------
solnbr| string| Yes| Solicitation #
-ntype |string |No |[Refer Notice Types](#notice-types)
+ntype |string |No | [Refer Related Notices](#related-notices)
nonfbo_solbr| string| No |Non-fbo Solicitation #. Not supported for this method.
Id |string |No |Not used in this method
vendor |VendorData| Yes| Complex type defined below
@@ -1428,7 +1428,7 @@ NoticeListRequest Complex Type Definition:
Element Name| Type| Required| Description
-----|-----|-----|-----
-notice_type |string| No (at least 1 field is required)| [Refer Notice Types](#notice-types) Note:Searches for award, j&a, itb and fairopps will return both standalone notices AND base notices that contain one of these type
+notice_type |string| No (at least 1 field is required)| [Refer Notice Types](#notice-types)(#related-notices) Note:Searches for award, j&a, itb and fairopps will return both standalone notices AND base notices that contain one of these type
solnbr |string |No (at least 1 field is required) |Solicitation #
awdnbr |string |No (at least 1 field is required)|Award #
posted_from |date| No (at least 1 field is required)| Posted From Date. YYYYMMDD.
@@ -2127,77 +2127,76 @@ Please note that variances may exist between SOAP requests generated by differen
Response Sample – Success
@@ -4078,7 +4077,7 @@ Note:
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | -------
date |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | 1. DATE field in unexpected format. Expects YYYYMMDD
notice_type | 1. This field is required where applicable | 1. Opportunity type is required
zip| NA |NA
@@ -4123,7 +4122,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: When links/files are given but none of the other fields are given, then service throws an error - Multiple Notices found. Please input more details
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
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|1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
@@ -4140,7 +4139,7 @@ files | 1. This field is not required but if url & description fields within the
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
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 a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
awdnbr| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required
ntype| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
@@ -4153,7 +4152,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: : If a user tries to archive a notice that is already archived, then the service throws an error - Opportunity already archived
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
solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
officeid | Office ID must be associated with user account |NA
@@ -4167,7 +4166,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: If a user tries to unarchive an active notice, then the service throws an error - Opportunity is active
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
officeid| Office ID must be associated with user account |NA
ntype| 1. If field is not provided OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
@@ -4181,7 +4180,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: - When user tries to cancel a notice without giving any input, then the service throws an error ‘Unable to process request. Please try again’
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
officeid| Office ID must be associated with user account |NA
subject| NA| NA
@@ -4197,7 +4196,7 @@ desc| 1. This field is required where applicable | 1. Unable to process request.
Individual business rules per field are listed across each of the fields in below table.
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
Get_changes| NA| NA
get_changes_from_date| Date field should meet the expected format.| DATE field in unexpected format. Expects YYYYMMDD
@@ -4209,7 +4208,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: Although none of the individual elements are mandatory, at least one filter should be given to perform the operation. If no filters are entered, then system throws an error - Insufficient Search Criteria.
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
solnbr| NA| NA
awdnbr| NA| NA
@@ -4223,7 +4222,7 @@ Individual business rules per field are listed across each of the fields in belo
* Note: If a wrong combination of file_id and notice_id is given, then the service throws a success message without any data.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
file_id |1. This field is required where applicable
2. If an invalid file Id is provided, then the system throws an error.| 1. file_id is required
2. File Id not found. Please enter a valid Id.
#### getIVLListResponse
@@ -4231,7 +4230,7 @@ file_id |1. This field is required where applicable
2. If an invalid file I
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
solnbr| 1. If an incorrect solicitation number and ntype combination is given, the service throws an error
2a. If this required field if not given, service throws an error
2b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination |1. Notice not found
2a. Notice not found
2b. Multiple Notices found. Please input more details
ntype| NA |NA
@@ -4240,7 +4239,7 @@ ntype| NA |NA
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
ntype| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
@@ -4253,7 +4252,7 @@ Individual business rules per field are listed across each of the fields in belo
ID can be obtained through getAuthorizedPartyList
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error |1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
ntype |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
@@ -4267,7 +4266,7 @@ Vendor can be obtained through getAuthorizedPartyList
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
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.
ntype |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
@@ -4278,7 +4277,7 @@ vendor |1. If all the elements in the Vendor Data complex definition are not pro
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
ntype| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
@@ -4289,7 +4288,7 @@ vendor| 1. If all the elements in the Vendor Data complex definition are not pr
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error| 1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
ntype| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
@@ -4300,7 +4299,7 @@ reason| 1. This is a required field. If no value is provided, then the system t
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------- | ------- | -------
+------ | ------- | ------- | ------- | --------
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.
ntype |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
From 7ebf6514e9dae1047b622e53c5416fe6cf00036f Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 03:24:50 -0400
Subject: [PATCH 065/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index d08910291..7eb0f06c0 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -4209,7 +4209,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)
------ | ------- | ------- | ------- | --------
-notice_type |
Valid Notice Type must be provided | Notice Type is not recognized
+notice_type | Valid Notice Type must be provided | Notice Type is not recognized
solnbr| NA| NA
awdnbr| NA| NA
posted_from | Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
From 4860d50b159493b1a9bfd8d68907029d95de2360 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 03:34:00 -0400
Subject: [PATCH 066/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 7eb0f06c0..0eb11b6fe 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -1429,7 +1429,7 @@ NoticeListRequest Complex Type Definition:
Element Name| Type| Required| Description | Character Limit / Restrictions
-----|-----|-----|-----|-----
notice_type |string| No (at least 1 field is required)| [Refer Notice Types](#notice-types)(#related-notices) Note:Searches for award, j&a, itb and fairopps will return both standalone notices AND base notices that contain one of these type
-solnbr |string |No (at least 1 field is required) |Solicitation #|| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
+solnbr |string |No (at least 1 field is required) |Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
awdnbr |string |No (at least 1 field is required)|Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
posted_from |date| No (at least 1 field is required)| Posted From Date. YYYYMMDD.
posted_to |date| No (at least 1 field is required)| Posted To Date. YYYYMMDD
From b934fd7def8a4dad357dc5ad721b86d91b4cae8b Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 03:35:29 -0400
Subject: [PATCH 067/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 0eb11b6fe..594a7197b 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -4106,7 +4106,7 @@ links| 1. This field is not required but if url & description fields within the
files| 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error |1. Links and/or files are not complete
setaside| NA |NA
popaddress| This is a free Text. No validation is performed on this field | NA
-popzip |No |5 digits| NA| NA
+popzip |No |5 digits
popcountry| No| 1. Award Details Section - Country is a required field
city |NA| NA
state | NA| NA
From 43ba7c32cffe5f86a988ffbca7c0ee2f7d655101 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu" Create_Publish_Opportunity_Contract_Json
+
+
+{
+ "data":
+ {
+ "type": "",
+ "solicitationNumber": "",
+ "title": "",
+ "organizationId": "",
+ "organizationLocationId": "",
+ "classificationCode": "",
+ "naics": [
+ {
+ "type": "primary",
+ "code": [""]
+ }],
+ "flags": [
+ {
+ "code": "",
+ "isSelected": true
+ }],
+ "pointOfContact": [
+ {
+ "type": "primary",
+ "title": "",
+ "fullName": "",
+ "email": "",
+ "phone": "",
+ "fax": "",
+ "additionalInfo":
+ {
+ "content": ""
+ }
+ }],
+ "placeOfPerformance":
+ {
+ "streetAddress": "",
+ "streetAddress2": "",
+ "city":
+ {
+ "code": "",
+ "name": ""
+ },
+ "country":
+ {
+ "code": "",
+ "name": ""
+ },
+ "state":
+ {
+ "code": "",
+ "name": ""
+ },
+ "zip": ""
+ },
+ "archive":
+ {
+ "type": "autocustom",
+ "date": "2019-09-09"
+ },
+ "permissions":
+ {
+ "IVL":
+ {
+ "create": false,
+ "delete": false,
+ "read": false,
+ "update": false
+ }
+ },
+ "solicitation":
+ {
+ "setAside": "SBA",
+ "deadlines":
+ {
+ "response": "2019-08-08"
+ }
+ },
+ "award":
+ {
+ "date": "",
+ "number": "",
+ "deliveryOrderNumber": "",
+ "amount": "",
+ "lineItemNumber": "",
+ "awardee":
+ {
+ "manual": false,
+ "name": "",
+ "duns": "",
+ "location":
+ {
+ "streetAddress": "",
+ "streetAddress2": "",
+ "city":
+ {
+ "code": "",
+ "name": ""
+ },
+ "state":
+ {
+ "code": "",
+ "name": ""
+ },
+ "zip": "",
+ "country":
+ {
+ "code": "",
+ "name": ""
+ }
+ }
+ }
+ },
+ "justificationAuthority":
+ {
+ "modificationNumber": "",
+ "authority": "dictionary"
+ },
+ "link":
+ {
+ "additionalInfo":
+ {
+ "content": ""
+ },
+ "href": ""
+ },
+ "additionalReporting": ["none"]
+ },
+ "description": [
+ {
+ "body": ""
+ }],
+ "related":
+ {
+ "opportunityId": ""
+ }
+ }
+
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 (if 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 'Inerested Vendor's List' where users outside the notice can indicate a desire to submit a proposal. This list in way binds either party
+permissions.ivl.create | boolean | | | No | No | IVL create permission
+permissions.ivl.read | boolean | | | No | No | IVL read permission
+permissions.ivl.update | boolean | | Not In Use | Not In Use | Not In Use | IVL update permission
+permissions.ivl.delete | boolean | | Not In Use | Not In Use | Not In Use | IVL delete permission
+solicitation | JSON |NA | NA | NA | NA |
+solicitation.setAside | string | |See Set-Aside values table | 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)
2) Yes (when archive.type=
auto1) | Deadline Date
+solicitation.deadlines.
responseresponseTz |string | | | No | No | Time Zone for
Solicitation Deadline Date
+award | JSON | NA | NA | NA | NA | This section is mainly used for providing award information that is required for 'Award Notice' and 'Justification' opportunity types
+award.date | date | |YYYY-MM-DD |No | Yes only for type= a | Award Date
+award.number | string | 255 characters | |No | Yes only for type= i, j, a | Award Number
+award.deliverOrderNumber | string | 255 characters| | No | No | Award Delivery Order Number
+award.amount | number |64 digits | | No | No | Award Amount
+award.lineitemNumber | string |255 characters | | No | No | Contract Line item Number
+award.awardee | JSON | NA| NA | NA | NA |Awardee details
+award.awardee.name | string | 255 characters | | No | No | Awardee Name
+award.awardee.duns | string | 9 digits | | No | No | Awardee Duns
+award.awardee.location | JSON |NA | NA | NA | NA | Awardee Location details
+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 | No | 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 | No | 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 | No | Awardee Country code
+award.awardee.location.
country.name | string | | | No | No | Awardee Country Name
+award.awardee.location.
zip | string | | | No | No | Awardee Country Zip code
+justificationAuthority | JSON |NA |NA | NA | NA |
+justificationAuthority.
modificationNumber | string | 32 characters| | No | No | Justification Authority Modification Number
+justificationAuthority.
authority | string| | | No | No | Justification Authority
+link | JSON | NA |NA | NA | NA |
+link.href | string | | | No | No | Url for the notice on SAM.gov
+link.additionalInfo | JSON | NA |NA | NA | NA | Any additional information on the opportunity
+link.additionalInfo.content | string | | | No | No | Additional information details
+additionalReporting | string | |none/
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
+description | JSON | NA | NA | NA | NA |
+description.body | string | 65535 characters| | No | Yes | Description of the notice
+related | JSON | NA | NA | NA | NA | Related Notice information
+related.opportunityId | string | 32 characters| | No | No | Opportunity Id of the related notice
+resources | JSON |NA | NA | NA | NA |
+resources.attType | string | |link, file | No |No| Type of attachment, either link or file
+resources.content | byte |250MB | | No|No | File content in base64 format
+resources.link | string | 255 characters | |No|No | Resource link URL
+resources.packageAccessLevel | string | | public,private(default public) | No | No| Type of access to file
+resources.resourceName | string | 255 characters | | No|No | Name of file
+
+
+
### Revise Opportunity Contract JSON
NAICS Reference
-offadd | string | No | Office Address (Not used) | 65535 characters
+offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
officeid | string | Yes | Office ID of the office where an opportunity is being submitted | 20 characters
subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype | string | No | [Refer Related Notices](#related-notices) |
-awdnbr |String | Yes | Award Number | 255 characters
Agency assigned number for control tracking and identification.
Alphanumeric and - _ ( ) { } characters [no spaces]
+awdnbr |String | Yes | Award Number | 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
awdamt | string | Yes | Award Amount | 64 digits
-linenbr | string | No | Line Number | 255 characters
+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 | Yes | Awardee | 255 characters
awardee_duns | string | No | Awardee DUNS | 9 digits with optional plus 4
contact | string | No | Contact Info | 255 characters
desc | string | No | Description | 65535 characters
-link | GovURL | No | Government Link |255 characters| Consist of a restricted set of characters (see URL specification - RFC 2396)|
+link | GovURL | No | Government Link |255 characters. Consist of a restricted set of characters (see URL specification - RFC 2396)
email | GovEmail | No | Government Email | 255 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
@@ -261,8 +261,8 @@ DeleteNoticeOrDocumentPackage Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr | string | Yes; Solicitation # or Award # is required | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | [Refer Related Notices](#related-notices)
-awdnbr | string | Yes; Solicitation # or Award # is required| Award # | 255 characters
+ntype | string | No | Notice Type | [Refer Notice Types](#Notice Types)
+awdnbr | string | Yes; Solicitation # or Award # is required| Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
deletetype | string | No | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod | string | No | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
@@ -288,7 +288,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | [Refer Related Notices](#related-notices)
+ntype | string | No | Notice Type | [Refer Notice Types](#Notice Types)
archdate | date | No | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
officeid | string | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
@@ -300,7 +300,7 @@ Input Parameters:
Input Parameter | Type | Description
------- | ------ | -------
-data | CancelNotice | Complex type defined below
+data | Notice | Complex type defined below
Response:
@@ -313,12 +313,12 @@ CancelNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
+offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
officeid | String | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
subject | string | No | Subject | 256 characters
solnbr |string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype | string | No | [Refer Related Notices](#related-notices) |
-awdnbr | string | No | Award # |255 characters
+ntype | string | No | Notice Type | [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 | Yes | Contact Info | 255 characters
desc | string | Yes | Cancellation Description | 65535 characters
@@ -346,12 +346,12 @@ Presol Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits. This field has been deprecated
+zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
-naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
+naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd | string | No | Office Address (Not Used) | 65535 characters
-subject | string | Yes| Title of the Pre-solicitation | 256 characters
+offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
+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
@@ -417,12 +417,11 @@ Combined Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits. This field has been deprecated
+zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
-subject | string | Yes | Subject | 256 characters
+offadd | string | No |Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 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
@@ -488,11 +487,11 @@ Mod Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | Yes - for AWARD | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits
+zip | string | No |Zip Code (Deprecated) | 5 digits
classcod | string | Yes - for SOL, COMBINE, SSALE, ITB, JA | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes - for COMBINE, SOL | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
+offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
subject | string | no | 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 | Yes | Notice Type | Valid values: PRESOL, COMBINE, SRCSGT, SSALE, SNOTE, SOL
@@ -560,16 +559,16 @@ JA Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | Date | No | Posting Date | YYYYMMDD
-zip | String | No | Zip Code | 5 digits
+zip | String | No | Zip Code (Deprecated) | 5 digits
classcod | String | Yes | Class-Code | Valid classification code
naics | String | No | NAICS Code | Valid NAICS Code
NAICS Reference
-offadd | String | No | Office Address |65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
+offadd | String | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy |65535 characters
officeid | String | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
subject | String | Yes | Subject | 256 characters
solnbr | String | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype | string | No | [Refer Related Notices](#related-notices) |
stauth | String | Yes | J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy | [Refer Stauth Valid Values](#stauth-valid-values)
-awdnbr | String | Yes | Award Number | 255 characters
+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 | 64 digits
awddate | Date | No | Award Date | YYYYMMDD
@@ -634,11 +633,11 @@ SourcesSought Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits. This field has been deprecated
+zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
+offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
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
@@ -709,11 +708,11 @@ SpecialNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | Date | No | Posting Date | YYYYMMDD
-zip | String | No | Zip Code | 5 digits. This field has been deprecated
+zip | String | No | Zip Code (Deprecated)| 5 digits
classcod | String | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | String | No | NAICS Code | Valid NAICS Code
NAICS Reference
-officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd | String | No | Office Address | 65535 characters
+officeid | String | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
+offadd | String | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
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
@@ -775,11 +774,11 @@ SaleOfSurplus Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date| No| Posting Date| YYYYMMDD
-zip| string| No| Zip Code| 5 digits. This field has been deprecated
+zip| string| No| Zip Code (Deprecated) | 5 digits
classcod| string| Yes |Class-Code| Valid classification code (FAR, Section 5.207(g))
-naics| string| No| NAICS Code| Valid NAICS Code
NAICS Reference
+naics| string| No| NAICS Code| Valid NAICS Code
NAICS Reference
officeid |string |Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd| string| No |Office Address |65535 characters
+offadd| string| No |Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy |65535 characters
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
@@ -841,11 +840,11 @@ Solicitation Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
-zip | string | No | Zip Code | 5 digits. This field has been deprecated
+zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters
+offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
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
@@ -912,11 +911,11 @@ ITB Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date |Date |No |Posting Date |YYYYMMDD
-zip |String| No| Zip Code| 5 digits. This field has been deprecated
+zip |String| No| Zip Code (Deprecated)| 5 digits
classcod| String| Yes| Class-Code| Valid classification code (FAR, Section 5.207(g))
naics| String| No| NAICS Code| Valid NAICS Code
NAICS Reference
officeid| String| Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account| 20 characters
-offadd| String |No| Office Address| 65535 characters
+offadd| String |No| Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy| 65535 characters
subject| String| Yes| Subject |256 characters
solnbr |String |Yes| Solicitation # |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype |string |No| [Refer Related Notices](#related-notices)
@@ -985,18 +984,18 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date| date| No |Posting Date| YYYYMMDD
notice_type |string |Yes| [Refer Notice Types](#notice-types) |
-zip |string |No |Zip Code| 5 digits. This field has been deprecated
+zip |string |No |Zip Code (Deprecated)| 5 digits
classcod| string| Yes - for SOL, COMBINE, SSALE, ITB, JA | Class-Code |Valid classification code (FAR, Section 5.207(g))
-naics |string |Yes - for COMBINE, SOL |NAICS Code| Valid NAICS Code
NAICS Reference
+naics |string |Yes - for COMBINE, SOL |NAICS Code| Valid NAICS Code
NAICS Reference
officeid| String| Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account |20 characters
-offadd |string| No| Office Address |65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
-subject| string| Yes| Subject| 255 characters
+offadd |string| No| Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy |65535 characters
+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
-donbr |string |Yes - for JA| Delivery/Task Order Number |255 characters
+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 - _ ( )
awdamt |string| Yes - for AWARD |Award Amount| 64 digits
-linenbr| string |No| Award Line Item Number |255 characters
+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 SNOTE, SSALE, SRCSGT, PRESOL |Response Date |YYYYMMDD
@@ -1067,7 +1066,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
Date| Date| No |Posting Date |YYYYMMDD
solnbr |String |No| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype |String |No| [Refer Related Notices](#related-notices)
+ntype |String |No| Notice Type | [Refer Notice Types](#Notice Types)
uploadtype| String| No | Upload Type| A for amendment, S for solicitation or any title for other; 255 characters
respdate |Date |No |Response Date| YYYYMMDD
links| DocumentLin k[]| Yes; Either Links or Files needs to be provided| Array Of links |
@@ -1110,8 +1109,8 @@ UnarchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | [Refer Related Notices](#related-notices)
-awdnbr |string| No| Award #| 255 characters
+ntype |string |No | Notice Type | [Refer Notice Types](#Notice Types)
+awdnbr |string| No| Award #| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
archdate |date| Yes| New Archive Date| YYYYMMDD
### Secure Document Package
(attachSecureDocumentPackagesToNotice)
@@ -1175,7 +1174,7 @@ IVLListRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | [Refer Related Notices](#related-notices)
+ntype |string |No | Notice Type | [Refer Notice Types](#Notice Types)
IVLListResponse Complex Type Definition:
@@ -1199,7 +1198,7 @@ duns| string| DUNS #
cage_code |string| Cage Code
address |string |Address
bus_types| string| Business Types
-naics_codes| string |Naics Codes
NAICS Reference
+naics_codes| string |Naics Codes
NAICS Reference
### Authorized Parties List
(getAuthorizedPartyList)
@@ -1220,7 +1219,7 @@ AuthorizedPartyListRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes |Solicitation #. Provide an empty string for this argument if using nonfbo_solnbr below | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype| string| No| [Refer Related Notices](#related-notices) |
+ntype| string| No| Notice Type | [Refer Notice Types](#Notice Types)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method |
status| string |No |Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests. |
@@ -1264,7 +1263,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| [Refer Related Notices](#related-notices)|
+ntype |string |No| Notice Type | [Refer Notice Types](#Notice Types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
@@ -1290,7 +1289,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name |Type |Required| Description | Character Limit / Restrictions
-----|-----|-----|---- | -------
solnbr |string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype| string| No| [Refer Related Notices](#related-notices)|
+ntype| string| No| Notice Type | [Refer Notice Types](#Notice Types)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method|
vendor| VendorData |Yes| Complex type defined below|
@@ -1327,7 +1326,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| [Refer Related Notices](#related-notices)|
+ntype |string |No| Notice Type | [Refer Notice Types](#Notice Types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
reason |string| Yes| rejection reason not used in this method|
@@ -1354,7 +1353,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| [Refer Related Notices](#related-notices)
+ntype |string |No| Notice Type | [Refer Notice Types](#Notice Types)
nonfbo_solbr |string |No |Non-fbo Solicitation #. Not supported for this method|
vendor |VendorData| Yes| Complex type defined below|
reason| string| Yes |Rejection Reason | 65535 characters
@@ -1390,7 +1389,7 @@ ExplicitAccessRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | [Refer Related Notices](#related-notices)|
+ntype |string |No | Notice Type | [Refer Notice Types](#Notice Types)
nonfbo_solbr| string| No |Non-fbo Solicitation #. Not supported for this method.|
Id |string |No |Not used in this method|
vendor |VendorData| Yes| Complex type defined below|
@@ -1428,7 +1427,7 @@ NoticeListRequest Complex Type Definition:
Element Name| Type| Required| Description | Character Limit / Restrictions
-----|-----|-----|-----|-----
-notice_type |string| No (at least 1 field is required)| [Refer Notice Types](#notice-types)(#related-notices) Note:Searches for award, j&a, itb and fairopps will return both standalone notices AND base notices that contain one of these type
+notice_type |string| No (at least 1 field is required)| [Refer Notice Types](#notice-types) Note:Searches for award, j&a, itb and fairopps will return both standalone notices AND base notices that contain one of these type
solnbr |string |No (at least 1 field is required) |Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
awdnbr |string |No (at least 1 field is required)|Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
posted_from |date| No (at least 1 field is required)| Posted From Date. YYYYMMDD.
From b7e485a82f546e10b5f025ba235d3281291f45d7 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu" SOLICITATION Request related to a PRESOL Notice
+
+
+
+{
+ "data":
+ {
+ "type": "o",
+ "solicitationNumber": "test-12345678901",
+ "title": "Test submit solicitation",
+ "organizationId": "100186612",
+ "organizationLocationId": "",
+ "classificationCode": "1260",
+ "naics": [
+ {
+ "type": "primary",
+ "code": ["111150"]
+ }],
+ "flags": [
+ {
+ "code": "",
+ "isSelected": true
+ }],
+ "pointOfContact": [
+ {
+ "type": "primary",
+ "title": "",
+ "fullName": "test contact",
+ "email": "test@test.com",
+ "phone": "",
+ "fax": "",
+ "additionalInfo":
+ {
+ "content": "Primary contact info"
+ }
+ }],
+ "placeOfPerformance":
+ {
+ "streetAddress": "1234 XYZ street",
+ "streetAddress2": "",
+ "city": {
+ "code": "75376",
+ "name": "Sterling"
+ },
+ "state": {
+ "code": "VA",
+ "name": "Virginia"
+ },
+ "country": {
+ "code": "USA",
+ "name":"USA"
+ }
+,
+ "zip": ""
+ },
+ "archive":
+ {
+ "type": "autocustom",
+ "date": "2022-09-09"
+ },
+ "permissions":
+ {
+ "IVL":
+ {
+ "create": false,
+ "delete": false,
+ "read": false,
+ "update": false
+ }
+ },
+ "solicitation":
+ {
+ "setAside": "SBA",
+ "deadlines":
+ {
+ "response": "2022-08-08"
+ }
+ },
+ "award":
+ {
+ "date": "",
+ "number": "",
+ "deliveryOrderNumber": "",
+ "amount": "",
+ "lineItemNumber": "",
+ "awardee":
+ {
+ "manual": false,
+ "name": "",
+ "duns": "",
+ "location":
+ {
+ "streetAddress": "",
+ "streetAddress2": "",
+ "city":
+ {
+ "code": "",
+ "name": ""
+ },
+ "state":
+ {
+ "code": "",
+ "name": ""
+ },
+ "zip": "",
+ "country":
+ {
+ "code": "",
+ "name": ""
+ }
+ }
+ }
+ },
+ "justificationAuthority":
+ {
+ "modificationNumber": "",
+ "authority": "dictionary"
+ },
+ "link":
+ {
+ "additionalInfo":
+ {
+ "content": ""
+ },
+ "href": ""
+ },
+ "additionalReporting": ["none"]
+ },
+ "description": [
+ {
+ "body": "test description"
+ }],
+ "related":
+ {
+ "opportunityId": "bc14e9f810a44e468c31fd120dd41b4f"
+ }
+ }
+
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
@@ -2843,7 +2985,7 @@ justificationAuthority.
authority | string| | | No | No | Justification Au
link | JSON | NA |NA | NA | NA |
link.href | string | | | No | No | Url for the notice on SAM.gov
link.additionalInfo | JSON | NA |NA | NA | NA | Any additional information on the opportunity
-link.additionalInfo.content | string | | | No | No | Additional information details
+link.additionalInfo.
content | string | | | No | No | Additional information details
additionalReporting | string | |none/
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
description | JSON | NA | NA | NA | NA |
description.body | string | 65535 characters| | No | Yes | Description of the notice
@@ -3049,7 +3191,7 @@ pointOfContact.email | string |255 characters | | No | Yes (no if type = a) |
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
+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
@@ -3105,7 +3247,7 @@ justificationAuthority.
authority | string| | | No | No | Justification Au
link | JSON | NA |NA | NA | NA |
link.href | string | | | No | No | Url for the notice on SAM.gov
link.additionalInfo | JSON | NA |NA | NA | NA | Any additional information on the opportunity
-link.additionalInfo.content | string | | | No | No | Additional information details
+link.additionalInfo.
content | string | | | No | No | Additional information details
additionalReporting | string | |none/
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
description | JSON | NA | NA | NA | NA |
description.body | string | 65535 characters| | No | Yes | Description of the notice
@@ -3311,15 +3453,15 @@ newResponseTz | string | America/New_York | Yes (if newResponseDate is provided)
* Field headers in the table must match with field headers shown in JSON example
-Name | Data Type | Allowed Values | Required | Description
+Name | Data Type | Field Length |Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
-attType | string | link, file | Yes | Type of attachment, either link or file
-content | byte | | Yes (if attType=file) | File content in base64 format
-packageAccessLevel | string | public,private(default public) | No | Type of access to file. Only used with attType 'file'.
-resourceName | string | | Yes (if attType=file) | Name of file
-fileType | string | | No | Mime Type of the file. Only used for attType 'file'. [Refer Valid File Types](#valid-file-types)
-link | string | | Yes (if attType=link) | Resource link URL
-description | string | | Yes (if attType=link) | Description of the link
+attType | string | 32 characters |link, file | Yes | Type of attachment, either link or file
+content | byte | 250MB| | Yes (if attType=file) | File content in base64 format
+packageAccessLevel | string | 32 characters|public,private(default public) | No | Type of access to file. Only used with attType 'file'.
+resourceName | string | 255 characters| | Yes (if attType=file) | Name of file
+fileType | string | 64 characters | | No | Mime Type of the file. Only used for attType 'file'. [Refer Valid File Types](#valid-file-types)
+link | string | 255 characters| | Yes (if attType=link) | Resource link URL
+description | string |255 characters | | Yes (if attType=link) | Description of the link
#### Valid File Types
From 31585b94472ea76af602f5de761c01e6d8c946fc Mon Sep 17 00:00:00 2001
From: "anusha.paladugu" Create_Publish_Opportunity_Contract_Json
Note, use “pending” to pull the pending explicit access requests. |
@@ -1263,7 +1263,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| Notice Type | [Refer Notice Types](#Notice Types)
+ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
@@ -1289,7 +1289,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name |Type |Required| Description | Character Limit / Restrictions
-----|-----|-----|---- | -------
solnbr |string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype| string| No| Notice Type | [Refer Notice Types](#Notice Types)
+ntype| string| No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method|
vendor| VendorData |Yes| Complex type defined below|
@@ -1326,7 +1326,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| Notice Type | [Refer Notice Types](#Notice Types)
+ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
reason |string| Yes| rejection reason not used in this method|
@@ -1353,7 +1353,7 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| Notice Type | [Refer Notice Types](#Notice Types)
+ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string |No |Non-fbo Solicitation #. Not supported for this method|
vendor |VendorData| Yes| Complex type defined below|
reason| string| Yes |Rejection Reason | 65535 characters
@@ -1389,7 +1389,7 @@ ExplicitAccessRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | Notice Type | [Refer Notice Types](#Notice Types)
+ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No |Non-fbo Solicitation #. Not supported for this method.|
Id |string |No |Not used in this method|
vendor |VendorData| Yes| Complex type defined below|
From fbf8dcdca3ed383462244443998249f3363076f9 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
{
- "data":
- {
+ "data": {
"type": "",
"solicitationNumber": "",
"title": "",
@@ -3037,131 +3036,134 @@ reason | string | | No | Publish reason
"organizationLocationId": "",
"classificationCode": "",
"naics": [
- {
- "type": "primary",
- "code": [""]
- }],
+ {
+ "type": "primary",
+ "code": [
+ ""
+ ]
+ }
+ ],
"flags": [
- {
- "code": "",
- "isSelected": true
- }],
+ {
+ "code": "",
+ "isSelected": true
+ }
+ ],
"pointOfContact": [
- {
- "type": "primary",
- "title": "",
- "fullName": "",
- "email": "",
- "phone": "",
- "fax": "",
- "additionalInfo":
{
- "content": ""
+ "type": "primary",
+ "title": "",
+ "fullName": "",
+ "email": "",
+ "phone": "",
+ "fax": "",
+ "additionalInfo": {
+ "content": ""
+ }
}
- }],
- "placeOfPerformance":
- {
+ ],
+ "placeOfPerformance": {
"streetAddress": "",
"streetAddress2": "",
- "city":
- {
+ "city": {
"code": "",
"name": ""
},
- "country":
- {
+ "country": {
"code": "",
"name": ""
},
- "state":
- {
+ "state": {
"code": "",
"name": ""
},
"zip": ""
},
- "archive":
- {
+ "archive": {
"type": "autocustom",
"date": "2019-09-09"
},
- "permissions":
- {
- "IVL":
- {
+ "permissions": {
+ "IVL": {
"create": false,
"delete": false,
"read": false,
"update": false
}
},
- "solicitation":
- {
+ "solicitation": {
"setAside": "SBA",
- "deadlines":
- {
+ "deadlines": {
"response": "2019-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": {
+ "modificationNumber": "",
+ "authority": "dictionary"
+ },
+ "link": {
+ "additionalInfo": {
+ "content": ""
},
- "justificationAuthority":
- {
- "modificationNumber": "",
- "authority": "dictionary"
- },
- "link":
- {
- "additionalInfo":
- {
- "content": ""
- },
- "href": ""
- },
- "additionalReporting": ["none"]
+ "href": ""
},
- "description": [
+ "additionalReporting": [
+ "none"
+ ]
+ },
+ "description": [
{
"body": ""
- }],
- "related":
+ }
+ ],
+ "related": {
+ "opportunityId": ""
+ },
+ "resources": [
{
- "opportunityId": ""
+ "attType": "link",
+ "link": "",
+ "description": ""
+ },
+ {
+ "attType": "file",
+ "content": "",
+ "resourceName": "",
+ "packageAccessLevel": "",
+ "explicitAccess": "",
+ "exportControlled": null
}
- }
+ ]
+}
OR
User provides more than 1 year of date range for rdlfrom and rdlto |Date range must be 1 year(s) apart
-User provides more than 25 characters for description field. | Description length is limited to 25 characters
User provides invalid API Key| An invalid api_key was supplied
User does not provide any API key |No api_key was supplied
User clicks on the description link available in the response and description content is not available |Description Not Found
From 51b788f4d0bc3249af1fafc67d333f7609720aee Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 10:13:56 -0400
Subject: [PATCH 073/149] Update get-opportunities-public-api.md
---
_apidocs/get-opportunities-public-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/get-opportunities-public-api.md b/_apidocs/get-opportunities-public-api.md
index 9e9298b7a..d8b7954a7 100644
--- a/_apidocs/get-opportunities-public-api.md
+++ b/_apidocs/get-opportunities-public-api.md
@@ -87,7 +87,7 @@ pointofContact| Point of Contact Information. It can have below fields if availa
description| A link to an opportunity description.
Note: To download the description, user should append the public API Key. If no description is available then, user is shown an error message “ Description not found”| String
organizationType| Type of an organization – department/sub-tier/office| String
officeAddress| Office Address Information. It can have below fields if available:
City
State
Zip| String
-placeOfPerformance| Place of performance information. It can have below fields if available:
City
State
Zip| JSON
+placeOfPerformance| Place of performance information. It can have below fields if available: Street
City
State
Zip| JSON
additionalInfoLink| Any additional info link if available for the opportunity |String
uiLink |Direct UI link to the opportunity. To view the opportunity on UI, user must have either a contracting officer or a Contracting Specialist role. If user hits the link without logging in, user is directed to 404 not found page | String
links |Every record in a response has this links array consisting of:
rel: self
href: link to the specific opportunity itself. User should provide an API key to access the opportunity directly
Also, every response has a master links array consisting of:
rel: self
href: link to the actual request. User should provide an API key to access the request| Array
From a2c35bc513f8ac567a377f4c929f55e253b820f1 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 14:32:57 -0400
Subject: [PATCH 074/149] Update get-opportunities-public-api.md
---
_apidocs/get-opportunities-public-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/get-opportunities-public-api.md b/_apidocs/get-opportunities-public-api.md
index d8b7954a7..6ac8b2f77 100644
--- a/_apidocs/get-opportunities-public-api.md
+++ b/_apidocs/get-opportunities-public-api.md
@@ -92,7 +92,7 @@ additionalInfoLink| Any additional info link if available for the opportunity |S
uiLink |Direct UI link to the opportunity. To view the opportunity on UI, user must have either a contracting officer or a Contracting Specialist role. If user hits the link without logging in, user is directed to 404 not found page | String
links |Every record in a response has this links array consisting of:
rel: self
href: link to the specific opportunity itself. User should provide an API key to access the opportunity directly
Also, every response has a master links array consisting of:
rel: self
href: link to the actual request. User should provide an API key to access the request| Array
-#### Set-Aside Values
+### Set-Aside Values
Several methods pertaining to submitting Contract Opportunities involve the Set-Aside Type field. Use the Set-Aside codes to submit notices.
Only one Set-Aside value is accepted in the field at this time
From 9bc3478df894f17d518e5add3850680efe0d65b5 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 14:32:59 -0400
Subject: [PATCH 075/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index ff415a24e..037950258 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -14,7 +14,7 @@ The Opportunity Management API will allow authorized users to submit and request
## Getting Started
Opportunity Management API can be accessed from Beta or Alpha via the following endpoints:
-* Beta: https://api.sam.gov/prod/opportunity
+* Beta: https://api.sam.gov/prod/opportunity (Coming Soon)
* Alpha: https://api-alpha.sam.gov/prodlike/opportunity
**REST API Workflow Chart**
From 932c4c4eab6d7b2c43e20d5e24e48897dbd2f700 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu" Create and Publish 'SOLICITATION' Opportunity with attachments/links related to a 'PRESOL' notice:
+
+
+{
+ "data": {
+ "type": "o",
+ "solicitationNumber": "test-12345457",
+ "title": "Test Create and Publish SOL notice",
+ "organizationId": "100186612",
+ "organizationLocationId": "",
+ "classificationCode": "1260",
+ "naics": [
+ {
+ "type": "primary",
+ "code": [
+ "111150"
+ ]
+ }
+ ],
+ "flags": [
+ {
+ "code": "",
+ "isSelected": true
+ }
+ ],
+ "pointOfContact": [
+ {
+ "type": "primary",
+ "title": "",
+ "fullName": "test contact",
+ "email": "test@test.com",
+ "phone": "",
+ "fax": "",
+ "additionalInfo": {
+ "content": "Primary contact info"
+ }
+ }
+ ],
+ "placeOfPerformance": {
+ "streetAddress": "1234 XYZ street",
+ "streetAddress2": "",
+ "city": {
+ "code": "75376",
+ "name": "Sterling"
+ },
+ "state": {
+ "code": "VA",
+ "name": "Virginia"
+ },
+ "country": {
+ "code": "USA",
+ "name": "USA"
+ },
+ "zip": ""
+ },
+ "archive": {
+ "type": "autocustom",
+ "date": "2022-09-09"
+ },
+ "permissions": {
+ "IVL": {
+ "create": false,
+ "delete": false,
+ "read": false,
+ "update": false
+ }
+ },
+ "solicitation": {
+ "setAside": "SBA",
+ "deadlines": {
+ "response": "2022-08-08"
+ }
+ },
+ "award": {
+ "date": "",
+ "number": "",
+ "deliveryOrderNumber": "",
+ "amount": "",
+ "lineItemNumber": "",
+ "awardee": {
+ "manual": false,
+ "name": "",
+ "duns": "",
+ "location": {
+ "streetAddress": "",
+ "streetAddress2": "",
+ "city": {
+ "code": "",
+ "name": ""
+ },
+ "state": {
+ "code": "",
+ "name": ""
+ },
+ "zip": "",
+ "country": {
+ "code": "",
+ "name": ""
+ }
+ }
+ }
+ },
+ "justificationAuthority": {
+ "modificationNumber": "",
+ "authority": "dictionary"
+ },
+ "link": {
+ "additionalInfo": {
+ "content": ""
+ },
+ "href": ""
+ },
+ "additionalReporting": [
+ "none"
+ ]
+ },
+ "description": [
+ {
+ "body": "test description"
+ }
+ ],
+ "related": {
+ "opportunityId": "f8ccfca94d794e07855ebe0d6f55c7d5"
+ },
+ "resources": [
+ {
+ "attType": "link",
+ "link": "https://faaco.faa.gov/index.cfm/attachment/download/84723",
+ "description": "test attachment pdf link"
+ },
+ {
+ "attType": "file",
+ "content": "SGVsbG8=",
+ "resourceName": "Hello.txt",
+ "fileType": "text/plain",
+ "packageAccessLevel": "private",
+ "explicitAccess": "1"
+ }
+ ]
+}
+
Delete Notice:
+Delete latest version of a notice:
{
- "requestType":"delete_request",
- "reason":"test",
- "data":{
- "description":"test",
- "title":null,
- "newArchiveDate":null,
- "newArchiveType":null,
- "deleteOption":"latest" ( “all” - to delete all versions)
- }
+ "reason": "test",
+ "requestType": "delete_request",
+ "data": {
+ "description": "test",
+ "deleteOption": "latest"
+ }
}
{
- "attType": "file",
- "content": "SGVsbG8=",
- "resourceName": "Hello.txt",
- "fileType": "text/plain",
- "packageAccessLevel": "public"
+ "attType": "file",
+ "content": "SGVsbG8=",
+ "resourceName": "Hello.txt",
+ "fileType": "text/plain",
+ "packageAccessLevel": "private",
+ "explicitAccess": "1"
}
Create Attachment Request - link
-{"attType":"link",
- "link":"https://faaco.faa.gov/index.cfm/attachment/download/84723",
- "description":"test attachment pdf link",
-"packageAccessLevel":null
+{
+ "attType": "link",
+ "link": "https://faaco.faa.gov/index.cfm/attachment/download/84723",
+ "description": "test attachment pdf link"
}
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 (if 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
+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 (if 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 'Inerested Vendor's List' where users outside the notice can indicate a desire to submit a proposal. This list in way binds either party
permissions.ivl.create | boolean | | | No | No | IVL create permission
@@ -2953,7 +3097,7 @@ permissions.ivl.read | boolean | | | No | No | IVL read permission
permissions.ivl.update | boolean | | Not In Use | Not In Use | Not In Use | IVL update permission
permissions.ivl.delete | boolean | | Not In Use | Not In Use | Not In Use | IVL delete permission
solicitation | JSON |NA | NA | NA | NA |
-solicitation.setAside | string | |See Set-Aside values table | No | No | Set-Aside code. The designator for type of set aside determined for the contract action
+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)
2) Yes (when archive.type=
auto1) | Deadline Date
solicitation.deadlines.
responseresponseTz |string | | | No | No | Time Zone for
Solicitation Deadline Date
@@ -2986,7 +3130,7 @@ link | JSON | NA |NA | NA | NA |
link.href | string | | | No | No | Url for the notice on SAM.gov
link.additionalInfo | JSON | NA |NA | NA | NA | Any additional information on the opportunity
link.additionalInfo.
content | string | | | No | No | Additional information details
-additionalReporting | string | |none/
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
+additionalReporting | string | |none,
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
description | JSON | NA | NA | NA | NA |
description.body | string | 65535 characters| | No | Yes | Description of the notice
related | JSON | NA | NA | NA | NA | Related Notice information
@@ -3173,11 +3317,11 @@ reason | string | | No | Publish reason
Name | Data Type |Field Length | Allowed Values | Required (Create/Update) | Required (to Publish) | Description
-----|-----------|-------|-------------------|------------|------------ |----------
-type | string | 1 character| See Notice Types table | Yes | Yes | Notice Type
+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 | Solicitation Number
title | string | 256 characters | |Yes | Yes | Title of the Opportunity
organizationId | string | 32 characters | |No for Create (Yes for Update) | Yes | FH Organization Id/AAC code of the office where an Opportunity is being submitted
-organizationLocationId | string | | | No|No| This field has been deprecated.Organization Location details will be pulled from the Federal Hierarchy
+organizationLocationId | string | | | No|No| This field has been deprecated. Organization Location details will be pulled from the Federal Hierarchy
classificationCode | string | | | No | Yes (not required for type= r) | Product Service Code (PSC)
naics | JSON Array | NA |NA | NA | NA |
naics.code | Array of String | | | No | Yes | Valid NAICS Code
@@ -3186,7 +3330,7 @@ flags | JSON Array| NA |NA | NA | NA |
flags.code | string | |Recovery act | No | No | This is a recovery or Reinvestment Act Action
flags.IsSelected | boolean | |default is 'True' | No | No |
pointOfContact | JSON Array | NA |NA | NA | NA |
-pointOfContact.type | string | | primary, secondary | No | Yes | Contact Type Note: 'p' and 's' must be in lower case
+pointOfContact.type | string | | primary, secondary | No | Yes | 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 | Contact Full Name
pointOfContact.email | string |255 characters | | No | Yes (no if type = a) | Contact email
@@ -3208,8 +3352,8 @@ 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 (if 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
+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 (if 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 'Inerested Vendor's List' where users outside the notice can indicate a desire to submit a proposal. This list in way binds either party
permissions.ivl.create | boolean | | | No | No | IVL create permission
@@ -3217,7 +3361,7 @@ permissions.ivl.read | boolean | | | No | No | IVL read permission
permissions.ivl.update | boolean | | Not In Use | Not In Use | Not In Use | IVL update permission
permissions.ivl.delete | boolean | | Not In Use | Not In Use | Not In Use | IVL delete permission
solicitation | JSON |NA | NA | NA | NA |
-solicitation.setAside | string | |See Set-Aside values table | No | No | Set-Aside code. The designator for type of set aside determined for the contract action
+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)
2) Yes (when archive.type=
auto1) | Deadline Date
solicitation.deadlines.
responseresponseTz |string | | | No | No | Time Zone for
Solicitation Deadline Date
@@ -3250,7 +3394,7 @@ link | JSON | NA |NA | NA | NA |
link.href | string | | | No | No | Url for the notice on SAM.gov
link.additionalInfo | JSON | NA |NA | NA | NA | Any additional information on the opportunity
link.additionalInfo.
content | string | | | No | No | Additional information details
-additionalReporting | string | |none/
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
+additionalReporting | string | |none,
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
description | JSON | NA | NA | NA | NA |
description.body | string | 65535 characters| | No | Yes | Description of the notice
related | JSON | NA | NA | NA | NA | Related Notice information
@@ -3259,7 +3403,7 @@ resources | JSON |NA | NA | NA | NA |
resources.attType | string | |link, file | No |No| Type of attachment, either link or file
resources.content | byte |250MB | | No|No | File content in base64 format
resources.link | string | 255 characters | |No|No | Resource link URL
-resources.packageAccessLevel | string | | public,private(default public) | No | No| Type of access to file
+resources.packageAccessLevel | string | | public,private(default public) | No | No| Type of access to file
resources.resourceName | string | 255 characters | | No|No | Name of file
@@ -3578,26 +3722,20 @@ Name | Data Type | Allowed Values | Required | Description
reason| string| | Yes| Reason for deletion
requestType |string |delete_request |Yes |Type of request
description |string| |Yes| Description for deletion of a notice
-title |string | |No|
-newArchiveDate| date| YYYY-MM-DD| No| New Archive Date
-newArchiveType| string| | No| New Archive Type
deleteOption| string| latest, all| Yes| Option to delete either the latest or all versions of a notice
Response
+Delete Notice Request
{
- "requestType”: delete_request",
- "reason":"test",
+ "reason": "",
+ "requestType": "delete_request",
"data": {
- "description”: “test",
- "title”: null,
- "newArchiveDate":null,
- "newArchiveType":null,
- "deleteOption”: latest" ( “all” - to delete all versions)
- }
-}
+ "description": "",
+ "deleteOption": "all" -- "latest" to delete the latest published version of a notice
+ }
+ }
Create and Publish '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:
{
@@ -1661,10 +1661,8 @@ Examples
]
},
"parent": {
-
},
"related": {
-
},
"status": {
"code": "draft",
@@ -3060,13 +3058,13 @@ organizationId | string | 32 characters | |No for Create (Yes for Update) | Yes
organizationLocationId | string | | | No|No| This field has been deprecated. Organization Location details will be pulled from the Federal Hierarchy
classificationCode | string | | | No | Yes (not required for type= r) | Product Service Code (PSC)
naics | JSON Array | NA |NA | NA | NA |
-naics.code | Array of String | | | No | Yes | Valid NAICS Code
+naics.code | Array of String | | | No | Yes | Valid NAICS Code
NAICS Reference
naics.type | string | |primary| No | Yes | NAICS Type Note: 'p' must be in lower case
flags | JSON Array| NA |NA | NA | NA |
flags.code | string | |Recovery act | No | No | This is a recovery or Reinvestment Act Action
flags.IsSelected | boolean | |default is 'True' | No | No |
pointOfContact | JSON Array | NA |NA | NA | NA |
-pointOfContact.type | string | | primary, secondary | No | Yes | Contact Type Note: 'p' and 's' must be in lower case
+pointOfContact.type | string | | primary,
secondary | No | Yes | 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 | Contact Full Name
pointOfContact.email | string |255 characters | | No | Yes (no if type = a) | Contact email
@@ -3088,16 +3086,16 @@ 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 (if 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
+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 (if 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 'Inerested Vendor's List' where users outside the notice can indicate a desire to submit a proposal. This list in way binds either party
permissions.ivl.create | boolean | | | No | No | IVL create permission
permissions.ivl.read | boolean | | | No | No | IVL read permission
-permissions.ivl.update | boolean | | Not In Use | Not In Use | Not In Use | IVL update permission
-permissions.ivl.delete | boolean | | Not In Use | Not In Use | Not In Use | IVL delete 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.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)
2) Yes (when archive.type=
auto1) | Deadline Date
solicitation.deadlines.
responseresponseTz |string | | | No | No | Time Zone for
Solicitation Deadline Date
@@ -3324,13 +3322,13 @@ organizationId | string | 32 characters | |No for Create (Yes for Update) | Yes
organizationLocationId | string | | | No|No| This field has been deprecated. Organization Location details will be pulled from the Federal Hierarchy
classificationCode | string | | | No | Yes (not required for type= r) | Product Service Code (PSC)
naics | JSON Array | NA |NA | NA | NA |
-naics.code | Array of String | | | No | Yes | Valid NAICS Code
+naics.code | Array of String | | | No | Yes | Valid NAICS Code
NAICS Reference
naics.type | string | |primary| No | Yes | NAICS Type Note: 'p' must be in lower case
flags | JSON Array| NA |NA | NA | NA |
flags.code | string | |Recovery act | No | No | This is a recovery or Reinvestment Act Action
flags.IsSelected | boolean | |default is 'True' | No | No |
pointOfContact | JSON Array | NA |NA | NA | NA |
-pointOfContact.type | string | | primary, secondary | No | Yes | Contact Type Note: 'p' and 's' must be in lower case
+pointOfContact.type | string | | primary,
secondary | No | Yes | 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 | Contact Full Name
pointOfContact.email | string |255 characters | | No | Yes (no if type = a) | Contact email
@@ -3352,16 +3350,16 @@ 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 (if 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
+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 (if 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 'Inerested Vendor's List' where users outside the notice can indicate a desire to submit a proposal. This list in way binds either party
permissions.ivl.create | boolean | | | No | No | IVL create permission
permissions.ivl.read | boolean | | | No | No | IVL read permission
-permissions.ivl.update | boolean | | Not In Use | Not In Use | Not In Use | IVL update permission
-permissions.ivl.delete | boolean | | Not In Use | Not In Use | Not In Use | IVL delete 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.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)
2) Yes (when archive.type=
auto1) | Deadline Date
solicitation.deadlines.
responseresponseTz |string | | | No | No | Time Zone for
Solicitation Deadline Date
@@ -3403,7 +3401,7 @@ resources | JSON |NA | NA | NA | NA |
resources.attType | string | |link, file | No |No| Type of attachment, either link or file
resources.content | byte |250MB | | No|No | File content in base64 format
resources.link | string | 255 characters | |No|No | Resource link URL
-resources.packageAccessLevel | string | | public,private(default public) | No | No| Type of access to file
+resources.packageAccessLevel | string | | public,
private
(default public) | No | No| Type of access to file
resources.resourceName | string | 255 characters | | No|No | Name of file
From 65f614ca5f185651660069cf4be4d80aace4723d Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
NAICS Reference
+naics.code | Array of String | | NAICS Reference| No | Yes | Valid NAICS Code
naics.type | string | |primary| No | Yes | NAICS Type Note: 'p' must be in lower case
flags | JSON Array| NA |NA | NA | NA |
flags.code | string | |Recovery act | No | No | This is a recovery or Reinvestment Act Action
@@ -3322,7 +3322,7 @@ organizationId | string | 32 characters | |No for Create (Yes for Update) | Yes
organizationLocationId | string | | | No|No| This field has been deprecated. Organization Location details will be pulled from the Federal Hierarchy
classificationCode | string | | | No | Yes (not required for type= r) | Product Service Code (PSC)
naics | JSON Array | NA |NA | NA | NA |
-naics.code | Array of String | | | No | Yes | Valid NAICS Code
NAICS Reference
+naics.code | Array of String | | NAICS Reference| No | Yes | Valid NAICS Code
naics.type | string | |primary| No | Yes | NAICS Type Note: 'p' must be in lower case
flags | JSON Array| NA |NA | NA | NA |
flags.code | string | |Recovery act | No | No | This is a recovery or Reinvestment Act Action
From 4ecdbbe1e0d5eb64daad75c98ec4e1f058e93318 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 15:59:19 -0400
Subject: [PATCH 079/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 5c713532d..39cc9479d 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -1344,6 +1344,7 @@ Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | Header | string | Yes | Valid and authorized user ID
api_key | query | string | Yes | Valid System Account API Key
+opportunityId | query | string | Yes | Opportunity ID
Request JSON| Body| JSON| Yes| [Refer Delete Notice JSON](#delete-notice-json)
Responses
@@ -2526,7 +2527,7 @@ Parameter Name | Parameter Type | Data Type | Required | Description
Authorization| Header| string| Yes|Valid and authorized user ID
Api_key query | string| Yes| Valid System Account API Key
ResourceID |query| string| Yes | Resource ID
-
+excludeDeleted | query | string | No|
Responses
@@ -2582,7 +2583,7 @@ 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
-
+excludeDeleted | query | string | No|
Responses
@@ -2686,7 +2687,6 @@ Parameter Name | Parameter Type | Data Type | Required | Description
Authorization| Header |string |Yes |Valid and authorized user ID
api_key| query| string| Yes| Valid API Key
opportunityId |query |string| Yes| Opportunity ID
-status| query| string| No| Request access status can be: Pending, Approved, Rejected, or blank to get all request details for a notice
Responses
From 60ffd5e87b49f880f897b14d75f379444e846dfc Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 16:20:38 -0400
Subject: [PATCH 080/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 9e6be441f..75ef05499 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -3635,7 +3635,7 @@ Flash Video (.flv, .f4v)| video/x-flv
-### Update Attachment Link Contract JSON
+### Update Attachment Contract JSON
Update_Link_Contract_Json
From 0becb1a53d5584e6109af9f1f5bcfa4fbb601771 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 16:22:18 -0400
Subject: [PATCH 081/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 56 ++++++++++++++++--------------
1 file changed, 29 insertions(+), 27 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 3f6edb65a..9c3edc584 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -128,9 +128,9 @@ The Notice Types valid options are:
#### Related Notices
-This is a conversion table for notices using following functions: submitNotice, submitJA, submitAward, submitITB
+The table below lists notices that can be related.
-||SRCSGT | PRESOL | COMBINE | SOL| AWARD | SSALE | ITB | JA | SNOTE
+|*Below Notice can be Related to:*|SRCSGT | PRESOL | COMBINE | SOL| AWARD | SSALE | ITB | JA | SNOTE
-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|
|**SRCSGT**||O|O|O|O|O|||O
|**PRESOL**|O||O|O||O|O|O|O
@@ -228,7 +228,7 @@ DocumentLink Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-Desc | string | No | Description/Title | 255 characters
+desc | string | No | Description/Title | 255 characters
DocumentFile Complex Type Definition
@@ -317,7 +317,7 @@ offadd | string | No | Office Address (Deprecated). The Contracting office addre
officeid | String | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
subject | string | No | Subject | 256 characters
solnbr |string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype | string | No | Notice Type | [Refer Notice Types](#notice-types)
+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 | Yes | Contact Info | 255 characters
@@ -378,7 +378,7 @@ GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address | string | No |Email Address |255 characters
+address | string | Yes |Email Address |255 characters
desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition:
@@ -449,7 +449,7 @@ GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address | string | Yes | Email Address | 255 characters
-desc | string | Yes | Description | 255 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition:
@@ -495,8 +495,8 @@ offadd | string | No | Office Address (Deprecated). The Contracting office addre
subject | string | no | 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 | Yes | Notice Type | Valid values: PRESOL, COMBINE, SRCSGT, SSALE, SNOTE, SOL
-respdate| date| Yes - for COMBINE, SOL
Either respdate or archdate required for SNOTE, SSALE, SRCSGT, PRESOL |Response Date |YYYYMMDD
-archdate | date| No - Either respdate or archdate required for SNOTE, SSALE, SRCSGT, PRESOL| Archive Date| YYYYMMDD
+respdate| date| Yes - for COMBINE, SOL
Either respdate or archdate required for SRCSGT, PRESOL |Response Date |YYYYMMDD
+archdate | date| Yes - for SNOTE, SSALE
Either respdate or archdate required for SRCSGT, PRESOL| Archive Date| YYYYMMDD
contact | string | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL | Contact Info | 255 characters
desc | string | Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
@@ -521,7 +521,7 @@ GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address | string | Yes | Email Address | 255 characters
-desc | string | Yes | Description | 255 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition:
@@ -666,7 +666,7 @@ GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address | string | Yes | Email Address | 255 characters
-desc | string | Yes | Description | 255 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition:
@@ -736,7 +736,7 @@ GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address |string| Yes| Email Address |255 characters
-desc |string |Yes |Description |255 characters
+desc |string |No |Description |255 characters
DocumentLink Complex Type Definition:
@@ -749,8 +749,8 @@ DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | No | File Name | 255 characters
+filedata | base64binary | No | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -802,7 +802,7 @@ GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address| string| Yes| Email Address |255 characters
-desc |string |Yes |Description |255 characters
+desc |string |No |Description |255 characters
DocumentLink Complex Type Definition:
@@ -873,7 +873,7 @@ GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address | string | Yes | Email Address | 255 characters
-desc | string | Yes | Description | 255 characters
+desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition:
@@ -936,14 +936,14 @@ GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
url |string |No |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string| No| Description| 255 characters
+desc |string| No - Yes, if URL provided| Description| 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
address |string |Yes| Email Address |255 characters
-desc| string| No |Description| 255 characters
+desc| string| No |Description| 255 characters
DocumentLink Complex Type Definition:
@@ -952,6 +952,8 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
url| string| No |External URL| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
desc| string| No| Description/Title |255 characters
+DocumentFile Complex Type Definition
+
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
filename | string | No | File Name | 255 characters
@@ -998,8 +1000,8 @@ 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 SNOTE, SSALE, SRCSGT, PRESOL |Response Date |YYYYMMDD
-archdate | date| No - Either respdate or archdate required for SNOTE, SSALE, SRCSGT, PRESOL| Archive Date| YYYYMMDD
+respdate| date| Yes - for COMBINE, SOL
Either respdate or archdate required for SRCSGT, PRESOL |Response Date |YYYYMMDD
+archdate | date| Yes - for SNOTE, SSALE
Either respdate or archdate required for SRCSGT, PRESOL| Archive Date| YYYYMMDD
awardee| string| Yes – for AWARD | Awardee |65535 characters
awardee_duns| string |No |Awardee DUNS |9 digits with optional plus 4
contact| string| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL| Contact Info| 255 characters
@@ -4080,23 +4082,23 @@ Element Name | Business Rules | Error Messages with respect to business rules (I
date |1. This field should meet the character limit/restrictions
Note: Date field allows current date and also any date in past/future | 1. DATE field in unexpected format. Expects YYYYMMDD
notice_type | 1. This field is required where applicable | 1. Opportunity type is required
zip| NA |NA
-classcod |1. This field is required where applicable
2.If a wrong classification code is given, then the service throws an error | 1. PSC code is required
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
+classcod |1. This field is required where applicable
2.If a wrong classification code is given, then the service throws an error | 1. Product Service Code is a required field
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
naics |NA | NAICS code is required
offadd| Not Used| NA
officeid |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If user does not have access to an office but is trying to make a submission to that office, then the service throws an error
|1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject | 1. This field is required where appicable |1. $.data.title: is missing but it is required
-solnbr| 1. This field is required where applicable
2. If submitting a notice with same solnbr number, then system throws an error
3. If solnbr is in invalid format, then service throws an error
4. If solicitation & ntype combination is not matched, then service throws an error| 1. Notice Id is required
2. Notice Id for the selected opportunity type already exists
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
+solnbr| 1. This field is required where applicable
2. If submitting a notice with a duplicabe 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 for the selected opportunity type already exists
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
5. Notice ID must be unique based on selected notice type
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. This field accepts only valid values listed. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
awdnbr| 1. This field is required where applicable| 1. Award Details Section - Contract Award Number is a required field
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. Award Details Section - Task/Delivery Order Number is required field
2. Award Details Section - Task/Delivery Order Number - Please enter a valid number
awdamt| 1. This field is required where applicable
2. If an invalid integer values is given, then service throws an error |1. Award Details Section - Amount is a required field
2. Award Details Section - Please enter valid integer for Amount Field
linenbr| NA |NA
-awddate | 1. This field should meet the character limit/restrictions (Note: Date field allows current date and also any date in past/future)
2. This field is required where applicable| 1. DATE field in unexpected format. Expects YYYYMMDD
2. Award Details Section - Contract Award Date is required field
3. Award Details Section - Contract Award Date provided is in an invalid format
-stauth| Both foja & stauth values will be given under stauth in legacy | NA
+awddate | 1. This field should meet the character limit/restrictions
2. This field is required where applicable
3. Date cannot be in the past| 1. DATE field in unexpected format. Expects YYYYMMDD
2. Award Details Section - Contract Award Date is required field
3. Award Details Section - Contract Award Date provided is in an invalid format
4. Award date provided is in the past.
5.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. Contract Award Number 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 is required where applicable
2. This date cannot be in past; has to be in future. If the given date is in past, then system throws errors | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
4. One of Response date or Archive date is required
5. One of Response date or Archive date is required
archdate| 1. This field is required where applicable. Note user may receive "Auto 30
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
3. One of Response date or Archive date is required
awardee | NA| NA
-awardee_duns| NA| NA
+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
desc| 1. This field is required where applicable.| 1. Description is required
link| NA | NA
@@ -4116,7 +4118,7 @@ correction| 1. When user tries to convert a notice and the solicitation number/n
#### submitDocumentsAndLinksToNotice
Individual business rules per field are listed across each of the fields in below table.
-* Note: Users cannot verify the attachments/links on front end (UI.)
+* Note: Users cannot verify the attachments/links on front end (UI)
* Note: When none of the fields are given the service throws an error - Links and/or Files are not complete
* Note: When links/files are given but none of the other fields are given, then service throws an error - Multiple Notices found. Please input more details
@@ -4395,8 +4397,8 @@ Date | Version | Description
8/19/2019 | v0.5 | SUBMITPRESOL/SOURCESSOUGHT, SUBMITCOMBINED, SUBMITAWARD, SUBMITSALEOFSURPLUS, SUBMITJA, SUBMITITB, SUBMITSPECIANOTICE, SUBMITMOD, ARCHIVENOTICE, UNARCHIVENOTICE, CANCELNOTICE, SUBMITDOCUMENTSANDLINKS, GETLIST, GETNOTICEDATA, GETFILEDATA, DELETENOTICE parameters updated
User Account Section Updated
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| Removed redundant Required and Character Limit columns from Business Rules section. Consolidated Business Rules section for all Submit methods. Updated submitMod and submitNotice methods to align with implemenation.
-10/28/2019 | v0.81 | Updated the character limits
+10/28/2019 | v0.8| Added Notice Type and Related Notice sections for reference. Updated the character limits. Removed redundant Required and Character Limit columns from Business Rules section. Consolidated Business Rules section for all Submit methods. Updated submitMod and submitNotice methods to align with implemenation.
+
From 6f29d29e1b7dca5743f28e224a68d1be70dbb79f Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 16:28:33 -0400
Subject: [PATCH 082/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 75ef05499..90cf9312b 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -2221,7 +2221,7 @@ Authorization | Header | string | Yes | Valid and authorized user ID
api_key | query | string | Yes | Valid System Account API Key
opportunityId | query | string | Yes | Opportunity ID
resourceId | query | string | Yes | Resource ID
-Request JSON | Body | JSON | Yes | [Refer Update Attachment Link Contract JSON](#update-attachment-link-contract-json)
+Request JSON | Body | JSON | Yes | [Refer Update Attachment Link Contract JSON](#update-attachment-contract-json)
From 713b55f542dd854083e994e896a6248145292564 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 16:42:18 -0400
Subject: [PATCH 083/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 9c3edc584..f65391127 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -1331,7 +1331,7 @@ solnbr| string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -
ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
-reason |string| Yes| rejection reason not used in this method|
+reason |string| Yes| rejection reason not used in this method| 65535 characters
Response:
From b9825566324d6116ca92a04a95f34c7242da7363 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Tue, 29 Oct 2019 19:44:13 -0400
Subject: [PATCH 084/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index f65391127..9e3d3a43c 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -15,7 +15,7 @@ The Opportunity Management SOAP APIs will allow authorized users to submit and r
To view the WSDL for all available methods and object definitions, refer below links:
* Alpha WSDL Link: https://api-alpha.sam.gov/prodlike/ws/fboendpoint/services.wsdl or https://api-alpha.sam.gov/prodlike/ws/fboendpoint/fbo.wsdl
-* Beta WSDL Link: https://api.sam.gov/prod/ws/fboendpoint/services.wsdl or https://api.sam.gov/prod/ws/fboendpoint/fbo.wsdl
+* Beta WSDL Link: https://api.sam.gov/prod/ws/fboendpoint/services.wsdl or https://api.sam.gov/prod/ws/fboendpoint/fbo.wsdl (Coming Soon)
## SOAP Web Services Workflow Chart
To view the current workflow of SOAP web service, refer below file:
@@ -716,8 +716,8 @@ offadd | String | No | Office Address (Deprecated). The Contracting office addre
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 | No | Contact Info | 65535 characters
-desc | String | Yes | Description | 255 characters
+contact | String | No | Contact Info | 255 characters
+desc | String | Yes | Description | 65535 characters
link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
email | GovEmail – complex type | Yes | Government Email | 255 characters
links | DocumentLink[] | No | Array Of links |
@@ -1013,7 +1013,7 @@ files |DocumentFile[]| No| Array of files |
setaside| string| No| [Refer Set-Aside Values](#set-aside-values) |
popaddress| string| No| Place of Performace Addressress |65535 characters
popzip| string |No |Place of Performace Zip |5 digits
-popcountry| string| Yes – For wards; No – For rest| Place of Performace Country| 32 characters
+popcountry| string| Yes – For Awards; No – For rest| Place of Performace Country| 32 characters
city| string| No |City |NA
state| string| No| State |NA
recovery_act |boolean| No| Recovery Act| True or False
From fc5add45b5269d4b48c47f5202114bbc63094cbf Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Wed, 30 Oct 2019 08:59:03 -0400
Subject: [PATCH 085/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 90cf9312b..dcdace768 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -37,10 +37,10 @@ To view the current workflow of REST APIs, refer below file:
In order to utilize the Contract Opportunity Management API, the following is required:
* Valid beta.SAM.GOV federal government system account with Read and Write permissions under Contract Opportunity domain.
-### *Type of Connection Validation (Future Implementation)*
+### Type of Connection Validation
All REST API requests will be validated against the Type of Connection within the system account profile. All requests without "REST API" type of connection in the system account profile will be rejected with an error.
-### *IP Address Validation (Future Implementation)*
+### IP Address Validation
All REST API requests will be validated against the IP Addresses registered within the system account profile. All requests that are not from registered IP address(es) in the system account profile will be rejected with an error.
#### User Account Authorization
From e0d7dcaf84955fa141c1e413bb6680342e03444d Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Wed, 30 Oct 2019 11:29:51 -0400
Subject: [PATCH 086/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 9e3d3a43c..6d334de5c 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -183,7 +183,7 @@ Award Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | Yes | Posting Date | YYYYMMDD
+date | date | No | Posting Date | YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
@@ -486,7 +486,7 @@ Mod Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | Yes - for AWARD | Posting Date | YYYYMMDD
+date | date | No | Posting Date | YYYYMMDD
zip | string | No |Zip Code (Deprecated) | 5 digits
classcod | string | Yes - for SOL, COMBINE, SSALE, ITB, JA | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes - for COMBINE, SOL | NAICS Code | Valid NAICS Code
NAICS Reference
From 947e1527ea090a2c7cb89b02ef16219e3c30fba7 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Wed, 30 Oct 2019 13:23:31 -0400
Subject: [PATCH 087/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 6d334de5c..a317cd5ff 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -347,7 +347,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date | YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
-classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
@@ -987,7 +987,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date| date| No |Posting Date| YYYYMMDD
notice_type |string |Yes| [Refer Notice Types](#notice-types) |
zip |string |No |Zip Code (Deprecated)| 5 digits
-classcod| string| Yes - for SOL, COMBINE, SSALE, ITB, JA | Class-Code |Valid classification code (FAR, Section 5.207(g))
+classcod| string| Yes - for SOL, COMBINE, SSALE, ITB, JA, PRESOL | Class-Code |Valid classification code (FAR, Section 5.207(g))
naics |string |Yes - for COMBINE, SOL |NAICS Code| Valid NAICS Code
NAICS Reference
officeid| String| Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account |20 characters
offadd |string| No| Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy |65535 characters
@@ -1000,8 +1000,8 @@ 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 |Response Date |YYYYMMDD
-archdate | date| Yes - for SNOTE, SSALE
Either respdate or archdate required for SRCSGT, PRESOL| Archive Date| YYYYMMDD
+respdate| date| Yes - for COMBINE, SOL
Either respdate or archdate required for SRCSGT, PRESOL, SSALE |Response Date |YYYYMMDD
+archdate | date| Either respdate or archdate required for SRCSGT, PRESOL, SSALE, SNOTE| Archive Date| YYYYMMDD
awardee| string| Yes – for AWARD | Awardee |65535 characters
awardee_duns| string |No |Awardee DUNS |9 digits with optional plus 4
contact| string| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL| Contact Info| 255 characters
From 9b71867258f82092b33ec4764f5f253440101e28 Mon Sep 17 00:00:00 2001
From: Diego Ruiz
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)
2) Yes (when archive.type=
auto1) | Deadline Date
-solicitation.deadlines.
responseresponseTz |string | | | No | No | Time Zone for
Solicitation 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 Notice' and 'Justification' opportunity types
award.date | date | |YYYY-MM-DD |No | Yes only for type= a | Award Date
award.number | string | 255 characters | |No | Yes only for type= i, j, a | Award Number
From dc53a030022839d1972341f14264537c0ef62033 Mon Sep 17 00:00:00 2001
From: Diego Ruiz
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)
2) Yes (when archive.type=
auto1) | Deadline Date
-solicitation.deadlines.
responseresponseTz |string | | | No | No | Time Zone for
Solicitation 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 Notice' and 'Justification' opportunity types
award.date | date | |YYYY-MM-DD |No | Yes only for type= a | Award Date
award.number | string | 255 characters | |No | Yes only for type= i, j, a | Award Number
From 6ca9ff49134c82559cf240bac8e7d4aa2a1cfa0a Mon Sep 17 00:00:00 2001
From: Ashwin-Deshmukh-REISystems
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
+offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
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
@@ -1266,7 +1266,8 @@ solnbr| string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_
ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
-
+vendor |VendorData| No| Complex type not used in this method|
+reason |string| No| rejection reason not used in this method| 65535 characters
Response:
@@ -1291,7 +1292,9 @@ Element Name |Type |Required| Description | Character Limit / Restrictions
solnbr |string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype| string| No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method|
-vendor| VendorData |Yes| Complex type defined below|
+Id |string |No |Not used in this method| 32 characters
+vendor |VendorData| Yes| Complex type defined below|
+reason |string| No| rejection reason not used in this method| 65535 characters
Response:
@@ -1329,7 +1332,8 @@ solnbr| string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -
ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
-reason |string| Yes| rejection reason not used in this method|
+vendor |VendorData| No| Complex type not used in this method|
+reason| string| Yes |Rejection Reason | 65535 characters
Response:
@@ -1355,6 +1359,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string |No |Non-fbo Solicitation #. Not supported for this method|
+Id |string |No |Not used in this method| 32 characters
vendor |VendorData| Yes| Complex type defined below|
reason| string| Yes |Rejection Reason | 65535 characters
@@ -1391,8 +1396,9 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No |Non-fbo Solicitation #. Not supported for this method.|
-Id |string |No |Not used in this method|
+Id |string |No |Not used in this method| 32 characters
vendor |VendorData| Yes| Complex type defined below|
+reason |string| No| rejection reason not used in this method| 65535 characters
Response:
From 1b066302cb00957ad49b721e6cc1d9208b9a9fff Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
NAICS Reference
@@ -192,50 +192,50 @@ officeid | string | Yes | Office ID of the office where an opportunity is being
subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype | string | No | [Refer Related Notices](#related-notices) |
-awdnbr |String | Yes | Award Number | 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
+awdnbr | string | Yes | Award Number | 255 characters from the set: a-z A-Z 0-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 | Yes | Awardee | 255 characters
-awardee_duns | string | No | Awardee DUNS | 9 digits with optional plus 4
+awardee | string | No; Either awardee or awardee_duns is required | Awardee | 255 characters
+awardee_duns | string | No; No; Either awardee or awardee_duns is required | Awardee DUNS | 9 digits with optional plus 4
contact | string | No | Contact Info | 255 characters
desc | string | No | Description | 65535 characters
-link | GovURL | No | Government Link |255 characters. Consist of a restricted set of characters (see URL specification - RFC 2396)
+link | GovURL | No | Government Link |
email | GovEmail | No | Government Email | 255 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
-recovery_act | boolean | No | Recovery Act | True or False
+recovery_act | boolean | No | Recovery Act | True or False (default=False)
correction | boolean | No | Correction of previous Award | True or False
If correcting a previously submitted Award notice, specify True and the system will lookup the award by award number and sol number if applicable.
GovURL Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description | 255 characters
+url | string | Yes | Website Address | 255 characters
+desc | string | Yes | Description | 255 characters
GovEmail Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address | string | No | Email Address | 255 characters
+address | string | Yes | Email Address | 255 characters
desc | string | No | Description | 255 characters
DocumentLink Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description/Title | 255 characters
+url | string | Yes | External URL | 255 characters
+desc | string | Yes | Description/Title | 255 characters
DocumentFile Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -260,9 +260,9 @@ DeleteNoticeOrDocumentPackage Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-solnbr | string | Yes; Solicitation # or Award # is required | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | Notice Type | [Refer Notice Types](#notice-types)
-awdnbr | string | Yes; Solicitation # or Award # is required| Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
+solnbr | string | Yes; Either Solicitation # or Award # is required only for Award| Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
+ntype | string | No; Yes if there are multiple notices with same Solicitation # | Notice Type | [Refer Notice Types](#notice-types)
+awdnbr | string | Yes; Either Solicitation # or Award # is required ony for Award| Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
deletetype | string | No | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod | string | No | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
@@ -286,10 +286,10 @@ ArchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | No | Posting Date | YYYYMMDD
+date | date | No | Posting Date (Deprecated)| YYYYMMDD
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
ntype | string | No | Notice Type | [Refer Notice Types](#notice-types)
-archdate | date | No | New Archive Date – If none provided, notice will archive immediately | YYYYMMDD
+archdate | date | No | Deprecated. Notice will archive immediately | YYYYMMDD
officeid | string | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
### Cancel Notice
(CancelNotice)
@@ -312,15 +312,15 @@ CancelNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | No | Posting Date | YYYYMMDD
+date | date | No | Posting Date (Deprecated) | YYYYMMDD
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
-officeid | String | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
+officeid | String | No | OfficeID (Not in Use)| 20 characters
subject | string | No | Subject | 256 characters
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 | Yes | Contact Info | 255 characters
+contact | string | No | Contact Info | 255 characters
desc | string | Yes | Cancellation Description | 65535 characters
## Contracting Officer/Contracting
Specialist Method Details
@@ -345,7 +345,7 @@ Presol Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | No | Posting Date | YYYYMMDD
+date | date | No | Posting Date (Deprecated) | YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
@@ -357,21 +357,21 @@ respdate | date | No - either respdate or archdate is required | Response Date |
archdate | date | No - either respdate or archdate is required | Archive Date | YYYYMMDD
contact | string | Yes | Contact Info | 255 characters
desc |string |Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link has URL & description | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+link | GovURL – complex type | No | Government Link has URL & description | 255 characters
email | GovEmail – complex type | Yes | Government Email | 255 characters
links | DocumentLink[] | No | Array of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
-popaddress | string | No | Place of Performace Address | 65535 characters
-popzip |string | No | Place of Performace Zip | 5 digits
-popcountry | string | No | Place of Performace Country | 32 characters
-recovery_act | boolean | No | Recovery Act | True or False
+popaddress | string | No | Place of Performance Address | 65535 characters
+popzip |string | No | Place of Performance Zip | 5 digits
+popcountry | string | No | Place of Performance Country | 32 characters
+recovery_act | boolean | No | Recovery Act | True or False (default=False)
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+url | string | No | Website Address | 255 characters
desc | string | No | Description | 255 characters
GovEmail Complex Type Definition:
@@ -385,15 +385,15 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description/Title | 255 characters
+url | string | Yes | External URL | 255 characters
+desc | string | Yes | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -416,7 +416,7 @@ Combined Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | No | Posting Date | YYYYMMDD
+date | date | No | Posting Date (Deprecated) | YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes | NAICS Code | Valid NAICS Code
NAICS Reference
@@ -427,22 +427,22 @@ respdate | date | Yes | Response Date | YYYYMMDD
archdate | date | No | Archive Date | YYYYMMDD
contact | string |Yes | Contact Info | 255 characters
desc | string | Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+link | GovURL – complex type | No | Government Link | 255 characters
email | GovEmail – complex type | Yes | Government Email | 255 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
-popaddress | string | No | Place of Performace Address | 65535 characters
-popzip | string | No | Place of Performace Zip | 5 digits
-popcountry | string | No | Place of Performace Country | 32 characters
-recovery_act | boolean | No | Recovery Act | True or False
+popaddress | string | No | Place of Performance Address | 65535 characters
+popzip | string | No | Place of Performance Zip | 5 digits
+popcountry | string | No | Place of Performance Country | 32 characters
+recovery_act | boolean | No | Recovery Act | True or False (default = false)
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description | 255 characters
+url | string | Yes | Website Address | 255 characters
+desc | string | Yes | Description | 255 characters
GovEmail Complex Type Definition:
@@ -455,15 +455,15 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description/Title | 255 characters
+url | string | Yes | External URL | 255 characters
+desc | string | Yes | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -486,35 +486,35 @@ Mod Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | No | Posting Date | YYYYMMDD
+date | date | No | Posting Date (Deprecated) | YYYYMMDD
zip | string | No |Zip Code (Deprecated) | 5 digits
-classcod | string | Yes - for SOL, COMBINE, SSALE, ITB, JA | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | Yes - for SOL, COMBINE, SSALE, ITB, JA, PRESOL | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes - for COMBINE, SOL | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
-subject | string | no | Subject | 256 characters
-solnbr | string | Yes, EXCEPT No - Only for SNOTE | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
+subject | string | Yes | Subject | 256 characters
+solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
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 |Response Date |YYYYMMDD
-archdate | date| Yes - for SNOTE, SSALE
Either respdate or archdate required for SRCSGT, PRESOL| Archive Date| YYYYMMDD
-contact | string | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL | Contact Info | 255 characters
-desc | string | Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email | GovEmail – complex type | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL, SNOTE | Government Email | 255 characters
+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
+desc | string | Yes - for PRESOL, COMBINE, SRCSGT, SSALE, SOL, SNOTE | Description | 65535 characters
+link | GovURL – complex type | No | Government Link | 255 characters
+email | GovEmail – complex type | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, SOL | Government Email | 255 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
-popaddress | string | No | Place of Performace Address | 65535 characters
-popzip | string | No | Place of Performace Zip | 5 digits
-popcountry | string | No | Place of Performace Country | 32 characters
-recovery_act | boolean | No | Recovery Act | True or False
+popaddress | string | No | Place of Performance Address | 65535 characters
+popzip | string | No | Place of Performance Zip | 5 digits
+popcountry | string | No | Place of Performance Country | 32 characters
+recovery_act | boolean | No | Recovery Act | True or False (Default = False)
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description | 255 characters
+url | string | Yes | Website Address | 255 characters
+desc | string | Yes | Description | 255 characters
GovEmail Complex Type Definition:
@@ -527,15 +527,15 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description/Title | 255 characters
+url | string | Yes | External URL | 255 characters
+desc | string | Yes | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -558,7 +558,7 @@ JA Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | Date | No | Posting Date | YYYYMMDD
+date | Date | No | Posting Date (Deprecated) | YYYYMMDD
zip | String | No | Zip Code (Deprecated) | 5 digits
classcod | String | Yes | Class-Code | Valid classification code
naics | String | No | NAICS Code | Valid NAICS Code
NAICS Reference
@@ -570,25 +570,25 @@ ntype | string | No | [Refer Related Notices](#related-notices) |
stauth | String | Yes | J&A StatutoryAuthority
Note: Both foja & stauth values will be given under stauth in legacy | [Refer Stauth Valid Values](#stauth-valid-values)
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 | 64 digits
+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 - _ ( )
archdate | Date | No | Archive Date | YYYYMMDD
contact | String | Yes | Contact Info | 255 characters
desc | String | No | Description | 65535 characters
-link | GovURL | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+link | GovURL | No | Government Link | 255 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
email | GovEmail | Yes | Government Email | 255 characters
-recovery_act | boolean | No | Recovery Act | True or False;
+recovery_act | boolean | No | Recovery Act | True or False (Default = False)
correction | boolean | No | Correction of previous J&A | True or False
If correcting a previously submitted J&A notice, specify True and the system will lookup the j&a by award number and sol number if applicable.
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description | 255 characters
+url | string | Yes | Website Address | 255 characters
+desc | string | Yes | Description | 255 characters
GovEmail Complex Type Definition:
@@ -601,15 +601,15 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description/Title | 255 characters
+url | string | Yes | External URL | 255 characters
+desc | string | Yes | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -632,7 +632,7 @@ SourcesSought Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | No | Posting Date | YYYYMMDD
+date | date | No | Posting Date (Deprecated)| YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
@@ -644,22 +644,22 @@ respdate | date | No - either respdate or archdate is required | Response Date |
archdate | date | No - either respdate or archdate is required | Archive Date | YYYYMMDD
contact | string | Yes | Contact Info | 255 characters
desc | string | Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email | GovEmail – complex type | Yes | Government Email | 128 characters
+link | GovURL – complex type | No | Government Link | 255 characters
+email | GovEmail – complex type | Yes | Government Email | 255 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
-popaddress | string | No | Place of Performace Address | 65535 characters
-popzip | string | No | Place of Performace Zip | 5 digits
-popcountry | string | No | Place of Performace Country | 32 characters
-recovery_act | boolean | No | Recovery Act | True or False
+popaddress | string | No | Place of Performance Address | 65535 characters
+popzip | string | No | Place of Performance Zip | 5 digits
+popcountry | string | No | Place of Performance Country | 32 characters
+recovery_act | boolean | No | Recovery Act | True or False (Default = False_)
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description | 255 characters
+url | string | Yes | Website Address | 255 characters
+desc | string | Yes| Description | 255 characters
GovEmail Complex Type Definition:
@@ -672,15 +672,15 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description/Title | 255 characters
+url | string | Yes | External URL | 255 characters
+desc | string | Yes | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -707,50 +707,50 @@ SpecialNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | Date | No | Posting Date | YYYYMMDD
+date | Date | No | Posting Date (Deprecated) | YYYYMMDD
zip | String | No | Zip Code (Deprecated)| 5 digits
classcod | String | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | String | No | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | String | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | String | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
subject | String | Yes | Subject | 256 characters
-solnbr | String | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
+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
desc | String | Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email | GovEmail – complex type | Yes | Government Email | 255 characters
+link | GovURL – complex type | No | Government Link | 255 characters
+email | GovEmail – complex type | Yes if contact is provided | Government Email | 255 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
-recovery_act | boolean | No | Recovery Act | True or False
+recovery_act | boolean | No | Recovery Act | True or False (Default = False)
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |No| Website Address| 255 characters, consist of a restricted set of characters (see URL specification - RFC2396)
-desc| string |No| Description| 255 characters
+url |string |Yes| Website Address| 255 characters
+desc| string |Yes| Description| 255 characters
GovEmail Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-address |string| Yes| Email Address |255 characters
+address |string| Yes | Email Address |255 characters
desc |string |No |Description |255 characters
DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string| No |External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string |No |Description/Title |255 characters
+url |string| Yes |External URL |255 characters
+desc |string |Yes |Description/Title |255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string |Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -773,7 +773,7 @@ SaleOfSurplus Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date| No| Posting Date| YYYYMMDD
+date | date| No| Posting Date (Deprecated| YYYYMMDD
zip| string| No| Zip Code (Deprecated) | 5 digits
classcod| string| Yes |Class-Code| Valid classification code (FAR, Section 5.207(g))
naics| string| No| NAICS Code| Valid NAICS Code
NAICS Reference
@@ -784,18 +784,18 @@ 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
desc| string |Yes| Description |65535 characters
-link |GovURL – complex type| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email |GovEmail – complex type |Yes| Government Email| 128 characters
+link |GovURL – complex type| No| Government Link |255 characters
+email |GovEmail – complex type |Yes| Government Email| 255 characters
links| DocumentLink[]| No |Array Of links |
files |DocumentFile[]| No |Array of files |
-recovery_act| boolean |No |Recovery Act |True or False
+recovery_act| boolean |No |Recovery Act |True or False (Default = False)
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |No |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string |No |Description |255 characters
+url |string |Yes |Website Address |255 characters
+desc |string |Yes |Description |255 characters
GovEmail Complex Type Definition:
@@ -808,15 +808,15 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url| string| No| External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string| No| Description/Title |255 characters
+url| string| Yes| External URL |255 characters
+desc |string| Yes| Description/Title |255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -839,34 +839,34 @@ Solicitation Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date | date | No | Posting Date | YYYYMMDD
+date | date | No | Posting Date (Deprecated)| YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
-offadd | string | No | Office Address | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
+offadd | string | No | Office Address (Deprecated) | 65535 characters. This field has been deprecated. The Contracting office address details are retrieved from the Federal Hierarchy
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
desc | string | Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+link | GovURL – complex type | No | Government Link | 255 characters
email | GovEmail – complex type | Yes | Government Email | 255 characters
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
-popaddress | string | No | Place of Performace Address | 65535 characters
-popzip | string | No | Place of Performace Zip | 5 digits
-popcountry | string | No | Place of Performace Country | 32 characters
-recovery_act | boolean | No | Recovery Act | True or False
+popaddress | string | No | Place of Performance Address | 65535 characters
+popzip | string | No | Place of Performance Zip | 5 digits
+popcountry | string | No | Place of Performance Country | 32 characters
+recovery_act | boolean | No | Recovery Act | True or False (Default = False)
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | Website Address | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description | 255 characters
+url | string | Yes | Website Address | 255 characters
+desc | string | Yes | Description | 255 characters
GovEmail Complex Type Definition:
@@ -879,15 +879,15 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url | string | No | External URL | 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc | string | No | Description/Title | 255 characters
+url | string | Yes | External URL | 255 characters
+desc | string | Yes | Description/Title | 255 characters
DocumentFile Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -910,7 +910,7 @@ ITB Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date |Date |No |Posting Date |YYYYMMDD
+date |Date |No |Posting Date (Deprecated) |YYYYMMDD
zip |String| No| Zip Code (Deprecated)| 5 digits
classcod| String| Yes| Class-Code| Valid classification code (FAR, Section 5.207(g))
naics| String| No| NAICS Code| Valid NAICS Code
NAICS Reference
@@ -918,25 +918,25 @@ officeid| String| Yes| Office ID of the office where an opportunity is being sub
offadd| String |No| Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy| 65535 characters
subject| String| Yes| Subject |256 characters
solnbr |String |Yes| Solicitation # |128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
-ntype |string |No| [Refer Related Notices](#related-notices)
+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
desc |String |Yes |Description| 65535 characters
-link| GovURL| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
+link| GovURL| No| Government Link |255 characters
links |DocumentLink[]| No| Array Of links |
files| DocumentFile[] |No |Array of files |
email |GovEmail| Yes| Government Email| 255 characters
-recovery_act| boolean |No |Recovery Act |True or False
+recovery_act| boolean |No |Recovery Act |True or False (Default = False)
correction |boolean |No |Correction of previous ITB| True or False
If correcting a previously submitted ITB notice, specify True and the system will lookup the itb by award number, delivery number and sol number if applicable.
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |No |Website Address |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc |string| No - Yes, if URL provided| Description| 255 characters
+url |string |Yes |Website Address |255 characters
+desc |string| Yes| Description| 255 characters
GovEmail Complex Type Definition:
@@ -949,15 +949,15 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url| string| No |External URL| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc| string| No| Description/Title |255 characters
+url| string| Yes |External URL| 255 characters
+desc| string| Yes| Description/Title |255 characters
DocumentFile Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -984,7 +984,7 @@ Complete notice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-date| date| No |Posting Date| YYYYMMDD
+date| date| No |Posting Date (Deprecated)| YYYYMMDD
notice_type |string |Yes| [Refer Notice Types](#notice-types) |
zip |string |No |Zip Code (Deprecated)| 5 digits
classcod| string| Yes - for SOL, COMBINE, SSALE, ITB, JA, PRESOL | Class-Code |Valid classification code (FAR, Section 5.207(g))
@@ -1001,30 +1001,30 @@ linenbr| string |No| Award Line Item Number |255 characters from the set: a-z A-
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| Either respdate or archdate required for SRCSGT, PRESOL, SSALE, SNOTE| Archive Date| YYYYMMDD
+archdate | date| No; Either respdate or archdate required for SRCSGT, PRESOL, SSALE, SNOTE| Archive Date| YYYYMMDD
awardee| string| Yes – for AWARD | Awardee |65535 characters
-awardee_duns| string |No |Awardee DUNS |9 digits with optional plus 4
+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
desc |string| Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE| Main Description| 65535 characters
-link| GovernmentURL| No| Government Link |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-email| GovernmentEmail| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL, SNOTE| Government Email |255 characters
+link| GovernmentURL| No| Government Link |255 characters
+email| GovernmentEmail| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL, SNOTE (SNOTE only required if contact is provided)| Government Email |255 characters
links |DocumentLink []| No |Array Of links |
files |DocumentFile[]| No| Array of files |
setaside| string| No| [Refer Set-Aside Values](#set-aside-values) |
-popaddress| string| No| Place of Performace Addressress |65535 characters
-popzip| string |No |Place of Performace Zip |5 digits
-popcountry| string| Yes – For Awards; No – For rest| Place of Performace Country| 32 characters
+popaddress| string| No| Place of Performance Address |65535 characters
+popzip| string |No |Place of Performance Zip |5 digits
+popcountry| string| No| Place of Performance Country| 32 characters
city| string| No |City |NA
state| string| No| State |NA
-recovery_act |boolean| No| Recovery Act| True or False
-correction| boolean| No| Correction of previous notice for the following types: Award #, Delivery Order #) – Awards, J&A’s, Intent to Bundle Requirements (DoD-Funded), Limited Source Justification
This is used to modify/correct notice types where uniqueness is potentially determined by fields other than Solicitation # (i.e. Award #, Delivery Order #) |True or False
If correcting a previously submitted notice, specify True and the system will lookup the notice by award number, delivery order number, and sol number if applicable.
+recovery_act |boolean| No| Recovery Act| True or False (Default = False)
+correction| boolean| No| If correcting a previously submitted notice, specify True and the system will lookup the notice by award number, delivery order number, and sol number if applicable. |True or False
GovURL Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url| string| No| Website Address|255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc| string| No |Description| 255 characters
+url| string| Yes| Website Address|255 characters
+desc| string| Yes |Description| 255 characters
GovEmail Complex Type Definition:
@@ -1037,13 +1037,13 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string| No |External URL |255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc| string| No| Description/Title| 255 characters
+url |string| Yes |External URL |255 characters
+desc| string| Yes| Description/Title| 255 characters
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | No | File Name | 255 characters
-filedata | base64binary | No | File Data | 250 MB
+filename | string | Yes | File Name | 255 characters
+filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
export_controlled | boolean | No | Export Controlled. * Captured for future JCP validation. |
@@ -1066,10 +1066,10 @@ DocumentUpload Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-Date| Date| No |Posting Date |YYYYMMDD
-solnbr |String |No| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
+date| Date| No |Posting Date (Deprecated) |YYYYMMDD
+solnbr |String |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
ntype |String |No| Notice Type | [Refer Notice Types](#notice-types)
-uploadtype| String| No | Upload Type| A for amendment, S for solicitation or any title for other; 255 characters
+uploadtype| String| No | Upload Type (Deprecated)| 255 characters
respdate |Date |No |Response Date| YYYYMMDD
links| DocumentLin k[]| Yes; Either Links or Files needs to be provided| Array Of links |
files |DocumentFile []| Yes; Either Links or Files needs to be provided| Array of files |
@@ -1079,14 +1079,14 @@ DocumentLink Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-url |string |Yes| External URL| 255 characters, consist of a restricted set of characters (see URL specification - RFC 2396)
-desc| string| Yes| Description/Title |255 characters
+url |string |Yes| External URL| 255 characters
+desc| string| Yes | Description/Title |255 characters
DocumentFile Complex Type Definition
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
-filename | string | Yes | File Name | 255 characters
+filename | string | Yes | File Name | 255 characters
filedata | base64binary | Yes | File Data | 250 MB
desc | string | No | Description | 65535 characters
explicit_access | boolean | No | Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify "true".|
@@ -1114,6 +1114,7 @@ solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_
ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
awdnbr |string| No| Award #| 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
archdate |date| Yes| New Archive Date| YYYYMMDD
+officeid| String| No| Office ID (Not in Use)
### Secure Document Package
(attachSecureDocumentPackagesToNotice)
@@ -1204,7 +1205,7 @@ naics_codes| string |Naics Codes
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
3. One of Response date or Archive date is required
+archdate| 1. This field is required where applicable. 2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
3. One of Response date or Archive date is required
awardee | NA| NA
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
From 18e9e0a0ac392223ca4dbc199f374e7ff8b18b60 Mon Sep 17 00:00:00 2001
From: Ashwin-Deshmukh-REISystems
Date: Thu, 31 Oct 2019 05:14:31 -0400
Subject: [PATCH 104/149] update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 88 +++++++++++++++---------------
1 file changed, 43 insertions(+), 45 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 0ee8dfdb6..0e8ee53e1 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -4104,7 +4104,7 @@ stauth| 1. This field is required where applicable
2. This field accep
respdate| 1. This field is required where applicable
2. This date cannot be in past; has to be in future. If the given date is in past, then system throws errors | 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Response date provided is in the past
3. This opportunity cannot be published. Response Date cannot exceed 5 years from current date
4. One of Response date or Archive date is required
5. One of Response date or Archive date is required
archdate| 1. This field is required where applicable. Note user may receive "Auto 30
2. This date cannot be current or in past; has to be in future| 1. DATE field in unexpected format Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past.
3. One of Response date or Archive date is required
awardee | NA| NA
-awardee_duns| 1. Must provide a valid DUNS| 1. Unique Entity Identifier (duns) is invalid.
+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
desc| 1. This field is required where applicable.| 1. Description is required
link| NA | NA
@@ -4124,7 +4124,7 @@ correction| 1. When user tries to convert a notice and the solicitation number/n
#### submitDocumentsAndLinksToNotice
Individual business rules per field are listed across each of the fields in below table.
-* Note: Users cannot verify the attachments/links on front end (UI)
+* Note: Users can verify the attachments/links on SAM.gov
* Note: When none of the fields are given the service throws an error - Links and/or Files are not complete
* Note: When links/files are given but none of the other fields are given, then service throws an error - Multiple Notices found. Please input more details
@@ -4132,12 +4132,12 @@ Element Name | Business Rules | Error Messages with respect to business rules (I
------ | ------- | -------
date| Date field should meet the expected format |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|1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+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 field is not provided OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
uploadtype| NA| NA
respdate| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
links| 1.This field is not required but if url & description fields within the links and files are empty, then the service throws an error.
2. If a link with same name already exists on the notice, then the system throws an error.
3. If the Url is empty for a link, then the system throws an error.
4. If the description is missing for a link, then the system throws an error.| 1. Links and/or files are not complete
2. Resource with the same name already exists
3. Link Resource must have a link
4. Link Resource must have a description
-files | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error
2. If the filename is not provided for a file, then the system throws an error
3. If the filedata is empty for a file, then the system throws an error
4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error
5. If the file size exceeds 250MB, then the system throws an error
6. If a file with same name already exists on the notice, then the system throwns an error |1. Links and/or files are not complete
2. Attachment must have a name
3. Attachment must have content
4. The file type that you are trying to upload is not supported
5. The file type that you are trying to upload is not supported
6. Resource with the same name already exists
+files | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error
2. If the filename is not provided for a file, then the system throws an error
3. If the filedata is empty for a file, then the system throws an error
4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error
5. If the file size exceeds 250MB, then the system throws an error
6. If a file with same name already exists on the notice, then the system throwns an error |1. Links and/or files are not complete
2. Attachment must have a name
3. Attachment must have content
4. The file type that you are trying to upload is not supported
5. The file size should be greater than zero bytes and less than 250 MB
6. Resource with the same name already exists
@@ -4147,11 +4147,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)
------ | ------- | ------- | ------- | --------
-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 a space is given along with numbers in this field, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+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
awdnbr| If neither solnbr or awdnbr is provided, then the system throws an error| Solicitation Number or Award Number is required
-ntype| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-deletetype| 1. If an invalid deletetype is provided, then service throws an error | Delete type provided is not “notice” or “attachment”
-deletemethod| 1. If an invalid deletemethod is provided, then service throws an error | Delete method provided is not “latest” or “all”
+ntype| 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
+deletetype| 1. If an invalid deletetype is provided, then service throws an error | 1.Delete type provided is not “notice” or “attachment”
+deletemethod| 1. If an invalid deletemethod is provided, then service throws an error | 1. Delete method provided is not “latest” or “all”
#### archiveNotice
@@ -4161,42 +4161,42 @@ 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
-solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If invalid combination of ntype and solnbr is provided, then system throws an error
3. If a space is given along with numbers in this field, then service throws an error| 1. Multiple notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
+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
2. If a valid ntype but a wrong ntype is not provided for the solnbrthen service throws an error | 1. NTYPE value provided is not valid 2. Notice not found for correction
-archdate| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be current or in past; has to be in future |1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be published. Archive date provided is in the past
+ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
+archdate| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
|1. DATE field in unexpected format. Expects YYYYMMDD
#### unarchiveNotice
Individual business rules per field are listed across each of the fields in below table.
-* Note: : If a user tries to unarchive a notice that is already unarchived, then the service throws an error - Opportunity is not archived.
+* Note: : If a user tries to unarchive a notice that is already unarchived, then the service throws an error - Opportunity is not archived
* Note: If a user tries to unarchive an active notice, then the service throws an error - Opportunity is active
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If solicitation & ntype combination is not matched, then service throws an error |1. Multiple notices found. Please input more details
2. Notice not found for correction
+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 field is not provided OR a wrong ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
awdnbr | NA| NA
-archdate| 1. This field is required where applicable
2. If this value is available, this field should meet the character limit/restrictions
3. 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. $.reason: null found, string expected. Unable to process request. Please try again
+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
#### cancelNotice
Individual business rules per field are listed across each of the fields in below table.
-* Note: : If user tries to cancel already cancelled opportunity, service throws an error - This opportunity cannot be cancelled. This opportunity is already cancelled. Unable to process request. Please try again.
-* Note: - When user tries to cancel a notice without giving any input, then the service throws an error ‘Unable to process request. Please try again’
+* Note: If user tries to cancel already cancelled opportunity, service throws an error - This opportunity cannot be cancelled. This opportunity is already cancelled. Unable to process request. Please try again.
+* Note: When user tries to cancel a notice without giving any input, then the service throws an error ‘Unable to process request. Please try again’
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
officeid| Office ID must be associated with user account |NA
subject| NA| NA
-solnbr| 1a. This required field if not given, service throws an error
1b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination
2. If valid solnbr is given with a different ntype, then service throws an error
3. If a space is given along with numbers in this field, then service throws an error |1. Multiple Notices found. Please input more details
2. Notice not found for correction
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
-ntype | 1. If field is not provided OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
+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
+ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
awdnbr| NA| NA
archdate| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions
2. This date cannot be in past; has to be in future| 1. DATE field in unexpected format. Expects YYYYMMDD
2. This opportunity cannot be cancelled
contact| NA| NA
-desc| 1. This field is required where applicable | 1. Unable to process request. Please try again
+desc| 1. This field is required where applicable | 1. This opportunity cannot be cancelled. The cancel request is missing 'Cancellation description' field.
#### getNoticeData
@@ -4206,7 +4206,7 @@ Element Name | Business Rules | Error Messages with respect to business rules (I
------ | ------- | ------- | ------- | --------
notice_id | notice_id is required| 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| Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
get_file_data |NA |NA
#### getList
@@ -4216,7 +4216,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)
------ | ------- | ------- | ------- | --------
-notice_type | Valid Notice Type must be provided | Notice Type is not recognized
+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
solnbr| NA| NA
awdnbr| NA| NA
posted_from | Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
@@ -4226,20 +4226,18 @@ documents_to_search| NA| NA
#### getFileData
Individual business rules per field are listed across each of the fields in below table.
-* Note: If a wrong combination of file_id and notice_id is given, then the service throws a success message without any data.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-file_id |1. This field is required where applicable
2. If an invalid file Id is provided, then the system throws an error.| 1. file_id is required
2. File Id not found. Please enter a valid Id.
+file_id |1. This field is required where applicable
2. If an invalid file Id is provided, then the system throws an error.| 1. file_id is required
2. Unable to find details for the resourceId
-#### getIVLListResponse
+#### getIVLList
Individual business rules per field are listed across each of the fields in below table.
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-solnbr| 1. If an incorrect solicitation number and ntype combination is given, the service throws an error
2a. If this required field if not given, service throws an error
2b. If multiple notices are found with solicitation number given, then provide ntype and solicitation number combination |1. Notice not found
2a. Notice not found
2b. Multiple Notices found. Please input more details
-ntype| 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
#### getAuthorizedPartyList
@@ -4247,9 +4245,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)
------ | ------- | ------- | ------- | --------
-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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
+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
+ntype| 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
status| 1. If the status value entered doesn’t match the valid values , then the system throws an error| 1. Status value is invalid
#### approveExplicitAccessRequestByID
@@ -4260,8 +4258,8 @@ ID can be obtained through getAuthorizedPartyList
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error |1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype |If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+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, then the system throws an error |1. Solicitation Number is required
2. Notice not found
3. Multiple notices found. Please input more details
+ntype |1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
id| 1. If the request Id is not provided, then the system throws an error
2. If the request Id provided is already approved, then the service throws an error
3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error
4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error |1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information
2. Request with Request ID: #id already approved
3. You have request that is tied to different solicitation number
4. You have request that is tied to the same solicitation number but different notice type
@@ -4274,10 +4272,10 @@ Vendor can be obtained through getAuthorizedPartyList
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
-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.
-ntype |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
+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
+ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
-vendor |1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error.
2. If no match is found in the system for the vendor data provided, then the system throws an error.
3. If the Explicit Access request found for the vendor and solnum is already approved, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown.
2. No contact match on vendor data provided.
3. Request with Request ID: #id already approved.
+vendor |1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the Explicit Access request found for the vendor and solnum is already approved, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Request with Request ID: #id already approved
#### addAuthorizedParty
@@ -4285,10 +4283,10 @@ 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)
------ | ------- | ------- | ------- | --------
-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 a space is given along with numbers in this field, then service throws an error
4. 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. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
-nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
-vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
+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
+ntype| 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthorizedParty service is deprecated for Non-FBO Solicitations
+vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
#### rejectExplicitAccessRequestByID
@@ -4296,11 +4294,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)
------ | ------- | ------- | ------- | --------
-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 a space is given along with numbers in this field, then service throws an error
4. If ntype value is not provided and the solnbr is not unique, then the system throws an error| 1. Solicitation Number is required
2. Notice not found
3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces
4. Multiple notices found. Please input more details
-ntype| 1. If an invalid ntype is provided, then service throws an error | 1. NTYPE value provided is not valid
+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, then the system throws an error| 1. Solicitation Number is required
2. Notice not found
3. Multiple notices found. Please input more details
+ntype| 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
id| 1. If the request Id is not provided, then the system throws an error
2. If the request Id provided is already rejected, then the service throws an error
3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error
4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error| 1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information
2. Request with Request ID: #id already rejected
3. You have request that is tied to different solicitation number
4. You have request that is tied to the same solicitation number but different notice type
-reason| 1. This is a required field. If no value is provided, then the system throws an error.| 1. A reason must be provided with an explicit access rejection.
+reason| 1. This is a required field. If no value is provided, then the system throws an error| 1. A reason must be provided with an explicit access rejection
#### rejectExplicitAccessRequestByVendorData
Individual business rules per field are listed across each of the fields in below table.
@@ -4308,10 +4306,10 @@ 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)
------ | ------- | ------- | ------- | --------
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.
-ntype |If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided.
-nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
+ntype |1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
+nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByVendorData service is deprecated for Non-FBO Solicitations
vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
-reason| 1. This is a required field. If no value is provided, then the system throws an error.| 1. A reason must be provided with an explicit access rejection.
+reason| 1. This is a required field. If no value is provided, then the system throws an error| 1. A reason must be provided with an explicit access rejection
From ddb58eb709e66daa19027e464b0d2aae3c1a3478 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
2. If an invalid file Id is provided, then the system throws an error.| 1. file_id is required
2. Unable to find details for the resourceId
+file_id |1. This field is required where applicable
2. If an invalid file Id is provided, then the system throws an error.| 1. file_id is required
2. Unable to find details for the resourceId
#### getIVLList
@@ -4276,7 +4276,7 @@ Element Name | Business Rules | Error Messages with respect to business rules (I
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
ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
-vendor |1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the Explicit Access request found for the vendor and solnum is already approved, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Request with Request ID: #id already approved
+vendor |1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the Explicit Access request found for the vendor and solnum is already approved, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Request with Request ID: #id already approved
#### addAuthorizedParty
@@ -4287,7 +4287,7 @@ Element Name | Business Rules | Error Messages with respect to business rules (
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
ntype| 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. addAuthorizedParty service is deprecated for Non-FBO Solicitations
-vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
+vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
#### rejectExplicitAccessRequestByID
@@ -4309,7 +4309,7 @@ Element Name | Business Rules | Error Messages with respect to business rules (I
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.
ntype |1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error
2. If only nonfbo_solbr is provided, then the service throws an error| 1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together
2. rejectExplicitAccessRequestByVendorData service is deprecated for Non-FBO Solicitations
-vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the vendor is already added as an authorized party on the notice, then the system throws an error.| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Duplicate request. Vendor is already added as an authorized party on the notice
+vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the Explicit Access request found for the vendor and solnum is already rejected, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Request with Request ID: #id already rejected
reason| 1. This is a required field. If no value is provided, then the system throws an error| 1. A reason must be provided with an explicit access rejection
From 2c1d5aff21d75b4835b2785375711a9137a23f5e Mon Sep 17 00:00:00 2001
From: "anusha.paladugu" Uncancel Request (active Opportunity):
-
-
-{
- "reason": "",
- "requestType": "uncancel_request",
- "data": {
- "description": "test"
- }
-}
-
Uncancel Request (inactive Opportunity):
+Uncancel Request:
@@ -3497,7 +3503,6 @@ newArchiveDate | date | YYYY-MM-DD | Yes (if newArchiveType=autocustome) | New A
newArchiveType | string | auto15, auto30, autocustom | Yes | New Archive Type
newResponseDate | date | YYYY-MM-DDTHH:MM:SS-05:00 | Yes (if newArchiveType = auto15) | New Response Date
newResponseTz | string | America/New_York | Yes (if newResponseDate is provided) | New Response Time Zone
-newContractAwardDate | date | YYYY-MM-DD | Yes (if type=a) | New Contract Award Date
{
@@ -2126,17 +2110,36 @@ HTTP Status Code | Response Type | Reason | Description
Examples
Unarchive:
+Unarchive Request for a Non-Award notice
+
{
"reason": "test",
"requestType": "unarchive_request",
"data": {
- "newArchiveDate": null,
+ "newResponseDate": "2019-12-12T00:12:00-05:00",
+ "newResponseTz": "America/New_York",
"newArchiveType": "auto15",
- "newResponseDate": "2019-11-11T10:58:00-05:00",
- "newResponseTz": "America/New_York"
+ "newArchiveDate": null
+ }
+}
+
Unarchive Request for a Award notice
+
@@ -3403,6 +3406,10 @@ resources.content | byte |250MB | | No|No | File content in base64 format
resources.link | string | 255 characters | |No|No | Resource link URL
resources.packageAccessLevel | string | | public,
+{
+ "reason": "test unarchive for award notice",
+ "requestType": "unarchive_request",
+ "data": {
+ "newResponseDate": null,
+ "newResponseTz": null,
+ "newArchiveType": "autocustom",
+ "newArchiveDate": "2020-03-01",
+ "newContractAwardDate": "2020-02-02"
}
}
private
(default public) | No | No| Type of access to file
resources.resourceName | string | 255 characters | | No|No | Name of file
+resources.description | string |255 characters | | No|No | Description of the link
+resources.explicitAccess | string |1 character | 0, 1 (defaults to '0' public access, if not provided) | No |No |Explicit Access. For Controlled Unclassified files, specify '1'
+resources.exportControlled | string |1 character | 0 | No |No |Export Controlled. * Captured for future JCP validation
+
Vendor_Data_Contract_JSON
+
+
+{
+"lname":"",
+"fname":"",
+"email":"",
+"contractorName":"",
+"duns":"",
+"cageCode":""
+}
+
Delete Notice Request
+Delete_Notice_Contract_JSON
{
@@ -3740,6 +3762,15 @@ deleteOption| string| latest, all| Yes| Option to delete either the latest or al
(unarchiveNotice)
@@ -4134,14 +4134,12 @@ Element Name | Business Rules | Error Messages with respect to business rules (I
date| Date field should meet the expected format |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 field is not provided OR a wrong ntype is provided, then service throws an error | 1. Notice Type value provided is not valid
+ntype | 1. If an invalid ntype is provided, then service throws an error | 1. Invalid NTYPE value provided
uploadtype| NA| NA
respdate| 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions |1. DATE field in unexpected format. Expects YYYYMMDD
links| 1.This field is not required but if url & description fields within the links and files are empty, then the service throws an error.
2. If a link with same name already exists on the notice, then the system throws an error.
3. If the Url is empty for a link, then the system throws an error.
4. If the description is missing for a link, then the system throws an error.| 1. Links and/or files are not complete
2. Resource with the same name already exists
3. Link Resource must have a link
4. Link Resource must have a description
files | 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error
2. If the filename is not provided for a file, then the system throws an error
3. If the filedata is empty for a file, then the system throws an error
4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error
5. If the file size exceeds 250MB, then the system throws an error
6. If a file with same name already exists on the notice, then the system throwns an error |1. Links and/or files are not complete
2. Attachment must have a name
3. Attachment must have content
4. The file type that you are trying to upload is not supported
5. The file size should be greater than zero bytes and less than 250 MB
6. Resource with the same name already exists
-
-
#### deleteNoticeOrDocumentPackage
Individual business rules per field are listed across each of the fields in below table.
@@ -4312,25 +4310,6 @@ nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service
vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the Explicit Access request found for the vendor and solnum is already rejected, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Request with Request ID: #id already rejected
reason| 1. This is a required field. If no value is provided, then the system throws an error| 1. A reason must be provided with an explicit access rejection
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
#### submitFairOpps
This service is now deprecated. Instead, please use submitJA to perform the operation.
From 11a6768d14a89724d23ff16c8825fed23d87961c Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
2.If a wrong cl
naics |NA | NAICS code is required
offadd| Not Used| NA
officeid |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If user does not have access to an office but is trying to make a submission to that office, then the service throws an error
|1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
-subject | 1. This field is required where appicable |1. $.data.title: is missing but it is required
-solnbr| 1. This field is required where applicable
2. If submitting a notice with a duplicabe 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 for the selected opportunity type already exists
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
5. Notice ID must be unique based on selected notice type
+subject | 1. This field is required where appicable |1. title: is missing but it is required
+solnbr| 1. This field is required where applicable
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 for the selected opportunity type already exists
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
5. Notice ID must be unique based on selected notice type
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. This field accepts only valid values listed. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
awdnbr| 1. This field is required where applicable| 1. Award Details Section - Contract Award Number is a required field
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. Award Details Section - Task/Delivery Order Number is required field
2. Award Details Section - Task/Delivery Order Number - Please enter a valid number
From edccbb11c73837cf154684d50513abc90f039d11 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu" Delete_Notice_Contract_JSON
Delete_Notice_Contract_JSON
{
From bcb06453ea65ef64e1f84e66b66827b450f79273 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
@@ -1271,7 +1271,7 @@ ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
vendor |VendorData| No| Complex type not used in this method|
-reason |string| No| Rejection reason not used in this method| 65535 characters
+reason |string| No| Not in Use| 65535 characters
Response:
@@ -1296,9 +1296,9 @@ Element Name |Type |Required| Description | Character Limit / Restrictions
solnbr |string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype| string| No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method|
-Id |string |No |Not used in this method| 32 characters
+Id |string |No |Not in Use | 32 characters
vendor |VendorData| Yes| Complex type defined below|
-reason |string| No| Rejection reason not used in this method| 65535 characters
+reason |string| No| Not in Use| 65535 characters
Response:
@@ -1363,7 +1363,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr |string |No |Non-fbo Solicitation #. Not supported for this method|
-Id |string |No |Not used in this method| 32 characters
+Id |string |No |Not in Use| 32 characters
vendor |VendorData| Yes| Complex type defined below|
reason| string| Yes |Rejection Reason | 65535 characters
@@ -1400,9 +1400,9 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No |Non-fbo Solicitation #. Not supported for this method.|
-Id |string |No |Not used in this method| 32 characters
+Id |string |No |Not in Use| 32 characters
vendor |VendorData| Yes| Complex type defined below|
-reason |string| No| Rejection reason not used in this method| 65535 characters
+reason |string| No| Not in Use| 65535 characters
Response:
@@ -4091,7 +4091,7 @@ notice_type | 1. This field is required where applicable | 1. Opportunity type i
zip| NA |NA
classcod |1. This field is required where applicable
2.If a wrong classification code is given, then the service throws an error | 1. Product Service Code is a required field
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
naics |NA | NAICS code is required
-offadd| Not Used| NA
+offadd| Not in Use| NA
officeid |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If user does not have access to an office but is trying to make a submission to that office, then the service throws an error
|1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject | 1. This field is required where appicable |1. title: is missing but it is required
solnbr| 1. This field is required where applicable
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 for the selected opportunity type already exists
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
5. Notice ID must be unique based on selected notice type
From 08290bb2d9ab02856fce70cdc83e5b9c2a92f0b8 Mon Sep 17 00:00:00 2001
From: Ashwin-Deshmukh-REISystems
secondary | No | Yes | Contact Type Note: 'p' and 's' must be in lower case
+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 | Contact Full Name
-pointOfContact.email | string |255 characters | | No | Yes (no if type = a) | Contact email
+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
@@ -3089,51 +3087,47 @@ 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 (if 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
+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 'Inerested Vendor's List' where users outside the notice can indicate a desire to submit a proposal. This list in way binds either party
-permissions.ivl.create | boolean | | | No | No | IVL create permission
-permissions.ivl.read | boolean | | | No | No | IVL read permission
+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 desire to submit a proposal
+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.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)
2) Yes (when archive.type=
auto1) | Deadline Date
+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 Notice' and 'Justification' opportunity types
-award.date | date | |YYYY-MM-DD |No | Yes only for type= a | Award Date
-award.number | string | 255 characters | |No | Yes only for type= i, j, a | Award Number
-award.deliverOrderNumber | string | 255 characters| | No | No | Award Delivery Order Number
-award.amount | number |64 digits | | No | No | Award Amount
+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
-award.awardee.name | string | 255 characters | | No | No | Awardee Name
-award.awardee.duns | string | 9 digits | | No | No | Awardee Duns
-award.awardee.location | JSON |NA | NA | NA | NA | Awardee Location details
+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 | No | Awardee City code
+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 | No | Awardee State code
+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 | No | Awardee Country code
+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 |
+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 | No | Justification Authority
-link | JSON | NA |NA | NA | NA |
-link.href | string | | | No | No | Url for the notice on SAM.gov
-link.additionalInfo | JSON | NA |NA | NA | NA | Any additional information on the opportunity
-link.additionalInfo.
content | string | | | No | No | Additional information details
-additionalReporting | string | |none,
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
+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
description | JSON | NA | NA | NA | NA |
-description.body | string | 65535 characters| | No | Yes | Description of the notice
+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
related.opportunityId | string | 32 characters| | No | No | Opportunity Id of the related notice
@@ -3316,99 +3310,91 @@ reason | string | | No | Publish reason
* Field headers in the table must match with field headers shown in JSON example
-Name | Data Type |Field Length | Allowed Values | Required (Create/Update) | Required (to Publish) | Description
+Name | Data Type |Field Length | Allowed Values| Required | 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 | Solicitation Number
-title | string | 256 characters | |Yes | Yes | Title of the Opportunity
-organizationId | string | 32 characters | |No for Create (Yes for Update) | Yes | FH Organization Id/AAC code of the office where an Opportunity is being submitted
-organizationLocationId | string | | | No|No| This field has been deprecated. Organization Location details will be pulled from the Federal Hierarchy
-classificationCode | string | | | No | Yes (not required for type= r) | Product Service Code (PSC)
-naics | JSON Array | NA |NA | NA | NA |
-naics.code | Array of String | | NAICS Reference| No | Yes | Valid NAICS Code
-naics.type | string | |primary| No | Yes | NAICS Type Note: 'p' must be in lower case
-flags | JSON Array| NA |NA | NA | NA |
-flags.code | string | |Recovery act | No | No | This is a recovery or Reinvestment Act Action
-flags.IsSelected | boolean | |default is 'True' | No | No |
-pointOfContact | JSON Array | NA |NA | NA | NA |
-pointOfContact.type | string | | primary,
secondary | No | Yes | 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 | Contact Full Name
-pointOfContact.email | string |255 characters | | No | Yes (no if type = a) | 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 (if 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 'Inerested Vendor's List' where users outside the notice can indicate a desire to submit a proposal. This list in way binds either party
-permissions.ivl.create | boolean | | | No | No | IVL create permission
-permissions.ivl.read | boolean | | | No | No | 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)
2) Yes (when archive.type=
auto1) | 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 Notice' and 'Justification' opportunity types
-award.date | date | |YYYY-MM-DD |No | Yes only for type= a | Award Date
-award.number | string | 255 characters | |No | Yes only for type= i, j, a | Award Number
-award.deliverOrderNumber | string | 255 characters| | No | No | Award Delivery Order Number
-award.amount | number |64 digits | | No | No | Award Amount
-award.lineitemNumber | string |255 characters | | No | No | Contract Line item Number
-award.awardee | JSON | NA| NA | NA | NA |Awardee details
-award.awardee.name | string | 255 characters | | No | No | Awardee Name
-award.awardee.duns | string | 9 digits | | No | No | Awardee Duns
-award.awardee.location | JSON |NA | NA | NA | NA | Awardee Location details
-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 | No | 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 | No | 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 | No | Awardee Country code
-award.awardee.location.
country.name | string | | | No | No | Awardee Country Name
-award.awardee.location.
zip | string | | | No | No | Awardee Country Zip code
-justificationAuthority | JSON |NA |NA | NA | NA |
-justificationAuthority.
modificationNumber | string | 32 characters| | No | No | Justification Authority Modification Number
-justificationAuthority.
authority | string| | | No | No | Justification Authority
-link | JSON | NA |NA | NA | NA |
-link.href | string | | | No | No | Url for the notice on SAM.gov
-link.additionalInfo | JSON | NA |NA | NA | NA | Any additional information on the opportunity
-link.additionalInfo.
content | string | | | No | No | Additional information details
-additionalReporting | string | |none,
auto_recovery | No | Yes | Additional reporting requirements that apply to the contract action
-description | JSON | NA | NA | NA | NA |
-description.body | string | 65535 characters| | No | Yes | Description of the notice
+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| No | 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 desire to submit a proposal
+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
+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 | NA | Related Notice information
-related.opportunityId | string | 32 characters| | No | No | Opportunity Id of the related notice
-resources | JSON |NA | NA | NA | NA |
-resources.attType | string | |link, file | No |No| Type of attachment, either link or file
-resources.content | byte |250MB | | No|No | File content in base64 format
-resources.link | string | 255 characters | |No|No | Resource link URL
-resources.packageAccessLevel | string | | public,
private
(default public) | No | No| Type of access to file
-resources.resourceName | string | 255 characters | | No|No | Name of file
-resources.description | string |255 characters | | No|No | Description of the link
-resources.explicitAccess | string |1 character | 0, 1 (defaults to '0' public access, if not provided) | No |No |Explicit Access. For Controlled Unclassified files, specify '1'
-resources.exportControlled | string |1 character | 0 | No |No |Export Controlled. * Captured for future JCP validation
+related.opportunityId | string | 32 characters| | No | Opportunity Id of the related notice
+resources | JSON |NA | NA | NA |
+resources.attType | string | |link, file | No| Type of attachment, either link or file
+resources.content | byte |250MB | | No | File content in base64 format
+resources.link | string | 255 characters | |No | Resource link URL
+resources.packageAccessLevel | string | | public,
private
(default public) | No| Type of access to file
+resources.resourceName | string | 255 characters | | No | Name of file
+resources.description | string |255 characters | | No | Description of the link
+resources.explicitAccess | string |1 character | 0, 1 (defaults to '0' public access, if not provided) |No |Explicit Access. For Controlled Unclassified files, specify '1'
+resources.exportControlled | string |1 character | 0 | No |Export Controlled. * Captured for future JCP validation
@@ -3434,7 +3420,7 @@ resources.exportControlled | string |1 character | 0 | No |No |Export Controlled
Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
requestType | string | update_publish_request | Yes | Type of request
-reason | string | | Yes | Reason for revision
+reason | string | | No | Reason for revision
@@ -3461,7 +3447,7 @@ reason | string | | Yes | Reason for revision
Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
-reason | string | | Yes | Reason for cancelation
+reason | string | | No | Reason for cancelation
requestType | string | cancel_request | Yes | Type of request
description | string | | Yes | Description for cancelation
@@ -3498,11 +3484,11 @@ Name | Data Type | Allowed Values | Required | Description
reason | string | | Yes | Reason for uncanceling
requestType | string | uncancel_request | Yes | Type of request
description | string | | Yes | Description for uncanceling
-newContractAwardDate | date | YYYY-MM-DD | Yes (if unarchiving an award notice) | New Contract Award Date
+newContractAwardDate | date | YYYY-MM-DD | Yes for type = a (Award)| New Contract Award Date
newArchiveDate | date | YYYY-MM-DD | Yes (if newArchiveType=autocustome) | New Archive Date
newArchiveType | string | auto15, auto30, autocustom | Yes | New Archive Type
-newResponseDate | date | YYYY-MM-DDTHH:MM:SS-05:00 | Yes (if newArchiveType = auto15) | New Response Date
-newResponseTz | string | America/New_York | Yes (if newResponseDate is provided) | New Response Time Zone
+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 type = a (Award) | New Response Date
+newResponseTz | string | | No | New Response Time Zone
@@ -3527,7 +3513,7 @@ newResponseTz | string | America/New_York | Yes (if newResponseDate is provided)
Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
requestType | string | archive_request | Yes | Type of request
-reason | string | | Yes | Archive reason
+reason | string | | No | Archive reason
@@ -3558,13 +3544,13 @@ reason | string | | Yes | Archive reason
Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
-reason | string | | Yes | Reason for uncanceling
+reason | string | | Yes | Reason for unarchiving
requestType | string | unarchive_request | Yes | Type of request
-newContractAwardDate | date | YYYY-MM-DD | Yes (if unarchiving an award notice) | New Contract Award Date
-newArchiveDate | date | YYYY-MM-DD | Yes (if newArchiveType=autocustom) | New Archive Date
+newContractAwardDate | date | YYYY-MM-DD | Yes for type = a (Award)| New Contract Award Date
+newArchiveDate | date | YYYY-MM-DD | Yes (if newArchiveType=autocustome) | New Archive Date
newArchiveType | string | auto15, auto30, autocustom | Yes | New Archive Type
-newResponseDate | date | YYYY-MM-DDTHH:MM:SS-05:00 | Yes (if newArchiveType = auto15) | New Response Date
-newResponseTz | string | America/New_York | Yes (if newResponseDate is provided) | New Response Time Zone
+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 type = a (Award) | New Response Date
+newResponseTz | string | | No | New Response Time Zone
@@ -3607,14 +3593,14 @@ newResponseTz | string | America/New_York | Yes (if newResponseDate is provided)
Name | Data Type | Field Length |Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
attType | string | 32 characters |link, file | Yes | Type of attachment, either link or file
-content | byte | 250MB| | Yes (if attType=file) | File content in base64 format
+content | byte | 250MB| | Yes if attType=file | File content in base64 format
packageAccessLevel | string | 32 characters|public,private(default public) | No | Type of access to file. Only used with attType 'file'.
-resourceName | string | 255 characters| | Yes (if attType=file) | Name of file
+resourceName | string | 255 characters| | Yes if attType=file | Name of file
fileType | string | 64 characters | | No | Mime Type of the file. Only used for attType 'file'. [Refer Valid File Types](#valid-file-types)
-link | string | 255 characters| | Yes (if attType=link) | Resource link URL
-description | string |255 characters | | Yes (if attType=link) | Description of the link
+link | string | 255 characters| | Yes if attType=link | Resource link URL
+description | string |255 characters | | Yes if attType=link | Description of the link
explicitAccess | string |1 character | 0, 1 (defaults to '0' public access, if not provided) | No |Explicit Access. For Controlled Unclassified files, specify '1'
-exportControlled | string |1 character | 0 | No |Export Controlled. * Captured for future JCP validation
+exportControlled | string |1 character | 0 | No | *Captured for future JCP validation*
Export Controlled
#### Valid File Types
@@ -3708,8 +3694,8 @@ resourceIdBelow | string | | No | This should be Resource ID of the file/link
Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
-ivlCreate | string | forcedon, forcedoff | Yes | Indicates whether vendors can indicate interest in the organization’s Opportunities
-ivlView | string | forcedon, forcedoff | Yes | Indicates whether vendors can view other vendors interested in the organization’s Opportunities
+ivlCreate | string | forcedon, forcedoff | No | Indicates whether vendors can indicate interest in the organization’s Opportunities
+ivlView | string | forcedon, forcedoff | No | Indicates whether vendors can view other vendors interested in the organization’s Opportunities
### Vendor Data Contract JSON
@@ -3744,11 +3730,11 @@ cageCode | string | | Yes | Cage Code
-### Delete Notice Contract JSON
+### Delete Notice JSON
Delete_Notice_Contract_JSON
+Delete_Notice_Contract_JSON
{
@@ -3768,7 +3754,7 @@ cageCode | string | | Yes | Cage Code
Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
-reason| string| | Yes| Reason for deletion
+reason| string| | No| Reason for deletion
requestType |string |delete_request |Yes |Type of request
description |string| |Yes| Description for deletion of a notice
deleteOption| string| latest, all| Yes| Option to delete either the latest or all versions of a notice
From 3849ad48776df873c4a9f26cb6b106cc74bb880b Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Thu, 31 Oct 2019 12:09:30 -0400
Subject: [PATCH 116/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 9f4ffdc98..5dae2810d 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -3090,7 +3090,7 @@ archive | JSON |NA | NA | NA | NA | Contract opportunity archive policy informat
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 desire to submit a proposal
+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
@@ -3346,7 +3346,7 @@ 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 desire to submit a proposal
+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
From cdc0811f1925b9f1815dc98e34ef883811a8f8b5 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu" Uncancel Request:
+Uncancel Request for a Non Award Notice
{
@@ -2037,6 +1975,26 @@ Examples
UnCancel Request for a Award notice
+
+
+{
+ "reason": "test uncancel for award notice",
+ "requestType": "uncancel_request",
+ "data": {
+ "description": "test",
+ "newResponseDate": null,
+ "newResponseTz": null,
+ "newArchiveType": "autocustom",
+ "newArchiveDate": "2020-03-01",
+ "newContractAwardDate": "2020-02-02"
+ }
+}
+
{
- "data":
- {
+ "data": {
"type": "",
"solicitationNumber": "",
"title": "",
"organizationId": "",
- "organizationLocationId": "",
"classificationCode": "",
"naics": [
- {
- "type": "primary",
- "code": [""]
- }],
- "flags": [
- {
- "code": "",
- "isSelected": true
- }],
+ {
+ "type": "primary",
+ "code": [
+ ""
+ ]
+ }
+ ],
"pointOfContact": [
- {
- "type": "primary",
- "title": "",
- "fullName": "",
- "email": "",
- "phone": "",
- "fax": "",
- "additionalInfo":
{
- "content": ""
+ "type": "primary",
+ "title": "",
+ "fullName": "",
+ "email": "",
+ "phone": "",
+ "fax": "",
+ "additionalInfo": {
+ "content": ""
+ }
}
- }],
- "placeOfPerformance":
- {
+ ],
+ "placeOfPerformance": {
"streetAddress": "",
"streetAddress2": "",
- "city":
- {
+ "city": {
"code": "",
"name": ""
},
- "country":
- {
+ "country": {
"code": "",
"name": ""
},
- "state":
- {
+ "state": {
"code": "",
"name": ""
},
"zip": ""
},
- "archive":
- {
+ "archive": {
"type": "autocustom",
"date": "2019-09-09"
},
- "permissions":
- {
- "IVL":
- {
+ "permissions": {
+ "IVL": {
"create": false,
"delete": false,
"read": false,
"update": false
}
},
- "solicitation":
- {
+ "solicitation": {
"setAside": "SBA",
- "deadlines":
- {
+ "deadlines": {
"response": "2019-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":
- {
- "modificationNumber": "",
- "authority": "dictionary"
- },
- "link":
- {
- "additionalInfo":
- {
- "content": ""
- },
- "href": ""
- },
- "additionalReporting": ["none"]
},
- "description": [
+ "justificationAuthority": {
+ "modificationNumber": "",
+ "authority": "dictionary"
+ },
+ "additionalReporting": [
+ "none"
+ ]
+ },
+ "description": [
{
"body": ""
- }],
- "related":
- {
- "opportunityId": ""
}
+ ],
+ "related": {
+ "opportunityId": ""
}
+}
+
From 625094a614035e7c25a69888e13d0cf70a07128c Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
{
"reason": "",
- "requestType": " uncancel_request ",
+ "requestType": "uncancel_request",
"data": {
"description": "",
"newContractAwardDate": "",
"newArchiveDate": "",
"newArchiveType": "",
"newResponseDate": "",
- "newResponseTz": "America/New_York",
+ "newResponseTz": "America/New_York"
}
}
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 |65535 characters
+awardee| string| Yes – for AWARD | Awardee |255 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
desc |string| Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE| Main Description| 65535 characters
From 5d67dea08711366c045966518f6178c2b4123b38 Mon Sep 17 00:00:00 2001
From: "anusha.paladugu"
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
newResponseTz | string | | No | New Response Time Zone
@@ -3466,10 +3466,10 @@ Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
reason | string | | Yes | Reason for unarchiving
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=autocustome) | 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 type = a (Award) | New Response Date
+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
newResponseTz | string | | No | New Response Time Zone
@@ -3513,13 +3513,13 @@ newResponseTz | string | | No | New Response Time Zone
Name | Data Type | Field Length |Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
attType | string | 32 characters |link, file | Yes | Type of attachment, either link or file
-content | byte | 250MB| | Yes if attType=file | File content in base64 format
-packageAccessLevel | string | 32 characters|public,private(default public) | No | Type of access to file. Only used with attType 'file'.
-resourceName | string | 255 characters| | Yes if attType=file | Name of file
+content | byte | 250MB| | Yes; if attType=file | File content in base64 format
+packageAccessLevel | string | 32 characters|public,
private
(default public) | No | Type of access to file. Only used with attType 'file'.
+resourceName | string | 255 characters| | Yes; if attType=file | Name of file
fileType | string | 64 characters | | No | Mime Type of the file. Only used for attType 'file'. [Refer Valid File Types](#valid-file-types)
-link | string | 255 characters| | Yes if attType=link | Resource link URL
-description | string |255 characters | | Yes if attType=link | Description of the link
-explicitAccess | string |1 character | 0, 1 (defaults to '0' public access, if not provided) | No |Explicit Access. For Controlled Unclassified files, specify '1'
+link | string | 255 characters| | Yes; if attType=link | Resource link URL
+description | string |255 characters | | Yes; if attType=link | Description of the link
+explicitAccess | string |1 character | 0, 1
(defaults to '0' public access, if not provided) | No |Explicit Access. For Controlled Unclassified files, specify '1'
exportControlled | string |1 character | 0 | No | *Captured for future JCP validation*
Export Controlled
#### Valid File Types
@@ -3586,7 +3586,7 @@ Flash Video (.flv, .f4v)| video/x-flv
Name | Data Type | Allowed Values | Required | Description
-----|-----------|----------------|----------|------------
attType | string | link, file | No | Required only for file access level changes
-packageAccessLevel | string | public,private(default public) | No | Type of access to file. Only used with attType 'file'
+packageAccessLevel | string | public,
private
(default public) | No | Type of access to file. Only used with attType 'file'
resourceName | string | | No | Name of file or link
explicitAccess | string | 0, 1 | No | Defaults to '0' (public access) if not provided. '1' is used for Controlled Unclassified files. Required only for file access level changes
sortOrderChanged | boolean | true, false | No | Should be provided if file order is changed.
From 0123a2befe396af268d5b4ac7d536156e2ba56ab Mon Sep 17 00:00:00 2001
From: "anusha.paladugu" Delete_Notice_Contract_JSON
Delete_Notice_Contract_JSON
{
From 299ce359afffe8a1356e21d7ff9ffc06dcb42c5c Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Thu, 31 Oct 2019 13:39:15 -0400
Subject: [PATCH 122/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 221 +++++++++++------------------
1 file changed, 83 insertions(+), 138 deletions(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 3f2e01c89..173e7213e 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -185,7 +185,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date (Deprecated) | YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
-classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | No | Classification Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
officeid | string | Yes | Office ID of the office where an opportunity is being submitted | 20 characters
@@ -261,7 +261,7 @@ DeleteNoticeOrDocumentPackage Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr | string | Yes; Either Solicitation # or Award # is required only for Award| Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No; Yes if there are multiple notices with same Solicitation # | Notice Type | [Refer Notice Types](#notice-types)
+ntype | string | No; Yes if there are multiple notices with same Solicitation # | [Refer Notice Types](#notice-types) |
awdnbr | string | Yes; Either Solicitation # or Award # is required ony for Award| Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
deletetype | string | No | Notice or Attachment delete operation type | Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod | string | No | Delete latest or all versions | Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided
@@ -288,7 +288,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date (Deprecated)| YYYYMMDD
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z 0-9 -_ ( ) { }
-ntype | string | No | Notice Type | [Refer Notice Types](#notice-types)
+ntype | string | No | [Refer Notice Types](#notice-types) |
archdate | date | No | Deprecated. Notice will archive immediately | YYYYMMDD
officeid | string | No | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
@@ -314,7 +314,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date (Deprecated) | YYYYMMDD
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
-officeid | String | No | OfficeID (Not in Use)| 20 characters
+officeid | String | No | Office ID (Not in Use)| 20 characters
subject | string | No | Subject | 256 characters
solnbr |string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
ntype | string | No | [Refer Notice Types](#notice-types) |
@@ -347,7 +347,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date (Deprecated) | YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
-classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | Yes | Classification Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
@@ -357,8 +357,8 @@ respdate | date | No - either respdate or archdate is required | Response Date |
archdate | date | No - either respdate or archdate is required | Archive Date | YYYYMMDD
contact | string | Yes | Contact Info | 255 characters
desc |string |Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link has URL & description | 255 characters
-email | GovEmail – complex type | Yes | Government Email | 255 characters
+link | GovURL – complex type | No | Government Link has URL & description |
+email | GovEmail – complex type | Yes | Government Email |
links | DocumentLink[] | No | Array of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
@@ -418,7 +418,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date (Deprecated) | YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
-classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | Yes | Classification Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No |Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
@@ -428,8 +428,8 @@ respdate | date | Yes | Response Date | YYYYMMDD
archdate | date | No | Archive Date | YYYYMMDD
contact | string |Yes | Contact Info | 255 characters
desc | string | Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters
-email | GovEmail – complex type | Yes | Government Email | 255 characters
+link | GovURL – complex type | No | Government Link |
+email | GovEmail – complex type | Yes | Government Email |
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
@@ -471,7 +471,7 @@ export_controlled | boolean | No | Export Controlled. * Captured for future JCP
### Modification/Amendment
(submitMod)
-This method is used to submit a Modification/Amendment to any base notice.
+This method is used to submit a Modification/Amendment to the following notice types: PRESOL, COMBINE, SRCSGT, SSALE, SNOTE, SOL.
Input Parameter | Type | Description
------- | ------ | -------
@@ -489,7 +489,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date (Deprecated) | YYYYMMDD
zip | string | No |Zip Code (Deprecated) | 5 digits
-classcod | string | Yes - for SOL, COMBINE, SSALE, PRESOL | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | Yes - for SOL, COMBINE, SSALE, PRESOL | Classification Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes - for COMBINE, SOL | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
@@ -497,11 +497,11 @@ subject | string | Yes | Subject | 256 characters
solnbr | string | Yes | Solicitation # | 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
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
+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
desc | string | Yes - for PRESOL, COMBINE, SRCSGT, SSALE, SOL, SNOTE | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters
-email | GovEmail – complex type | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, SOL | Government Email | 255 characters
+link | GovURL – complex type | No | Government Link |
+email | GovEmail – complex type | Yes – for PRESOL, COMBINE, SRCSGT, SSALE, SOL | Government Email |
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
@@ -561,7 +561,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | Date | No | Posting Date (Deprecated) | YYYYMMDD
zip | String | No | Zip Code (Deprecated) | 5 digits
-classcod | String | Yes | Class-Code | Valid classification code
+classcod | String | Yes | Classification Code | Valid classification code
naics | String | No | NAICS Code | Valid NAICS Code
NAICS Reference
offadd | String | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy |65535 characters
officeid | String | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
@@ -635,7 +635,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date (Deprecated)| YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
-classcod | string | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | No | Classification Code | Valid classification code (FAR, Section 5.207(g))
naics | string | No | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
@@ -645,8 +645,8 @@ respdate | date | No - either respdate or archdate is required | Response Date |
archdate | date | No - either respdate or archdate is required | Archive Date | YYYYMMDD
contact | string | Yes | Contact Info | 255 characters
desc | string | Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters
-email | GovEmail – complex type | Yes | Government Email | 255 characters
+link | GovURL – complex type | No | Government Link |
+email | GovEmail – complex type | Yes | Government Email |
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
@@ -710,7 +710,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | Date | No | Posting Date (Deprecated) | YYYYMMDD
zip | String | No | Zip Code (Deprecated)| 5 digits
-classcod | String | No | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | String | No | Classification Code | Valid classification code (FAR, Section 5.207(g))
naics | String | No | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | String | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | String | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
@@ -719,8 +719,8 @@ 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
desc | String | Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters
-email | GovEmail – complex type | Yes if contact is provided | Government Email | 255 characters
+link | GovURL – complex type | No | Government Link |
+email | GovEmail – complex type | Yes if contact provided | Government Email |
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
recovery_act | boolean | No | Recovery Act | True or False (Default = False)
@@ -776,7 +776,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date| No| Posting Date (Deprecated| YYYYMMDD
zip| string| No| Zip Code (Deprecated) | 5 digits
-classcod| string| Yes |Class-Code| Valid classification code (FAR, Section 5.207(g))
+classcod| string| Yes |Classification Code| Valid classification code (FAR, Section 5.207(g))
naics| string| No| NAICS Code| Valid NAICS Code
NAICS Reference
officeid |string |Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd| string| No |Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy |65535 characters
@@ -785,8 +785,8 @@ 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
desc| string |Yes| Description |65535 characters
-link |GovURL – complex type| No| Government Link |255 characters
-email |GovEmail – complex type |Yes| Government Email| 255 characters
+link |GovURL – complex type| No| Government Link |
+email |GovEmail – complex type |Yes| Government Email|
links| DocumentLink[]| No |Array Of links |
files |DocumentFile[]| No |Array of files |
recovery_act| boolean |No |Recovery Act |True or False (Default = False)
@@ -842,7 +842,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date | date | No | Posting Date (Deprecated)| YYYYMMDD
zip | string | No | Zip Code (Deprecated) | 5 digits
-classcod | string | Yes | Class-Code | Valid classification code (FAR, Section 5.207(g))
+classcod | string | Yes | Classification Code | Valid classification code (FAR, Section 5.207(g))
naics | string | Yes | NAICS Code | Valid NAICS Code
NAICS Reference
officeid | string | Yes | Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account | 20 characters
offadd | string | No | Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy | 65535 characters
@@ -852,8 +852,8 @@ respdate | date | Yes | Response Date | YYYYMMDD
archdate | date | No | Archive Date | YYYYMMDD
contact | string |Yes | Contact Info | 255 characters
desc | string | Yes | Description | 65535 characters
-link | GovURL – complex type | No | Government Link | 255 characters
-email | GovEmail – complex type | Yes | Government Email | 255 characters
+link | GovURL – complex type | No | Government Link |
+email | GovEmail – complex type | Yes | Government Email |
links | DocumentLink[] | No | Array Of links |
files | DocumentFile[] | No | Array of files |
setaside | string | No | [Refer Set-Aside Values](#set-aside-values) |
@@ -913,7 +913,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date |Date |No |Posting Date (Deprecated) |YYYYMMDD
zip |String| No| Zip Code (Deprecated)| 5 digits
-classcod| String| Yes| Class-Code| Valid classification code (FAR, Section 5.207(g))
+classcod| String| Yes| Classification Code| Valid classification code (FAR, Section 5.207(g))
naics| String| No| NAICS Code| Valid NAICS Code
NAICS Reference
officeid| String| Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account| 20 characters
offadd| String |No| Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy| 65535 characters
@@ -988,7 +988,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
date| date| No |Posting Date (Deprecated)| YYYYMMDD
notice_type |string |Yes| [Refer Notice Types](#notice-types) |
zip |string |No |Zip Code (Deprecated)| 5 digits
-classcod| string| Yes - for SOL, COMBINE, SSALE, ITB, JA, PRESOL | Class-Code |Valid classification code (FAR, Section 5.207(g))
+classcod| string| Yes - for SOL, COMBINE, SSALE, ITB, JA, PRESOL | Classification Code |Valid classification code (FAR, Section 5.207(g))
naics |string |Yes - for COMBINE, SOL |NAICS Code| Valid NAICS Code
NAICS Reference
officeid| String| Yes| Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account |20 characters
offadd |string| No| Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy |65535 characters
@@ -1008,7 +1008,7 @@ awardee_duns| string |Yes - for AWARD |Awardee DUNS |9 digits with optional plus
contact| string| Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL| Contact Info| 255 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 (SNOTE only required if contact is provided)| Government Email |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
links |DocumentLink []| No |Array Of links |
files |DocumentFile[]| No| Array of files |
setaside| string| No| [Refer Set-Aside Values](#set-aside-values) |
@@ -1069,7 +1069,7 @@ Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
date| date| No |Posting Date (Deprecated) |YYYYMMDD
solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
-ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
+ntype |string |No| [Refer Notice Types](#notice-types) |
uploadtype| string| No | Upload Type (Deprecated)| 255 characters
respdate |date |No |Response Date| YYYYMMDD
links| DocumentLin k[]| Yes; Either Links or Files needs to be provided| Array Of links |
@@ -1112,50 +1112,11 @@ UnarchiveNotice Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr |string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
+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| Yes| New Archive Date| YYYYMMDD
officeid| String| No| Office ID (Not in Use)
-### Secure Document Package
(attachSecureDocumentPackagesToNotice)
-
-Service is now deprecated.
-
-### Non-FBO Solicitation
(createNonFBOSolicitation)
-
-Service is now deprecated.
-
-### Secure Document Packages
(attachSecureDocumentPackagesToNonFBOSolicitation)
-
-Service is now deprecated.
-
-### Remove Secure Document Package
(removeSecureDocumentPackagesFromNonFBOSolicitation)
-
-Service is now deprecated.
-
-### Non-FBO Solicitation Release
(releaseNonFBOSolicitation)
-
-Service is now deprecated.
-
-### Un-Release-Non-FBO-Solicitation
(unreleaseNonFBOSolicitation)
-
-Service is now deprecated.
-
-### Secure Technical Document Package
(createSecureDocumentPackage)
-
-Service is now deprecated.
-
-### Add Files to Secure Document Package
(addFilesToSecureDocumentPackage)
-
-Service is now deprecated.
-
-### Delete Files from Secure Document Package
(deleteFilesFromSecureDocumentPackage)
-
-Service is now deprecated.
-
-### Delete Secure Document Package
(deleteSecureDocumentPackage)
-
-Service is now deprecated.
## Methods Available
to All Office Location Users
@@ -1178,7 +1139,7 @@ IVLListRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
+ntype |string |No | [Refer Notice Types](#notice-types) |
IVLListResponse Complex Type Definition:
@@ -1223,7 +1184,7 @@ AuthorizedPartyListRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes |Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype| string| No| Notice Type | [Refer Notice Types](#notice-types)
+ntype| string| No| [Refer Notice Types](#notice-types) |
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method |
status| string |No |Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned
Note, use “pending” to pull the pending explicit access requests. |
@@ -1267,11 +1228,11 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string |Yes| Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
+ntype |string |No| [Refer Notice Types](#notice-types) |
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
-Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
+id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
vendor |VendorData| No| Complex type not used in this method|
-reason |string| No| Not in Use| 65535 characters
+reason |string| No| Rejection reason not used in this method| 65535 characters
Response:
@@ -1294,11 +1255,11 @@ ExplicitAccessRequestComplex Type Definition:
Element Name |Type |Required| Description | Character Limit / Restrictions
-----|-----|-----|---- | -------
solnbr |string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype| string| No| Notice Type | [Refer Notice Types](#notice-types)
+ntype| string| No| [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No| Non-fbo Solicitation #. Not supported for this method|
-Id |string |No |Not in Use | 32 characters
+Id |string |No |Not used in this method| 32 characters
vendor |VendorData| Yes| Complex type defined below|
-reason |string| No| Not in Use| 65535 characters
+reason |string| No| Rejection reason not used in this method| 65535 characters
Response:
@@ -1333,9 +1294,9 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string |Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
+ntype |string |No| [Refer Notice Types](#notice-types)
nonfbo_solbr |string| No| Non-fbo Solicitation #. Not supported for this method|
-Id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
+id| string| Yes| Matches internal record ID. This is retrieved from getAuthorizedPartyList method above.| 32 characters
vendor |VendorData| No| Complex type not used in this method|
reason| string| Yes |Rejection Reason | 65535 characters
@@ -1361,9 +1322,9 @@ ExplicitAccessRequestComplex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No| Notice Type | [Refer Notice Types](#notice-types)
+ntype |string |No| [Refer Notice Types](#notice-types)
nonfbo_solbr |string |No |Non-fbo Solicitation #. Not supported for this method|
-Id |string |No |Not in Use| 32 characters
+Id |string |No |Not used in this method| 32 characters
vendor |VendorData| Yes| Complex type defined below|
reason| string| Yes |Rejection Reason | 65535 characters
@@ -1398,11 +1359,11 @@ ExplicitAccessRequest Complex Type Definition:
Element Name | Type | Required | Description | Character Limit / Restrictions
------ | ------- | ------- | ------- | -------
solnbr| string| Yes| Solicitation # | 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
-ntype |string |No | Notice Type | [Refer Notice Types](#notice-types)
+ntype |string |No | [Refer Notice Types](#notice-types)
nonfbo_solbr| string| No |Non-fbo Solicitation #. Not supported for this method.|
-Id |string |No |Not in Use| 32 characters
+Id |string |No |Not used in this method| 32 characters
vendor |VendorData| Yes| Complex type defined below|
-reason |string| No| Not in Use| 65535 characters
+reason |string| No| Rejection reason not used in this method| 65535 characters
Response:
@@ -1437,7 +1398,7 @@ NoticeListRequest Complex Type Definition:
Element Name| Type| Required| Description | Character Limit / Restrictions
-----|-----|-----|-----|-----
-notice_type |string| No (at least 1 field is required)|Notice Type| [Refer Notice Types](#notice-types)
+notice_type |string| No (at least 1 field is required)|[Refer Notice Types](#notice-types)
solnbr |string |No (at least 1 field is required) |Solicitation #| 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
awdnbr |string |No (at least 1 field is required)|Award # | 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
posted_from |date| No (at least 1 field is required)| Posted From Date |YYYYMMDD
@@ -1546,7 +1507,7 @@ recovery_act |boolean |Recovery Act
correction| boolean |Correction of previous notice for the following types: Award #, Delivery Order #) – Awards, J&A’s, Intent to Bundle Requirements (DoD-Funded), Fair Opportunity / Limited Source Justification.
changes |NoticeData[] |This element will only be present on the base/original posting and will contain an array of changes (for any mods/awards/etc.). Each change uses the same complex type.
-DocumentPackageData Complex Type Definition: Not in Use
+DocumentPackageData Complex Type Definition: **Not in Use**
Element Name | Type | Description
------ | ------- | -------
@@ -4091,8 +4052,8 @@ notice_type | 1. This field is required where applicable | 1. Opportunity type i
zip| NA |NA
classcod |1. This field is required where applicable
2.If a wrong classification code is given, then the service throws an error | 1. Product Service Code is a required field
2. This opportunity cannot be published. Classification Code provided did not match expected codes.
naics |NA | NAICS code is required
-offadd| Not in Use| NA
-officeid |1. This field is required
2. If an invalid officeid is given, then service throws an error
3. If user does not have access to an office but is trying to make a submission to that office, then the service throws an error
|1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
+offadd| Deprecated| NA
+officeid |1. This field is required where applicable
2. If an invalid officeid is given, then service throws an error
3. If user does not have access to an office but is trying to make a submission to that office, then the service throws an error
|1. Contracting Office is required
2. Invalid officeid provided
3. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
subject | 1. This field is required where appicable |1. title: is missing but it is required
solnbr| 1. This field is required where applicable
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 for the selected opportunity type already exists
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
5. Notice ID must be unique based on selected notice type
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. This field accepts only valid values listed. If invalid values are provided, then system throws an error. Also, if all the required field is given and this field is not given then service throws an error |1. Opportunity not found with given solicitation number and ntype
2. Invalid NTYPE value provided
@@ -4155,7 +4116,7 @@ deletemethod| 1. If an invalid deletemethod is provided, then service throws an
#### archiveNotice
Individual business rules per field are listed across each of the fields in below table.
-* Note: : If a user tries to archive a notice that is already archived, then the service throws an error - Opportunity already archived
+* Note: If a user tries to archive a notice that is already archived, then the service throws an error - Opportunity already archived
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
@@ -4168,7 +4129,7 @@ archdate| 1. No validation is performed on this field. However, if this value is
#### unarchiveNotice
Individual business rules per field are listed across each of the fields in below table.
-* Note: : If a user tries to unarchive a notice that is already unarchived, then the service throws an error - Opportunity is not archived
+* Note: If a user tries to unarchive a notice that is already unarchived, then the service throws an error - Opportunity is not archived
* Note: If a user tries to unarchive an active notice, then the service throws an error - Opportunity is active
Element Name | Business Rules | Error Messages with respect to business rules (If any)
@@ -4204,7 +4165,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)
------ | ------- | ------- | ------- | --------
notice_id | notice_id is required| notice_id from getList is required
-Get_changes| NA| NA
+get_changes| NA| NA
get_changes_from_date| Date field should meet the expected format| DATE field in unexpected format. Expects YYYYMMDD
get_file_data |NA |NA
@@ -4253,7 +4214,7 @@ status| 1. If the status value entered doesn’t match the valid values , then t
Individual business rules per field are listed across each of the fields in below table.
-ID can be obtained through getAuthorizedPartyList
+* Note: ID can be obtained through getAuthorizedPartyList
Element Name | Business Rules | Error Messages with respect to business rules (If any)
------ | ------- | ------- | ------- | --------
@@ -4310,52 +4271,36 @@ nonfbo_solbr | 1. If both solnbr and nonfbo_solbr are provided, then the service
vendor| 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error
2. If no match is found in the system for the vendor data provided, then the system throws an error
3. If the Explicit Access request found for the vendor and solnum is already rejected, then the system throws an error| 1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown
2. No contact match on vendor data provided
3. Request with Request ID: #id already rejected
reason| 1. This is a required field. If no value is provided, then the system throws an error| 1. A reason must be provided with an explicit access rejection
-#### submitFairOpps
-
-This service is now deprecated. Instead, please use submitJA to perform the operation.
-
-#### submitForeignGovernment
-
-This service is now deprecated.
-
-#### setBidModuleOptions
-Service is now deprecated.
-
-#### getBidModuleResponses
-Service is now deprecated.
-
-#### createSecureDocumentPackage
-Service is now deprecated.
-
-#### addFilesToSecureDocumentPackage
-Service is now deprecated.
-
-#### deleteFilesFromSecureDocumentPackage
-Service is now deprecated.
-
-#### deleteSecureDocumentPackage
-Service is now deprecated.
-
-#### releaseSecureDocumentPackage
-Service is now deprecated.
-
-#### attachSecureDocumentPackagesToNotice
-Service is now deprecated.
-
-#### createNonFBOSolicitation
-Service is now deprecated.
-#### attachSecureDocumentPackagesToNonFBOSolicitation
-Service is now deprecated.
-#### removeSecureDocumentPackagesFromNonFBOSolicitation
-Service is now deprecated.
+### Deprecated Methods
+* submitFairOpps *(Instead use submitJA to perform the operation)*
+* submitForeignGovernment
+* setBidModuleOptions
+* getBidModuleResponses
+* createSecureDocumentPackage
+* addFilesToSecureDocumentPackage
+* deleteFilesFromSecureDocumentPackage
+* deleteSecureDocumentPackage
+* releaseSecureDocumentPackage
+* attachSecureDocumentPackagesToNotice
+* createNonFBOSolicitation
+* attachSecureDocumentPackagesToNonFBOSolicitation
+* removeSecureDocumentPackagesFromNonFBOSolicitation
+* releaseNonFBOSolicitation
+* unreleaseNonFBOSolicitation
+* attachSecureDocumentPackagesToNotice
+* createNonFBOSolicitation
+* attachSecureDocumentPackagesToNonFBOSolicitation
+* removeSecureDocumentPackagesFromNonFBOSolicitation
+* releaseNonFBOSolicitation
+* unreleaseNonFBOSolicitation
+* createSecureDocumentPackage
+* addFilesToSecureDocumentPackage
+* deleteFilesFromSecureDocumentPackage
+* deleteSecureDocumentPackage
-#### releaseNonFBOSolicitation
-Service is now deprecated.
-#### unreleaseNonFBOSolicitation
-Service is now deprecated.
@@ -4381,7 +4326,7 @@ Date | Version | Description
8/19/2019 | v0.5 | SUBMITPRESOL/SOURCESSOUGHT, SUBMITCOMBINED, SUBMITAWARD, SUBMITSALEOFSURPLUS, SUBMITJA, SUBMITITB, SUBMITSPECIANOTICE, SUBMITMOD, ARCHIVENOTICE, UNARCHIVENOTICE, CANCELNOTICE, SUBMITDOCUMENTSANDLINKS, GETLIST, GETNOTICEDATA, GETFILEDATA, DELETENOTICE parameters updated
User Account Section Updated
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| Added Notice Type and Related Notice sections for reference. Updated the character limits. Removed redundant Required and Character Limit columns from Business Rules section. Consolidated Business Rules section for all Submit methods. Updated submitMod and submitNotice methods to align with implemenation.
+10/28/2019 | v0.8| See attached document
From ac3e95f84ee34951230ee5d755e2289b19d7a2a7 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Thu, 31 Oct 2019 13:42:13 -0400
Subject: [PATCH 123/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 5ba53ddaa..91284d857 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -3231,7 +3231,7 @@ reason | string | | No | Publish reason
* Field headers in the table must match with field headers shown in JSON example
Name | Data Type |Field Length | Allowed Values| Required | Description
------|-----------|-------|-------------------|------------|------------ |----------
+-----|-----------|-------|-------------------|------------|------------
type | string | 1 character| [Refer Notice Types](#notice-types) | Yes | 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
From b0082f59a921d4423c688a5fba5a1f30070d5b57 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Thu, 31 Oct 2019 13:43:13 -0400
Subject: [PATCH 124/149] Update opportunities-api.md
---
_apidocs/opportunities-api.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md
index 91284d857..a5bff2fe5 100644
--- a/_apidocs/opportunities-api.md
+++ b/_apidocs/opportunities-api.md
@@ -3232,13 +3232,13 @@ reason | string | | No | Publish reason
Name | Data Type |Field Length | Allowed Values| Required | Description
-----|-----------|-------|-------------------|------------|------------
-type | string | 1 character| [Refer Notice Types](#notice-types) | Yes | Yes | Notice Type
+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| No | Yes for type = k, o (Combined Synopsis, Solicitation) | Valid NAICS Code
+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
@@ -3304,7 +3304,7 @@ justificationAuthority.
authority | string| | | Yes | Justification Author
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 | NA | Related Notice information
+related | JSON | NA | NA | NA | Related Notice information
related.opportunityId | string | 32 characters| | No | Opportunity Id of the related notice
resources | JSON |NA | NA | NA |
resources.attType | string | |link, file | No| Type of attachment, either link or file
From 8c0e52a34efcda3f83751884888d6460659a6d38 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Thu, 31 Oct 2019 13:52:22 -0400
Subject: [PATCH 125/149] Create Opportunity Management SOAP Web Services
Change Log v0.8.docx
---
...ement SOAP Web Services Change Log v0.8.docx | Bin 0 -> 15758 bytes
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 _apidocs/opportunities-soap-api/v1/Opportunity Management SOAP Web Services Change Log v0.8.docx
diff --git a/_apidocs/opportunities-soap-api/v1/Opportunity Management SOAP Web Services Change Log v0.8.docx b/_apidocs/opportunities-soap-api/v1/Opportunity Management SOAP Web Services Change Log v0.8.docx
new file mode 100644
index 0000000000000000000000000000000000000000..dcd45359ae9b0011fa07653b0d70926a22772095
GIT binary patch
literal 15758
zcmeHugL|ag(r+}G*tRCNor!JRwr$(CGqG*kwllFkNpAKzXWy-J??3Q;Z$I7r^s4o%
zx4OHuR@IUb2L?d`00jU8006)TppUgyHUb0yDEtBdfCvBvq|R?`IQ(_Cc-F6BmwMNasVQdNG8R5XqL&Z<_#cuWse;N=_}Zy=OX`S5jL&93
z1
User Account Section Updated
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| See attached document
+10/28/2019 | v0.8| See attached document
attached document
+
From 3b09c18d14f282258050c64348e99bcf72bdcae3 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Thu, 31 Oct 2019 13:55:25 -0400
Subject: [PATCH 127/149] Update opportunities-soap-api.md
---
_apidocs/opportunities-soap-api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_apidocs/opportunities-soap-api.md b/_apidocs/opportunities-soap-api.md
index 9206113c8..e65a1b497 100644
--- a/_apidocs/opportunities-soap-api.md
+++ b/_apidocs/opportunities-soap-api.md
@@ -4326,7 +4326,7 @@ Date | Version | Description
8/19/2019 | v0.5 | SUBMITPRESOL/SOURCESSOUGHT, SUBMITCOMBINED, SUBMITAWARD, SUBMITSALEOFSURPLUS, SUBMITJA, SUBMITITB, SUBMITSPECIANOTICE, SUBMITMOD, ARCHIVENOTICE, UNARCHIVENOTICE, CANCELNOTICE, SUBMITDOCUMENTSANDLINKS, GETLIST, GETNOTICEDATA, GETFILEDATA, DELETENOTICE parameters updated
User Account Section Updated
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| See attached document
attached document
+10/28/2019 | v0.8| See attached document
From 5cb0c6babc3c6c8a9fe2f1f00cb335cfd8513a6d Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Thu, 31 Oct 2019 13:57:03 -0400
Subject: [PATCH 128/149] Create ~$portunity Management SOAP Web Services
Change Log v0.8.docx
---
...agement SOAP Web Services Change Log v0.8.docx | Bin 0 -> 162 bytes
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 _apidocs/opportunities-soap-api/v1/~$portunity Management SOAP Web Services Change Log v0.8.docx
diff --git a/_apidocs/opportunities-soap-api/v1/~$portunity Management SOAP Web Services Change Log v0.8.docx b/_apidocs/opportunities-soap-api/v1/~$portunity Management SOAP Web Services Change Log v0.8.docx
new file mode 100644
index 0000000000000000000000000000000000000000..d1809db3304fb3475797714ba491f48f22b7e047
GIT binary patch
literal 162
zcmd<~PRvUW&(BkE&d6sV8gMgsGbA$PF{CquGvotl1qNq^3?PevAtY6niGe}j
User Account Section Updated
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| See attached document
+10/28/2019 | v0.8| See attached document
From 5687d170365b970a3046e9f4d70a039a98f19a84 Mon Sep 17 00:00:00 2001
From: whrkddnjs135 <>
Date: Thu, 31 Oct 2019 13:57:08 -0400
Subject: [PATCH 130/149] Create Opportunity Management SOAP Web Services
Change Log v0.8.pdf
---
...ement SOAP Web Services Change Log v0.8.pdf | Bin 0 -> 135979 bytes
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 _apidocs/opportunities-soap-api/v1/Opportunity Management SOAP Web Services Change Log v0.8.pdf
diff --git a/_apidocs/opportunities-soap-api/v1/Opportunity Management SOAP Web Services Change Log v0.8.pdf b/_apidocs/opportunities-soap-api/v1/Opportunity Management SOAP Web Services Change Log v0.8.pdf
new file mode 100644
index 0000000000000000000000000000000000000000..ed8a5661da97ad32ba3c950ac6bf911c9e8f54f6
GIT binary patch
literal 135979
zcmce-1z40#+c%EVox;*fH|)|V-AZ@I0!v7D_W}wi2vX9GN{WPlbV+v#Qqo-_`7PY#
z{XWnAzR&;t{>R52>^0Y1XU&}F%r)~nXBkwbWjVl{0@xS~Rq#J-3@{J`bToU4jUg<|
zrRnVi<&uK9LF^o@xKtrlP*)%~{INQhBE-Rp8S22HrNIK^(r|NeH+R!?fkM?C9o>N3
zJa;5Y5Et9W4wjB^F}Fpi1rSaK6&2-Dg1SL0;4*>SV9*_@7TP|8W-p!5@{lXT{C==m%-G7}SX(Tk7xtF?4HC8NKZP4dMj(ws+9F}Sj
z632Uj{NU`y_A7|%f`{AlvdvFG2lOb$38RPk0b+?1(-=siQ4%cR=*kD1R%Qy^k&6`i
zn(q`wJ_X^EQ?!*#GZcrG7m%zNWGyeajXfK|l=pg&+9=_JkL8Hbyq=&_KoXuU&V`kG
zty|L#!gj#41UG$6Ta0q3D>u;lq!ulOG=rxlSHY}0z5@8+SeG@tpc@k1{UmHKE(fs7
zk%ZAw`zA=cyn3V;M3ff-$$I-b=6ZBUIuawqQxIZCN7B_Dujsw-uqs%>ZUt!N66DLl
znrZ8*sSYUa0=#UYa)sbUFQLtw)906hKv>8SQ$XBHztqJM3p{G86Nch92`d;UkF!P0
z)_1?q0eq@$!}t@Y)T8#CN#_kc7fj1=z*srhF>kuusMg{3Y>OFr3rZS=jk>gtGeO
zXTeUBR^vNY{Y=9UKGCt{dPy^AOtFmPOBo|F&X~waX)rRH6@K1jr3$(?zxLd95-iX9-y!rJyXM6kBc)>C
zU(w%~yypr)r3kJj|wG@BX6+N
z)G|h#-#=4HJT=;m^Ghc($(N~cn$G3wk&)JW(aZ=xx_NXGQ{1ja|zoHx=Ov{
zs4>M(TLlR-2|h2&tQBj8G>XD)F{Fr0hns+96&njNXV#6lwy+vljR6~x;DsU_{&tYe
zFuNXFS>IUJ&OE9j?8J4-A_WMJ@1h#Bo$_DYOXBC%UgzdpK{F7E+D*4*@?BW*C5Vh!
z&I-L