Overview

The Opportunity Management SOAP APIs will allow authorized users to submit and request opportunities data. This document will provide electronic users with the technical specifications required to utilize the Contract Opportunities Web Services capability.

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

Getting Started

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
  • Beta WSDL Link: Coming Soon

SOAP Web Services Workflow Chart

To view the current workflow of SOAP web service, refer below file:

Authentication

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.

Type of Connection Validation (Future Implementation)

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)

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

beta.SAM.gov Web Services supports SOAP header authentication. Configure your client to send a specific SOAP header with every method call which contains the authentication data. Below is the example of header included before the body:

  • Note: Username and email are case sensitive
   <soapenv:Header>
      <AuthenticationData xsi:type="sam:AuthenticationData">
        <username xsi:type="xsd:string">system account username</username>
        <password xsi:type="xsd:string">system account password</password>
        <emailid xsi:type="xsd:string">ContractingOfficeEmail@gsa.gov</emailid>
     </AuthenticationData>
   </soapenv:Header>

Note: When submitting, retrieving or archiving/unarchiving, if user provided officeId along with system account user name and password, then the service first validates if the officeId provided is a valid office in Federal Hierarchy. If it’s a valid office, then the service validates if the given system account has access to that office. If the system account has access to the office, only then the user can proceed ahead with the SOAP services.

When the given officeId is not a valid office in Federal Hierarchy, then the service throws below error and user cannot proceed ahead with using SOAP services: Insufficient privileges to retrieve system account profile as the given organization is invalid

When the given officeId is valid but does not fall under the approved Federal Hierarchy for the given system account, then the service throws below error and user cannot proceed ahead with using SOAP services: Insufficient privileges to retrieve system account profile as the given organization is not part of the approved FH hierarchy

Note: The complex type definition for this object (AuthenticationData) is located in the WSDL. It contains three string elements named “username”, “password” and “emailid”. Refer the WSDL attached below:

Namespace Guidance

The authentication namespace must match for a web service call to be successful. This is due to core settings for the web services internals where the authorization header validates the namespace against the WSDL. So, when the namespace for your authentication header in soap xml does not match the namespace defined in the WSDL at the endpoint (in this case sam), it does not pass on the credentials (username/password/emailid). Therefore, the Contract Opportunities service is not able to authenticate the user and returns an authentication error.

  • Test Server Namespace: https://www.sam.gov

  • Production Server Namespace: https://www.sam.gov

Method Overview

All methods available can be found in the WSDL and will be listed in this document. Methods will take different parameters ranging from basic types (string/integer/boolean/date and array of these types) or complex data types that are further comprised of these basic types and sometimes other complex data types.
Supported input content type formats are text/xml. Note: For all elements/parameters that are specified as type “date,” please supply date in YYYYMMDD (i.e. 20090428) format.

Responses

Most methods will return data in the format of the PostingResponse complex type. This consists of two elements:

  • The first element is named ‘success’ and is a boolean value. If the method successfully completed, this element will be true or 1. If it is false, empty, or 0, then the method was not successful.
  • The second element is named ‘messages’ and is an array of strings. Mostly for error cases, this element will contain any relevant error messages (or sometimes success messages) that pertain to the web services method called.

Posting Response Complex Type Definition

Element Name Type
success boolean
messages string [] - array of strings

Note: Some methods will have a different response value format due to the nature of the data being returned. These custom cases will be outlined below.

Set-Aside Values

Several methods pertaining to submitting Contract Opportunities involve the Set-Aside Type field.

Refer below table for mapping between legacy SetAside Values to modern SetAside Value:

Modern SetAside Values Legacy SetAside values
Total Small Business Set-Aside (FAR 19.5) Total Small Business
Partial Small Business Set-Aside (FAR 19.5) Partial Small Business
8(a) Set-Aside (FAR 19.8) Competitive 8(a)
8(a) Sole Source (FAR 19.8) Competitive 8(a)
Historically Underutilized Business (HUBZone) Set-Aside (FAR 19.13) HUBZone
Historically Underutilized Business (HUBZone) Sole Source (FAR 19.13) HUBZone
Service-Disabled Veteran-Owned Small Business (SDVOSB) Set-Aside (FAR 19.14) Service-Disabled Veteran-Owned Small Business
Service-Disabled Veteran-Owned Small Business (SDVOSB) Sole Source (FAR 19.14) Service-Disabled Veteran-Owned Small Business
Women-Owned Small Business (WOSB) Program Set-Aside (FAR 19.15) Women-Owned Small Business
Women-Owned Small Business (WOSB) Program Sole Source (FAR 19.15) Women-Owned Small Business
Economically Disadvantaged WOSB (EDWOSB) Program Set-Aside (FAR 19.15) Economically Disadvantaged Women-Owned Small Business
Economically Disadvantaged WOSB (EDWOSB) Program Sole Source (FAR 19.15) Economically Disadvantaged Women-Owned Small Business
Local Area Set-Aside (FAR 26.2)  

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.

Stauth Valid Values

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

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

Contracting Officer
Method Details

Award Notice (submitAward)

This method is used to submit an award notice.

Input parameters:

Input Parameter Type Description
Data Award Complex type defined

Response:

Output Parameter Type Description
Response PostingResponse ComplexType

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
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
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, “ITB” - for Intend to bundle
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
awdamt string Yes Award Amount 64 characters
linenbr string No Line Number 255 characters
awddate date Yes Award Date YYYYMMDD
archdate date No Archive Date YYYYMMDD
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)  
email GovEmail No Government Email 128 characters
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Set Aside See Set Aside Value Section for valid 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.

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

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

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

DocumentFile Complex Type Definition

Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Delete Notice/ Document Package
(deleteNoticeOrDocumentPackage)

This method is used to permanently delete an entire notice or delete attachments across all versions of the notice. Modifications/Amendments are recommended instead of using this method. Specify the solicitation number or award number to delete a notice. To delete attachments, also specify the attachment deletetype.

Input Parameters:

Input Parameter Type Description
data DeleteNoticeOrDocumentPackage Complex type defined below

Response:

Output Parameter Type Description
response PostingResponse Complex type

DeleteNoticeOrDocumentPackage Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
solnbr string no 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, “ITB” - for Intent to Bundle Requirements (DoD- Funded)
awdnbr string no Award # 255 characters
deletetype string no Notice or Attachment delete operation type Valid Values: “notice” for notice, “attachment” for attachment. 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)

This method is used to update the archive date on an existing notice. If a past date is provided or no date provided at all, the notice will be immediately archived.

Input Parameters:

Input Parameter Type Description
data ArchiveNotice Complex type defined below

Response:

Output Parameter Type Description
response PostingResponse Complex type defined below

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, “ITB” - for Intent to Bundle Requirements (DoD- Funded)
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

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.

Input Parameters:

Input Parameter Type Description
data CancelNotice Complex type defined below

Response:

Output Parameter Type Description
response PostingResponse Complex type

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
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 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, “ITB” - for Intent to Bundle Requirements (DoD- Funded)
awdnbr string No Award # 255 characters
archdate date No Archive Date YYYYMMDD
contact string Yes Contact Info 65535 characters
desc string Yes Cancellation Description 65535 characters

Contracting Officer/Contracting
Specialist Method Details

Presolicitation
(submitPresol)

This method is used to submit a Pre-solicitation Notice.

Input Parameters:

Input Parameter Type Description
Data Presol Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type defined below

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
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
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
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 No Government Email 128 characters
links DocumentLink[] No Array of links  
files DocumentFile[] No Array of files  
setaside string No Set-aside See Set Aside Values Section for valid values
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: 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

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

DocumentLink Complex Type Definition: This field is not implemented

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: This field is not implemented

Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Combined/Synopsis
(submitCombined)

This method is used to submit a Combined/Synopsis Notice.

Input Parameter Type Description
Data Combined Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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
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
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
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 No Government Email 128 characters
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Set-aside See Set Aside Values section for valid values
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: 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

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

DocumentLink Complex Type Definition: This field is not implemented

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: This field is not implemented

Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Modification/Amendment
(submitMod)

This method is used to submit a Modification/Amendment to any base notice.

Input Parameter Type Description
Data Mod Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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
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
subject string no 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
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
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
links DocumentLink[] no Array Of links  
files DocumentFile[] no Array of files  
setaside string no Set-aside See Set Aside Value Section for valid values
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:

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

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

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

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Justification and Authorization
(J&A) Notice (submitJA)

This method is used to submit a J&A Notice.

Input Parameter Type Description
Data JA Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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
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
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
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 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)
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
email GovEmail No 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.

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

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

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

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Sources Sought Notice
(submitSourcesSought)

This method is used to submit a Sources Sought Notice.

Input Parameter Type Description
Data SourcesSought Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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
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
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
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)
email GovEmail – complex type No Government Email 128 characters
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Set-aside See Set Aside Value Section
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: 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

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

DocumentLink Complex Type Definition: This field is not implemented

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: This field is not implemented

Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Foreign Government Standard
(submitForeignGovernment)

This service is now deprecated. Hence no longer available.

Special Notice
(submitSpecialNotice)

This method is used to submit a Special Notice.

Input Parameter Type Description
Data SpecialNotice Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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
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 Subject 255 characters
solnbr String Yes Sol # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
archdate 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)
email GovEmail – complex type No Government Email 128 characters
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
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 - 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

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

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Sale of Surplus Property Notice
(submitSaleOfSurplus)

This method is used to submit a Sale of Surplus Property Notice.

Input Parameter Type Description
Data SaleOfSurplus Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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
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
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
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 No Government Email 128 characters
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
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

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

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

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Intent to Bundle Requirements
(DoD- Funded) (submitITB)

This method is used to submit an Intent to Bundle Requirements (DoD-Funded) Notice.

Input Parameter Type Description
Data ITB Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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
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
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
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 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)
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
email GovEmail No 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.

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

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

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
Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Fair Opportunity / Limited Sources
Justification (submitFairOpp)

This service is now deprecated. Instead, please use submitJA to perform the operation.

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
Input Parameter Type Description
Data CompleteNotice Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

Complete notice Complex Type Definition:

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
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
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
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
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
awardee_duns string no Awardee DUNS 9 digits with optional plus 4
contact string Yes – for presol, submitSourcesSought, combined, itb, ja, award, saleofSurplus

No – for rest
Contact Info 65535 characters
desc string Yes – For presol, submitSourcesSought, combined, ITB, special and saleOfSurplus

No – For rest
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 No Government Email 128 characters
links DocumentLink [] no Array Of links  
files DocumentFile[] no Array of files  
setaside string no Set-aside types See Set Aside Section for valid values
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
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.

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

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

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
Element Name Type Required Description Character Limit / Restrictions
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’
export_controlled boolean No Export Controlled  

Document Packages
(submitDocumentsAndLinksToNotice)

This method is used to attach document packages (non sensitive) to a notice modification. This is similar to the EPSUPLOAD or DocumentUpload function currently found in the ftp/email electronic interface. The web service method now supports transmitting actual file data along with external links. Note: A base notice must already exist in the system.

Input Parameter Type Description
Data DocumentUpload Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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
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  
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:

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
filedata base64binary No File Data 100 MB
desc string No Description 255 characters
explicit_access boolean No Explicit Access Defaults to ‘false’
export_controlled boolean No Export Controlled  

Unarchive Notice
(unarchiveNotice)

This method is used to unarchive a notice or stand-alone award. Note: Provide a Solicitation Number or an Award Number to unarchive the related opportunity.

Input Parameter Type Description
Data UnarchiveNotice Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

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, “ITB” - for Intent to Bundle Requirements (DoD- Funded)
awdnbr string No Award # 255 characters
archdate date No New Archive Date YYYYMMDD

Secure Document Package
(attachSecureDocumentPackagesToNotice)

Details will be added in future.

Non-FBO Solicitation
(createNonFBOSolicitation)

Details will be added in future.

Secure Document Packages
(attachSecureDocumentPackagesToNonFBOSolicitation)

Details will be added in future.

Remove Secure Document Package
(removeSecureDocumentPackagesFromNonFBOSolicitation)

Details will be added in future.

Non-FBO Solicitation Release
(releaseNonFBOSolicitation)

Details will be added in future.

Un-Release-Non-FBO-Solicitation
(unreleaseNonFBOSolicitation)

Details will be added in future.

Secure Technical Document Package
(createSecureDocumentPackage)

Details will be added in future.

Add Files to Secure Document Package
(addFilesToSecureDocumentPackage)

Details will be added in future.

Delete Files from Secure Document Package
(deleteFilesFromSecureDocumentPackage)

Details will be added in future.

Delete Secure Document Package
(deleteSecureDocumentPackage)

Details will be added in future.

Methods Available
to All Office Location Users

getIVLList

This method is used to retrieve the Interested Vendors List (IVL) for a given solicitation.

Input Parameter Type Description
Data IVLListRequest Complex type defined below

Response:

Output Parameter Type Description
Response IVLListResponse Complex type defined below

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, “ITB” – for Intent to Bundle Requirements (DoD- Funded)

IVLListResponse Complex Type Definition:

Element Name Type Description
success boolean Success flag
data IVL[] Array of IVL Records
messages string[] Array of any messages, usually used in error case.

IVL Complex Type Definition:

Element Name Type Description
lname string Last Name
fname string First Name
email string Email
phone string Phone
contractor_name string Contractor Name
dba_name string DBA Name
duns string DUNS #
cage_code string Cage Code
address string Address
bus_types string Business Types
naics_codes string Naics Codes

Authorized Parties List
(getAuthorizedPartyList)

This method is used to retrieve the Authorized Party lists for an FBO Solicitation or a Non-FBO Solicitation. A third argument - ‘status’ - can be provided to retrieve pending Explicit Access requests, rejected requests, approved vendors, or all. Specify the first parameter to the web service method for FBO Solicitations and leave the second parameter blank. If retrieving lists for Non-FBO Solicitations, leave the first parameter blank and specify the second parameter. Valid options for status field: approved, rejected, pending, or leave blank for all.

Input Parameter Type Description
Data AuthorizedPartyListResponse Complex type defined below

Response:

Output Parameter Type Description
Response AuthorizedPartyListResponse Complex type defined below

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, “FSTD” - for Foreign Government Standard, “ITB” – for Intent to Bundle Requirements (DoDFunded)
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:

Output Parameter Type Description
success boolean Success flag
message string[] Array of any messages, usually used in error case
data AuthorizedParty[] Array of Authorized party Records

AuthorizedParty Complex Type Definition:

Output Parameter Type Description
type_of_request string Indicates if the id is a resource or a notice level request
resource_name string Only populates if the type_of_request is a resource.
id string Internal ID
status string Status of record (approved, rejected, pending). Pending indicates an explicit access request.
lname string Last Name
fname string First Name
email string Email
phone string Phone
contractor_name string Contractor Name
dba_name string DBA Name
duns string DUNS #
cage_code string Cage Code

Approve Explicit Access Requests
(approveExplicitAccessRequestByID)

This method is used to approve an Explicit Access request that is either in pending or rejected status. This method requires the internal ID which can be retrieved by first calling the getAuthorizedPartyList method. Specify an FBO Solicitation Number as the first argument.

Input Parameters:

Input Parameter Type Description
data ExplicitAccessRequest Complex type defined below

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, “ITB” – for Intent to Bundle Requirements (DoD- Funded)
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:

Output Parameter Type Description
Response PostingResponse Complex type

Approve Explicit Access Requests
(approveExplicitAccessRequestByVendorData)

Details will be added in future

Reject Explicit Access Requests
(rejectExplicitAccessRequestByID)

This method is used to reject an Explicit Access request or Authorized Party record that is either in pending or approved status. This method requires the internal ID which can be retrieved by first calling the getAuthorizedPartyList method. Specify an FBO Solicitation Number as the first argument.

Input Parameters:

Input Parameter Type Description
data ExplicitAccessRequest Complex type defined below

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, “ITB” – for Intent to Bundle Requirements (DoD- Funded)
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:

Output Parameter Type Description
Response PostingResponse Complex type

Reject Explicit Access Requests
(rejectExplicitAccessRequestByVendorData)

Details will be added in future

Add Authorized Party
(addAuthorizedParty)

This method is used to arbitrarily add vendor users to the Authorized Party list for a given FBO Solicitation. This method accepts an FBO Solicitation Number and a set of vendor data. The method attempts to lookup the vendor in the system based on the data provided and adds an Authorized Party record if the match is successful. This method has been deprecated for Non-FBO Solicitation Number.

Input Parameter Type Description
data ExplicitAccessRequest Complex type defined below

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, “ITB” – for Intent to Bundle Requirements (DoD- Funded)
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:

Output Parameter Type Description
Response PostingResponse Complex type

VendorData Complex Type Definition:

Element Name Type Description
lname string Last Name
fname string First Name
email string Email
contractor_name string Contractor Name
duns string DUNS #
cage_code string Cage Code

Method Available for Data Export

Get List of Notices
(getList)

This method is used to retrieve a list of base notices. For each record returned, an internal identifier/unique key is provided that must be used in subsequent getNoticeData calls to get the complete notice data (and any of its changes or awards posted). The method will return a maximum of 1000 records and allows filtering the results by specifying the notice type, solicitation number, award number, posted date range and documents to search (active or archive). For performance reasons, at least one filter must be provided.

Input Parameters:

Input Parameter Type Description
data NoticeListRequest Complex type defined below

NoticeListRequest Complex Type Definition:

Element Name Type Required Description
notice_type string No Solicitation #. Valid Values: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB. 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.

Response:

Output Parameter Type Description
response NoticeListResponse Complex type

NoticeListResponse Complex Type Definition:

Element Name Type Description
success boolean False if something failed in the request.
messages string[] Array of messages if application has any info about the call. Error Messages will be displayed when failures happened in the request. Eg : 401, 404 (Bad Request) etc.
num_records_returned int Number of records returned for pagination requested or default pagination.
total_num_records int Total Number of records that matched the search
data NoticeListItem[] Array of complex type defined below.

NoticeListItem Complex Type Definition:

Element Name Type Description
Notice_id string Unique Identifier for this notice
base_type string Notice type of original/base posting. Note that this is equivalent to current_type.
current_type string Current type of notice (i.e. if Presol becomes a solicitation or an award was posted)
last_posted_date date Datetime of the last change made to the notice.
subject string Notice subject
solnbr string Solicitation Number
awdnbr string Award Number
archived boolean True or false

Get Notice Data
(getNoticeData)

This method is used to retrieve notice data and any changes/awards that were made. The notice_id from getList calls should be used in this call. If document package data is requested, the total aggregate size for any request is 100MB. If a certain file pushes the total past this threshold, the data will not be returned for that file and any others encountered for the request; instead, links to the data will be provided and one can call the separate getFileData to cut down the size and to pull a specific document.

Input Parameters:

Input Parameter Type Description
data NoticeDataRequest Complex type defined below

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.

Response:

Output Parameter Type Description
response NoticeDataResponse Complex type

NoticeDataResponse Complex Type Definition:

Element Name Type Description
success boolean False if something failed in the request.
messages string[] Array of messages if application has any info about the call. Error Messages will be displayed when failures happened in the request. Eg : 401, 404 (Bad Request) etc.
notice NoticeData Complex Type defined below

NoticeData Complex Type Definition:

Element Name Type Description
id string Unique ID
notice_type string Type of notice
agency string Top level Agency
office string Office
location string Location
date dateTime Posting Date
zip string Zip Code
classcod string Class-Code
naics string NAICS Code
offadd string Office Address
subject string Subject
solnbr string Sol #
awdnbr string Award #
donbr string Delivery/Task Order Number
awdamt string Award Amount
linenbr string Award Line Item Number
awddate date Award Date
stauth string J&A StatutoryAuthority
foja String Justification Authority
modnbr string J&A and FairOpp Contract Modification Number
respdate date Response Date
archdate date Archive Date
awardee string Awardee
awardee_duns string Awardee DUNS
contact string Contact Info
desc string Main Description
link GovernmentURL Government Link
email Government Email Government Email
files DocumentPack ageData[] Array of package data if applicable
setaside string Set-aside types
popaddress string POP Address
popzip string POP Zip
popcountry string POP 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.

DocumentPackageData Complex Type Definition:

Element Name Type Description
package_id string Unique ID
label string Package label
type string Type of package
sensitive string Is the package marked as sensitive
pr_number string Identifier for sensitive data
project_number string Project number used for sensitive packages only
nsn_mmac string Used for sensitive packages only
part_number string Used for sensitive packages only
nomenclature string Used for sensitive packages only
export_controlled boolean True or False – used for sensitive packages only
explicit_access boolean True or False – used for sensitive packages only
is_cd_avail boolean True or False – used for sensitive packages only
files DocumentFile Data[] Array of Document Files/Links as described below

DocumentFileData Complex Type Definition:

Element Name Type Description
file_id string Unique ID
filename string Filename – only used for files stored on notices
filedata base64Binary File data – only used for files stored on notices
link string Link to file – used for files not stored on notices
desc string Description
size_limit_error boolean This element will be true if its size or aggregate file data for the request exceeds the max return size.

Get Document Package Data
(getDocumentPackageData)

This service is now deprecated

Get File Data
(getFileData)

This method provides the ability to pull in file data for a single file of a document package. The primary use of this method is if a single file’s size exceeds the 100MB max– when using this method for a single file, the file limit check does not occur.

Input Parameters:

Input Parameter Type Description
data FileDataRequest Complex type defined below

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)

Response:

Output Parameter Type Description
response FileDataResponse Complex type

NoticeDataResponse Complex Type Definition:

Element Name Type Description
success boolean False if something failed in the request.
messages string[] Array of messages if application has any info about the call
file DocumentFileData Complex Type defined below

DocumentFileData Complex Type Definition:

Element Name Type Description
file_id string Unique ID
filename string Filename – only used for files stored on FBO
notice_id string Unique identifier for a notice
filedata base64Binary File data – only used for files stored on FBO
link string Link to file – used for files not stored on FBO
desc string Description
size_limit_error boolean This element will be true if its size or aggregate file data for the request exceeds the max return size.

Examples

Please note that variances may exist between SOAP requests generated by different XML tools and the samples below. The web service should still operate as expected as long as the syntax is CONSISTENT throughout the submission.

submitPresol

Request Sample
Response Sample - Success
Response Sample - Failure

submitCombined

Request Sample
Response Sample - Success
Response Sample - Failure

submitSourcesSought

Request Sample
Response Sample - Success
Response Sample - Failure

getList

Request Sample
Response Sample - Success
Response Sample - Failure

submitAward

Request Sample
Response Sample - Success
Response Sample - Error

submitJA

Request Sample
Response Sample - Success
Response Sample - Error

submitITB

Request Sample
Response Sample - Success
Response Sample - Error

submitSpecialNotice

Request Sample
Response Sample - Success
Response Sample - Error

archiveNotice

Request Sample
Response Sample - Success
Response Sample - Error

submitMod

Request Sample
Response Sample - Success
Response Sample - Error

unarchiveNotice

Request Sample
Response Sample - Success
Response Sample - Error

submitNotice

Request Sample
Response Sample - Success
Response Sample - Error

CancelNotice

Request Sample
Response Sample - Success
Response Sample - Error

submitDocumentsAndLinksToNotice

Request Sample
Response Sample - Success
Response Sample - Error

getFileData

Request Sample
Response Sample - Success
Response Sample - Failure

addAuthorizedParty

Request Sample
Response Sample - Success
Response Sample - Failure

deleteNoticeorDocumentPackage

Request Sample
Response Sample - Success
Response Sample - Failure

getAuthorizedPartyList

Request Sample
Response Sample - Success
Response Sample - Failure

approveExplicitAccessRequestbyID

Request Sample
Response Sample - Success
Response Sample - Failure

rejectExplicitAccessRequestbyID

Request Sample
Response Sample - Success
Response Sample - Failure

getNoticeData

Request Sample
Response Sample – Success
Response sample – error

submitSaleOfSurplus

Request Sample
Response Sample – Success
Response Sample – Failure

getIVLList

Request Sample
Response Sample - Success
Response Sample - Failure

Business Rules and Error Messages

General Error Messages

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

  • Authentication credentials were not found; username/password not found, blank or unrecognized.
  • Multiple Accounts found for the same username/password. Unable to determine which one to use. Note: Per validation rules, an account can only be associated with a single Office Location to utilize web services.
  • No username/password match.
  • Office Location cannot be determined; user found not setup correctly, the office location cannot be determined.
  • DATE field in unexpected format. Expects YYYYMMDD; all dates expected in this format unless otherwise noted.

Specific Business Rules and Error Messages

This section details possible error messages for specific methods. Note that these rules are reflective of time of implementation and are subject to change in future.

submitNotice

Individual business rules per field are listed across each of the fields in below table.
Note:

  • Through this service, users can create all the requests and also users can convert between requests. For e.g. Users can create pre-sol or any type and also this can be converted to say ITB anytime.
  • 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
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 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
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 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, “ITB” – for Intend to bundle 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 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)

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
awardee_duns No 9 digits with optional plus 4 NA NA
contact Yes – For presol, submitSourcesSought, combined, ITB, JA, award and submitSaleofSurplus

No – 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 Yes – For presol, submitSourcesSought , combined, ITB, special and surplus

No – 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
links No Array of links NA NA
files No Array of files NA NA
setaside No See SetAside Section for valid values 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 Yes – Only Award type No – For rest 32 characters 1. This required field should be validated for Award type only 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 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
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 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.
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
No if type=Award
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 SetAside section for valid values 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 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
No if type=Award
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 SetAside section for valid values 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 Valid values: “PRESOL” - for Presolicitation, “COMBINE” - for Combined Synopsis/Solicitation, “SRCSGT” - for Sources Sought, “SSALE” - for Sale of Surplus Property, “SNOTE” - for Special Notice 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 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
No if type=Award
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 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 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
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 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 1 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 – Combined 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
contac No – For 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 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
setaside No See SetAside section for valid values 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 – this may change in future 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 Valid values: “PRESOL” - for Presolicitation, “COMBINE” - for Combined Synopsis/Solicitation, “SRCSGT” - for Sources Sought, “SSALE” - for Sale of Surplus Property, “SNOTE” - for Special Notice 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 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
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

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 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
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 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 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 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
email Yes
No if type=Award
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 SetAside section for valid values 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

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: 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)
date No YYYYMMDD Date field should meet the expected format DATE field in unexpected format. Expects YYYYMMDD
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
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 intend to bundle 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 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 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

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 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
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
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 No 128 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 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 No 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)
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
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 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 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”

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)
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 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

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 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)
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 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
archdate No YYYYMMDD 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. $.reason: null found, string expected. Unable to process request. Please try again

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)
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 Valid values: “PRESOL” - for Presolicitation, “COMBINE” - for Combined Synopsis/Solicitation, “SRCSGT” - for Sources Sought, “SSALE” - for Sale of Surplus Property, “SNOTE” - for Special Notice 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
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
1. This required field should be validated 1. Unable to process request. Please try again
desc Yes 65535 characters 1. This required field should be validated 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)
notice_id Yes 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

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)
notice_type No Solicitation type

Valid Values: PRESOL, COMBINE, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB

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
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

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)
file_id Yes Unique ID of a file found from getNoticeData call (i.e. file_id element) This required field should be validated file_id is required
notice_id Yes Unique identifier for a notice This required field should be validated notice_id from getList is required

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)
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 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) 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)
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 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. 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 is inputted and doesn’t match approved, pending, rejected 1. Status value is invalid

approveExplicitAccessRequestByID

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)
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 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. 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

approveExplicitAccessRequestByVendorData

Details will be added in future.

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)
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 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. 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
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

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)
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 Valid values: “PRESOL” - for Presolicitation, “COMBINE” - for Combined Synopsis/Solicitation, “SRCSGT” - for Sources Sought, “SSALE” - for Sale of Surplus Property, “SNOTE” - for Special Notice 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

rejectExplicitAccessRequestByVendorData

Details will be added in future.

setBidModuleOptions

Details will be added in future.

getBidModuleResponses

Details will be added in future.

createSecureDocumentPackage

Details will be added in future.

addFilesToSecureDocumentPackage

Details will be added in future.

deleteFilesFromSecureDocumentPackage

Details will be added in future.

deleteSecureDocumentPackage

Details will be added in future.

releaseSecureDocumentPackage

Details will be added in future.

attachSecureDocumentPackagesToNotice

Details will be added in future.

createNonFBOSolicitation

Details will be added in future.

attachSecureDocumentPackagesToNonFBOSolicitation

Details will be added in future.

removeSecureDocumentPackagesFromNonFBOSolicitation

Details will be added in future.

releaseNonFBOSolicitation

Details will be added in future.

unreleaseNonFBOSolicitation

Details will be added in future.

FAQ

NA

Back to top

Contact Us

Change Log

Date Version Description
5/10/2019 v0.1 Base Version
7/22/2019 v0.2 Workflow Chart Added
8/1/2019 v0.3 Added Future Implementation for IP Address Validation and Type of Connection
8/19/2019 v0.4 SUBMITPRESOL/SOURCESSOUGHT, SUBMITCOMBINED, SUBMITAWARD, SUBMITSALEOFSURPLUS, SUBMITJA, SUBMITITB, SUBMITSPECIANOTICE, SUBMITMOD, ARCHIVENOTICE, UNARCHIVENOTICE, CANCELNOTICE, SUBMITDOCUMENTSANDLINKS, GETLIST, GETNOTICEDATA, GETFILEDATA, DELETENOTICE parameters updated
User Account Section Updated

Back to top