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/fboendpoint/services.wsdl or https://api-alpha.sam.gov/prodlike/ws/fboendpoint/fbo.wsdl
  • Beta WSDL Link: https://api.sam.gov/prod/ws/fboendpoint/services.wsdl or https://api.sam.gov/prod/ws/fboendpoint/fbo.wsdl (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

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

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.

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. Use the Set-Aside codes to submit notices.

Refer below table for mapping between legacy Set-Aside Values to modern Set-Aside Value:

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

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.

The Notice Types valid options are:

  • PRESOL – for Presolicitation Notices
  • COMBINE – for Combined/Synopsis Notices
  • AWARD – for Award Notices
  • JA – for Justification & Approval (J&A) Notices
  • SRCSGT – for Sources Sought Notices
  • SSALE – for Sale of Surplus Property Notices
  • SNOTE – for Special Notices
  • ITB – for Intent to Bundle Requirements (DoD-Funded) Notices
  • SOL - for Solicitation Notices

The table below lists notices that can be related.

Below Notice can be Related to: SRCSGT PRESOL COMBINE SOL AWARD SSALE ITB JA SNOTE
SRCSGT   O O O O O     O
PRESOL O   O O   O O O O
COMBINE O O     O   O O O
SOL O O     O   O O O
AWARD     O O     O O O
SSALE O O         O O O
ITB   O O O O O   O O
JA   O O O O O O   O
SNOTE O O O O O O O O  

Stauth Valid Values

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

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

Contracting Officer
Method Details

Award Notice (submitAward)

This method is used to submit an award notice. If there are multiple awards with same Solicitation Number and Award Number, any revisions must be done from REST Services or from User Interface

Input parameters:

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 (Deprecated) YYYYMMDD
zip string No Zip Code (Deprecated) 5 digits
classcod string No Classification Code Valid classification code (FAR, Section 5.207(g))
naics string No NAICS Code Valid NAICS Code
NAICS Reference
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
officeid string Yes Office ID of the office where an opportunity is being submitted 20 characters
subject string Yes Subject 256 characters
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype string No Refer Related Notices  
awdnbr string Yes Award Number 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
awdamt string Yes Award Amount 64 digits
linenbr string No Line Number 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
awddate date Yes Award Date YYYYMMDD
archdate date No Archive Date YYYYMMDD
awardee string No - Either awardee or awardee_duns is required Awardee 1000 characters
awardee_duns string No - Either awardee or awardee_duns is required Awardee DUNS 9 digits with optional plus 4
contact string No Contact Info 500 characters
desc string No Description 65535 characters
link GovURL No Government Link  
email GovEmail No Government Email 255 characters
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Refer Set-Aside Values  
recovery_act boolean No Recovery Act True or False (default=False)
correction boolean No Correction of previous Award True or False
If correcting a previously submitted Award notice, specify True and the system will lookup the award by award number and sol number if applicable.

GovURL Complex Type Definition

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

Delete Notice/ Document Package
(deleteNoticeOrDocumentPackage)

This method is used to permanently delete a notice or delete all attachments/links for all the versions or the latest version 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 Yes - Either Solicitation # or Award # is required only for Award Solicitation # 128 characters from the set: a-z 0-9 -_ ( ) { }
ntype string No; Yes if there are multiple notices with same Solicitation # Refer Notice Types  
awdnbr string Yes - Either Solicitation # or Award # is required ony for Award Award # 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
deletetype string No Notice or Attachment delete operation type Valid Values: “notice” for notice, “attachment” for attachments/links. Defaults to “notice” if not provided
deletemethod string No Delete latest or all versions Valid Values: “latest” for latest version, “all” for all versions. Defaults to “all” if not provided

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 (Deprecated) YYYYMMDD
solnbr string Yes Solicitation # 128 characters from the set: a-z 0-9 -_ ( ) { }
ntype string No Refer Notice Types  
archdate date No Deprecated. Notice will archive immediately YYYYMMDD
officeid string No Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters

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 Notice 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 (Deprecated) YYYYMMDD
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
officeid String No Office ID (Not in Use) 20 characters
subject string No Subject 256 characters
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
ntype string No Refer Notice Types  
awdnbr string No Award # 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
archdate date No Archive Date YYYYMMDD
contact string No Contact Info 500 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 (Deprecated) YYYYMMDD
zip string No Zip Code (Deprecated) 5 digits
classcod string Yes Classification Code Valid classification code (FAR, Section 5.207(g))
naics string No NAICS Code Valid NAICS Code
NAICS Reference
officeid string Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
subject string Yes Subject 256 characters
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate date No - either respdate or archdate is required Response Date YYYYMMDD
archdate date No - either respdate or archdate is required Archive Date YYYYMMDD
contact string Yes Contact Info 500 characters
desc string Yes Description 65535 characters
link GovURL – complex type No Government Link has URL & description  
email GovEmail – complex type Yes Government Email  
links DocumentLink[] No Array of links  
files DocumentFile[] No Array of files  
setaside string No Refer Set-Aside Values  
popaddress string No Place of Performance Address 65535 characters
popzip string No Place of Performance Zip 5 digits
popcountry string No Place of Performance Country 32 characters
recovery_act boolean No Recovery Act True or False (default=False)

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string No Website Address 255 characters
desc string No Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

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 (Deprecated) YYYYMMDD
zip string No Zip Code (Deprecated) 5 digits
classcod string Yes Classification Code Valid classification code (FAR, Section 5.207(g))
naics string Yes NAICS Code Valid NAICS Code
NAICS Reference
officeid string Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
subject string Yes Subject 256 characters
respdate date Yes Response Date YYYYMMDD
archdate date No Archive Date YYYYMMDD
contact string Yes Contact Info 500 characters
desc string Yes Description 65535 characters
link GovURL – complex type No Government Link  
email GovEmail – complex type Yes Government Email  
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Refer Set-Aside Values  
popaddress string No Place of Performance Address 65535 characters
popzip string No Place of Performance Zip 5 digits
popcountry string No Place of Performance Country 32 characters
recovery_act boolean No Recovery Act True or False (default = false)

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

Modification/Amendment
(submitMod)

This method is used to submit a Modification/Amendment to the following notice types: PRESOL, COMBINE, SRCSGT, SSALE, SNOTE, SOL.

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 (Deprecated) YYYYMMDD
zip string No Zip Code (Deprecated) 5 digits
classcod string Yes - for SOL, COMBINE, SSALE, PRESOL Classification Code Valid classification code (FAR, Section 5.207(g))
naics string Yes - for COMBINE, SOL NAICS Code Valid NAICS Code
NAICS Reference
officeid string Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
subject string Yes Subject 256 characters
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype string Yes Notice Type Valid values: PRESOL, COMBINE, SRCSGT, SSALE, SNOTE, SOL
respdate date Yes - for COMBINE, SOL

Either respdate or archdate required for SRCSGT, PRESOL, SNOTE, SSALE
Response Date YYYYMMDD
archdate date No - Either respdate or archdate required for SRCSGT, PRESOL, SNOTE, SSALE Archive Date YYYYMMDD
contact string Yes – for PRESOL, COMBINE, SRCSGT, SSALE, SOL Contact Info 500 characters
desc string Yes - for PRESOL, COMBINE, SRCSGT, SSALE, SOL, SNOTE Description 65535 characters
link GovURL – complex type No Government Link  
email GovEmail – complex type Yes – for PRESOL, COMBINE, SRCSGT, SSALE, SOL Government Email  
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Refer Set-Aside Values  
popaddress string No Place of Performance Address 65535 characters
popzip string No Place of Performance Zip 5 digits
popcountry string No Place of Performance Country 32 characters
recovery_act boolean No Recovery Act True or False (Default = False)

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

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 (Deprecated) YYYYMMDD
zip String No Zip Code (Deprecated) 5 digits
classcod String Yes Classification Code Valid classification code
naics String No NAICS Code Valid NAICS Code
NAICS Reference
offadd String No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
officeid String Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
subject String Yes Subject 256 characters
solnbr String Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype string No Refer Related Notices  
stauth String Yes J&A StatutoryAuthority

Note: Both foja & stauth values will be given under stauth in legacy
Refer Stauth Valid Values
awdnbr String Yes Award Number 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
modnbr String No Mod Number 32 characters
awdamt String No Award Amount (Not in Use) 64 digits
awddate Date No Award Date YYYYMMDD
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 500 characters
desc String No Description 65535 characters
link GovURL No Government Link 255 characters
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
email GovEmail Yes Government Email 255 characters
recovery_act boolean No Recovery Act True or False (Default = False)
correction boolean No Correction of previous J&A True or False
If correcting a previously submitted J&A notice, specify True and the system will lookup the j&a by award number and sol number if applicable.

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

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 (Deprecated) YYYYMMDD
zip string No Zip Code (Deprecated) 5 digits
classcod string No Classification Code Valid classification code (FAR, Section 5.207(g))
naics string No NAICS Code Valid NAICS Code
NAICS Reference
officeid string Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
subject string Yes Subject 256 characters
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate date No - either respdate or archdate is required Response Date YYYYMMDD
archdate date No - either respdate or archdate is required Archive Date YYYYMMDD
contact string Yes Contact Info 500 characters
desc string Yes Description 65535 characters
link GovURL – complex type No Government Link  
email GovEmail – complex type Yes Government Email  
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Refer Set-Aside Values  
popaddress string No Place of Performance Address 65535 characters
popzip string No Place of Performance Zip 5 digits
popcountry string No Place of Performance Country 32 characters
recovery_act boolean No Recovery Act True or False (Default = False_)

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

Foreign Government Standard
(submitForeignGovernment)

This service is deprecated.

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 (Deprecated) YYYYMMDD
zip String No Zip Code (Deprecated) 5 digits
classcod String No Classification Code Valid classification code (FAR, Section 5.207(g))
naics String No NAICS Code Valid NAICS Code
NAICS Reference
officeid String Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd String No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
subject String Yes Subject 256 characters
solnbr String No Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
archdate Date Yes Archive Date YYYYMMDD
contact String No Contact Info 500 characters
desc String Yes Description 65535 characters
link GovURL – complex type No Government Link  
email GovEmail – complex type Yes if contact provided Government Email  
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
recovery_act boolean No Recovery Act True or False (Default = False)

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

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 (Deprecated YYYYMMDD
zip string No Zip Code (Deprecated) 5 digits
classcod string Yes Classification Code Valid classification code (FAR, Section 5.207(g))
naics string No NAICS Code Valid NAICS Code
NAICS Reference
officeid string Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
subject string Yes Subject 256 characters
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
archdate date Yes Archive Date YYYYMMDD
contact string Yes Contact Info 500 characters
desc string Yes Description 65535 characters
link GovURL – complex type No Government Link  
email GovEmail – complex type Yes Government Email  
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
recovery_act boolean No Recovery Act True or False (Default = False)

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

Solicitation
(submitSolicitation)

This method is used to submit a Solicitation Notice.

Input Parameter Type Description
Data Solicitation Complex type defined below

Response:

Output Parameter Type Description
Response PostingResponse Complex type

Solicitation Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
date date No Posting Date (Deprecated) YYYYMMDD
zip string No Zip Code (Deprecated) 5 digits
classcod string Yes Classification Code Valid classification code (FAR, Section 5.207(g))
naics string Yes NAICS Code Valid NAICS Code
NAICS Reference
officeid string Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
subject string Yes Subject 256 characters
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
respdate date Yes Response Date YYYYMMDD
archdate date No Archive Date YYYYMMDD
contact string Yes Contact Info 500 characters
desc string Yes Description 65535 characters
link GovURL – complex type No Government Link  
email GovEmail – complex type Yes Government Email  
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Refer Set-Aside Values  
popaddress string No Place of Performance Address 65535 characters
popzip string No Place of Performance Zip 5 digits
popcountry string No Place of Performance Country 32 characters
recovery_act boolean No Recovery Act True or False (Default = False)

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

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 (Deprecated) YYYYMMDD
zip String No Zip Code (Deprecated) 5 digits
classcod String Yes Classification Code Valid classification code (FAR, Section 5.207(g))
naics String No NAICS Code Valid NAICS Code
NAICS Reference
officeid String Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd String No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
subject String Yes Subject 256 characters
solnbr String Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) {}
ntype String No Refer Related Notices  
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 500 characters
desc String Yes Description 65535 characters
link GovURL No Government Link 255 characters
links DocumentLink[] No Array Of links  
files DocumentFile[] No Array of files  
email GovEmail Yes Government Email 255 characters
recovery_act boolean No Recovery Act True or False (Default = False)
correction boolean No Correction of previous ITB True or False

If correcting a previously submitted ITB notice, specify True and the system will lookup the itb by award number, delivery number and sol number if applicable.

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

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

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 (Deprecated) YYYYMMDD
notice_type string Yes Refer Notice Types  
zip string No Zip Code (Deprecated) 5 digits
classcod string Yes - for SOL, COMBINE, SSALE, ITB, JA, PRESOL Classification Code Valid classification code (FAR, Section 5.207(g))
naics string Yes - for COMBINE, SOL NAICS Code Valid NAICS Code
NAICS Reference
officeid String Yes Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters
offadd string No Office Address (Deprecated). The Contracting office address details are retrieved from the Federal Hierarchy 65535 characters
subject string Yes Subject 256 characters
solnbr string Yes, EXCEPT No - Only for SNOTE Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
ntype string No Refer Related Notices  
awdnbr string Yes - for AWARD, ITB & JA Award # 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
donbr string No Delivery/Task Order Number 255 characters from the set: a-z A-Z 0-9 - _ ( )
awdamt string Yes - for AWARD Award Amount 64 digits
linenbr string No Award Line Item Number 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
awddate date Yes - for AWARD Award Date YYYYMMDD
stauth string Yes - for JA J&A StatutoryAuthority

Note: Both foja & stauth values will be given under stauth in legacy
Refer Stauth Valid Values
respdate date Yes - for COMBINE, SOL

Either respdate or archdate required for SRCSGT, PRESOL, SSALE
Response Date YYYYMMDD
archdate date No; Either respdate or archdate required for SRCSGT, PRESOL, SSALE, SNOTE Archive Date YYYYMMDD
awardee string Yes – for AWARD Awardee 1000 characters
awardee_duns string Yes - for AWARD Awardee DUNS 9 digits with optional plus 4
contact string Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL Contact Info 500 characters
desc string Yes - for PRESOL, COMBINE, SRCSGT, SSALE, ITB, SOL, SNOTE Main Description 65535 characters
link GovernmentURL No Government Link 255 characters
email GovernmentEmail Yes – for PRESOL, COMBINE, SRCSGT, SSALE, JA, ITB, SOL, SNOTE (Required only for SNOTE if contact is provided) Government Email 255 characters
links DocumentLink [] No Array Of links  
files DocumentFile[] No Array of files  
setaside string No Refer Set-Aside Values  
popaddress string No Place of Performance Address 65535 characters
popzip string No Place of Performance Zip 5 digits
popcountry string No Place of Performance Country 32 characters
city string No City NA
state string No State NA
recovery_act boolean No Recovery Act True or False (Default = False)
correction boolean No If correcting a previously submitted notice, specify True and the system will lookup the notice by award number, delivery order number, and sol number if applicable. True or False

GovURL Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes Website Address 255 characters
desc string Yes Description 255 characters

GovEmail Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
address string Yes Email Address 255 characters
desc string No Description 255 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters
Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”.  
export_controlled boolean No Export Controlled. * Captured for future JCP validation.  

Document Packages
(submitDocumentsAndLinksToNotice)

This method is used to attach document packages (non sensitive and sensitive but unclassified) 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 (Deprecated) YYYYMMDD
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 - _ ( ) { }
ntype string No Refer Notice Types  
uploadtype string No Upload Type (Deprecated) 255 characters
respdate date No Response Date YYYYMMDD
links DocumentLin k[] Yes; Either Links or Files needs to be provided Array Of links  
files DocumentFile [] Yes; Either Links or Files needs to be provided Array of files  
officeid string No Office ID of the office where an opportunity is being submitted. Office ID must be associated with user account 20 characters

DocumentLink Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
url string Yes External URL 255 characters
desc string Yes Description/Title 255 characters

DocumentFile Complex Type Definition

Element Name Type Required Description Character Limit / Restrictions
filename string Yes File Name 255 characters
filedata base64binary Yes File Data 250 MB
desc string No Description 65535 characters
explicit_access boolean No Explicit Access. Defaults to ‘false’. For Controlled Unclassified files, specify “true”  
export_controlled boolean No Export Controlled. * Captured for future JCP validation  

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 Refer Notice Types  
awdnbr string No Award # 255 characters from the set: a-z A-Z 0-9 - _ ( ) {}
archdate date Yes New Archive Date YYYYMMDD
officeid String No Office ID (Not in Use)  

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 Character Limit / Restrictions
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype string No Refer Notice Types  

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

Authorized Parties List
(getAuthorizedPartyList)

This method is used to retrieve the Authorized Party lists for an FBO Solicitation. ‘status’ - can be provided to retrieve pending Explicit Access requests, rejected requests, approved vendors, or all. 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 Character Limit / Restrictions
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype string No Refer Notice Types  
nonfbo_solbr string No Non-fbo Solicitation #. Not supported for this method  
status string No Valid Options: approved, pending, rejected, “empty value”. If empty, all status will be returned

Note, use “pending” to pull the pending explicit access requests.
 

AuthorizedPartyListResponse Complex Type Definition:

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 Character Limit / Restrictions
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype string No Refer Notice Types  
nonfbo_solbr string No Non-fbo Solicitation #. Not supported for this method  
id string Yes Matches internal record ID. This is retrieved from getAuthorizedPartyList method above. 32 characters
vendor VendorData No Complex type not used in this method  
reason string No Rejection reason not used in this method 65535 characters

Response:

Output Parameter Type Description
Response PostingResponse Complex type

Approve Explicit Access Requests
(approveExplicitAccessRequestByVendorData)

This method is the same as the “approveExplicitAccessRequestByID” method, but it accepts vendor data in a structured format in order to locate the matching vendor account in the system. This method will only work if there is an exact match based on the vendor data provided, and only if a unique vendor can be determined.

Input Parameters:

Input Parameter Type Description
data ExplicitAccessRequest Complex type defined below

ExplicitAccessRequestComplex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype string No Refer Notice Types  
nonfbo_solbr string No Non-fbo Solicitation #. Not supported for this method  
Id string No Not used in this method 32 characters
vendor VendorData Yes Complex type defined below  
reason string No Rejection reason not used in this method 65535 characters

Response:

Output Parameter Type Description
Response PostingResponse Complex type

VendorData Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
lname string Yes Last Name 255 characters
fname string Yes First Name 255 characters
email string Yes Email 255 characters
contractor_name string Yes Contractor Name 255 characters
duns string Yes DUNS # 9 digits
cage_code string Yes Cage Code 5 alpha/numeric characters

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 Character Limit / Restrictions
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype string No Refer Notice Types  
nonfbo_solbr string No Non-fbo Solicitation #. Not supported for this method  
id string Yes Matches internal record ID. This is retrieved from getAuthorizedPartyList method above. 32 characters
vendor VendorData No Complex type not used in this method  
reason string Yes Rejection Reason 65535 characters

Response:

Output Parameter Type Description
Response PostingResponse Complex type

Reject Explicit Access Requests
(rejectExplicitAccessRequestByVendorData)

This method is the same as the “rejectExplicitAccessRequestByID” method, but it accepts vendor data in a structured format to locate the matching vendor account in the system. This method will only work if there is an exact match based on the vendor data provided and only if a unique vendor can be determined.

Input Parameters:

Input Parameter Type Description
data ExplicitAccessRequest Complex type defined below

ExplicitAccessRequestComplex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype string No Refer Notice Types  
nonfbo_solbr string No Non-fbo Solicitation #. Not supported for this method  
Id string No Not used in this method 32 characters
vendor VendorData Yes Complex type defined below  
reason string Yes Rejection Reason 65535 characters

Response:

Output Parameter Type Description
Response PostingResponse Complex type

VendorData Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
lname string Yes Last Name 255 characters
fname string Yes First Name 255 characters
email string Yes Email 255 characters
contractor_name string Yes Contractor Name 255 characters
duns string Yes DUNS # 9 digits
cage_code string Yes Cage Code 5 alpha/numeric characters

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 Character Limit / Restrictions
solnbr string Yes Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
ntype string No Refer Notice Types  
nonfbo_solbr string No Non-fbo Solicitation #. Not supported for this method.  
Id string No Not used in this method 32 characters
vendor VendorData Yes Complex type defined below  
reason string No Rejection reason not used in this method 65535 characters

Response:

Output Parameter Type Description
Response PostingResponse Complex type

VendorData Complex Type Definition:

Element Name Type Required Description Character Limit / Restrictions
lname string Yes Last Name 255 characters
fname string Yes First Name 255 characters
email string Yes Email 255 characters
contractor_name string Yes Contractor Name 255 characters
duns string Yes DUNS # 9 digits
cage_code string Yes Cage Code 5 alpha/numeric characters

Method Available for Data Export

Get List of Notices
(getList)

This method is used to retrieve list of 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 Character Limit / Restrictions
notice_type string No (at least 1 field is required) Refer Notice Types  
solnbr string No (at least 1 field is required) Solicitation # 128 characters from the set: a-z A-Z 0-9 -_ ( ) { }
awdnbr string No (at least 1 field is required) Award # 255 characters from the set: a-z A-Z 0-9 - _ ( ) { }
posted_from date No (at least 1 field is required) Posted From Date YYYYMMDD
posted_to date No (at least 1 field is required) Posted To Date YYYYMMDD
documents_to_search string No (at least 1 field is required) Notice Status Valid values: ‘active’ or ‘inactive’. 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 file or link 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 Character Limit / Restrictions
notice_id string Yes Unique ID found from getList call or ID’s for changes found in getNoticeData call. 32 characters
get_changes boolean No Pass in true to get the full notice history with all changes True or false
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 YYYYMMDD
get_file_data boolean No 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. True or False

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 Notice ID
notice_type string Notice Type
agency string Top level Agency
office string Office
location string Location
date dateTime Posting Date
zip string Zip Code
classcod string Classification Code
naics string NAICS Code
offadd string Office Address
subject string Subject
solnbr string Solicitation #
awdnbr string Award #
donbr string Delivery/Task Order Number
awdamt string Award Amount
linenbr string Line Item Number
awddate date Award Date
stauth string J&A StatutoryAuthority
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 value
popaddress string Place of Performance Address
popzip string Place of Performance Zip
popcountry string Place of Performance 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: Not in Use

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
filedata base64Binary File data – only used for files stored on notices
link string Link
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 (Not in Use)

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 notice. 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 Character Limit / Restrictions
file_id string Yes Unique ID of a file found from getNoticeData call (i.e. file_id element) 32 characters

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
notice_id string Notice ID
filedata base64Binary File data
link string Link
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 (Not in Use)

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 - Presol Success
Response Sample - Award Success
Response Sample - Failure

getNoticeData

Request Sample
Response Sample – Success
Response sample – error

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

submitSolicitation

Request Sample
Response Sample - Success
Response Sample - Error

archiveNotice

Request Sample
Response Sample – Success
Response Sample – Failure

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

getIVLList

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

approveExplicitAccessRequestbyVendorData

Request Sample
Response Sample - Success
Response Sample - Failure

rejectExplicitAccessRequestbyVendorData

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.

Submit Methods

Individual business rules per field for all submit methods are listed in the table below.
Note:

Element Name Business Rules Error Messages with respect to business rules (If any)
date 1. This field should meet the character limit/restrictions 1. DATE field in unexpected format. Expects YYYYMMDD
notice_type 1. This field is required where applicable 1. Opportunity type is required
solnbr 1. This field is required where applicable

2. If submitting a notice with a duplicate solnbr, then system throws an error

3. If solnbr is in invalid format, then service throws an error

4. If solnbr & ntype combination is not matched, then service throws an error

1. Notice Id is required

2. Notice ID must be unique based on selected notice type.

3. Notice Id can only contain 128 characters from the following set: a-z A-Z 0-9 - _ ( ) { } with no spaces

4. Opportunity not found with given solicitation number and ntype
ntype 1. When user tries to convert a notice and the solicitation number/ntype do not match the notice, then the service throws an error

2. If an invalid ntype is provided, then service throws an error

3. If the solicitation is related to ntype that is not allowed, then the system throws an error
1. Opportunity not found with given solicitation number and ntype

2. Invalid NTYPE value provided

3.The Related Notice’s Type is invalid for this Opportunity
awdnbr 1. This field is required where applicable

2. If value provided does not meet the character limit/restrictions, then service throws an error
1. Contract Award Number is a required field

2.Contract Award Number max length is 255 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
donbr 1. If value provided does not meet the character limit/restrictions, then service throws an error 1. Task/Delivery Order Number max length is 255 characters and allows only alphanumeric and - _ ( ) characters with no spaces
awdamt 1. This field is required where applicable

2. If an invalid integer values= is given, then service throws an error

3. If value provided does not meet the character limit/restrictions, then service throws an error
1. Base and All Options Value is a required field

2. Base and All Options Value - Invalid input: Please enter a valid number

3. Base and All Options Value max length is 64 digits
linenbr 1.If value provided does not meet the character limit/restrictions, then service throws an error 1. The Contract Line Item number max length is 255 characters and allows only alphanumeric and - _ ( ) { } characters with no spaces
awddate 1. This field is required where applicable

2. This field should meet the character limit/restrictions

3. If the Contract Award Date is 15 days prior to the current date and the archive date is not provided then the service throws an error
1. Contract Award Date is required field

2. DATE field in unexpected format. Expects YYYYMMDD

3. Contract Award Date set would result in inactive date being in the past
stauth 1. This field is required where applicable

2. This field accepts only valid values listed. If invalid values are provided, then system throws an error
1. Authority is a required field

2. Invalid Authority Fields, please refer to Contract Opportunities SOAP Web Service Tech Document valid authority fields
respdate 1. This field should meet the character limit/restrictions

2. If the date provided exceeds 5 years from the current date, then the system throws an error

3. Either respdate or archdate required for SRCSGT, PRESOL, SSALE.If none is provided, then the service throws the error
1. DATE field in unexpected format. Expects YYYYMMDD

2. Response Date cannot exceed 5 years from current date

3. One of Response date or Archive date is required
archdate 1. This field should meet the character limit/restrictions

2. This date cannot be in the past

3. Either respdate or archdate required for SRCSGT, PRESOL, SSALE.If none is provided, then the service throws the error
1. DATE field in unexpected format Expects YYYYMMDD

2. Archive date provided is in the past

3. One of Response date or Archive date is required
awardee 1. This field is required where applicable

2. This field should meet the character limit/restrictions
1. Contractor Awarded Name is a required field

2. Contractor Awarded Name max character length is 1000
contact 1. This field is required where applicable

2. This field should meet the character limit/restrictions
1. Primary Contact is Required

2. Primary Contact - Name limit is 500 characters
desc 1. This field is required where applicable. 1. Description is required
link 1. If a link is with same name and url is added to the notice during modification/amendment, then the service throws an error 1. Link with the display text {} already exists
email 1. This field is required where applicable

2. If an invalid email address is provided, then the service throws an error
1. Primary Contact - Email is required

2. Primary Contact - Please enter a valid Internet email address. Format: username@host.domain
links 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error 1. Links and/or files are not complete
files 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error 1. Links and/or files are not complete
setaside 1. If an invalid set aside code is given, then the service throws an error 1. Set Aside provided did not match expected codes
popaddress This is a free Text. No validation is performed on this field NA
popzip   5 digits
popcountry 1. This field is required where applicable 1. Award Details Section - Country is required
city 1. This field is required where applicable 1. Award Details Section - City is required
state 1. This field is required where applicable 1. Award Details Section - State is required
recovery_act NA NA
correction 1. When user tries to convert a notice and the solicitation number/ntype do not match the notice and correction = true, then the service throws an error

2. If correction = True and the system cannot return a single record for the same delivery number/ award number / soliciation number or combination of all three, then the service throws an error

3. If correction = True and the system returns more than one record for the same delivery number/ award number / sol-number or combination of all three, then service throws an error
1. Notice could not be found for correction

2. Multiple Notices found. Please input more details

submitDocumentsAndLinksToNotice

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

  • Note: Users can verify the attachments/links on SAM.gov
  • Note: When none of the fields are given the service throws an error - Links and/or Files are not complete
  • Note: When links/files are given but none of the other fields are given, then service throws an error - Multiple Notices found. Please input more details
Element Name Business Rules Error Messages with respect to business rules (If any)
date 1. Date field should meet the expected format 1. DATE field in unexpected format. Expects YYYYMMDD
officeid 1. If an invalid officeid is given, then service throws an error

2. If contracting officer does not have access to an office but is trying to make a submission to that office, then the service throws an error

3. Office ID must be associated with user account
1. Invalid officeid provided

2. UnAuthorized Credentials. This may be the JWT issue or Role management issue. Please check
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

1. Multiple notices found. Please input more details

2. Notice not found

ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
uploadtype NA NA
respdate 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions 1. DATE field in unexpected format. Expects YYYYMMDD
links 1.This field is not required but if url & description fields within the links and files are empty, then the service throws an error.

2. If a link with same name already exists on the notice, then the system throws an error.

3. If the Url is empty for a link, then the system throws an error.

4. If the description is missing for a link, then the system throws an error.
1. Links and/or files are not complete

2. Resource with the same name already exists

3. Link Resource must have a link

4. Link Resource must have a description
files 1. This field is not required but if url & description fields within the links and files are empty, then the service throws an error

2. If the filename is not provided for a file, then the system throws an error

3. If the filedata is empty for a file, then the system throws an error

4. If the filename provided has either no type specified or is an unsupported type, then the system throws an error

5. If the file size exceeds 250MB, then the system throws an error

6. If a file with same name already exists on the notice, then the system throwns an error
1. Links and/or files are not complete

2. Attachment must have a name

3. Attachment must have content

4. The file type that you are trying to upload is not supported

5. The file size should be greater than zero bytes and less than 250 MB

6. Resource with the same name already exists

deleteNoticeOrDocumentPackage

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

Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

1. Multiple notices found. Please input more details

2. Notice not found

awdnbr If neither solnbr or awdnbr is provided, then the system throws an error Solicitation Number or Award Number is required
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
deletetype 1. If an invalid deletetype is provided, then service throws an error 1.Delete type provided is not “notice” or “attachment”
deletemethod 1. If an invalid deletemethod is provided, then service throws an error 1. Delete method provided is not “latest” or “all”

archiveNotice

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 Business Rules Error Messages with respect to business rules (If any)
date 1. Date field should meet the expected format 1. DATE field in unexpected format. Expects YYYYMMDD
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details
officeid Office ID must be associated with user account NA
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
archdate 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions

1. DATE field in unexpected format. Expects YYYYMMDD

unarchiveNotice

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

  • Note: If a user tries to unarchive a notice that is already unarchived, then the service throws an error - Opportunity is not archived
  • Note: If a user tries to unarchive an active notice, then the service throws an error - Opportunity is active
Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details
officeid Office ID must be associated with user account NA
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
awdnbr NA NA
archdate 1. If this value is available, this field should meet the character limit/restrictions

2. If a past date is provided, then the system throws an error

3. If no archive date is given, then the system throws an error
1. DATE field in unexpected format. Expects YYYYMMDD

2. New archive date provided is in the past

3. New archive date is required

cancelNotice

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 Business Rules Error Messages with respect to business rules (If any)
date 1. Date field should meet the expected format 1. DATE field in unexpected format. Expects YYYYMMDD
officeid Office ID must be associated with user account NA
subject NA NA
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
awdnbr NA NA
archdate 1. No validation is performed on this field. However, if this value is available, this field should meet the character limit/restrictions

2. This date cannot be in past; has to be in future
1. DATE field in unexpected format. Expects YYYYMMDD

2. This opportunity cannot be cancelled
contact NA NA
desc 1. This field is required where applicable 1. This opportunity cannot be cancelled. The cancel request is missing ‘Cancellation description’ field.

getNoticeData

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

Element Name Business Rules Error Messages with respect to business rules (If any)
notice_id 1. notice_id is required 1. notice_id from getList is required
get_changes NA NA
get_changes_from_date 1. Date field should meet the expected format 1. DATE field in unexpected format. Expects YYYYMMDD
get_file_data NA NA

getList

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 Business Rules Error Messages with respect to business rules (If any)
notice_type 1. Valid Notice Type must be provided 1. Notice Type is not recognized. Expects one of the following: PRESOL, COMBINE, MOD, AWARD, JA, SRCSGT, SSALE, SNOTE, ITB, SOL
solnbr NA NA
awdnbr NA NA
posted_from 1. Date field should meet the expected format 1. DATE field in unexpected format. Expects YYYYMMDD
posted_to 1. Date field should meet the expected format 1. DATE field in unexpected format. Expects YYYYMMDD
documents_to_search NA NA

getFileData

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

Element Name Business Rules Error Messages with respect to business rules (If any)
file_id 1. This field is required where applicable

2. If an invalid file Id is provided, then the system throws an error.
1. file_id is required

2. Unable to find details for the resourceId

getIVLList

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

Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details

getAuthorizedPartyList

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

Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
nonfbo_solbr 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error

2. If only nonfbo_solbr is provided, then the service throws an error
1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together

2. addAuthoizedParty service is deprecated for Non-FBO Solicitations
status 1. If the status value entered doesn’t match the valid values , then the system throws an error 1. Status value is invalid

approveExplicitAccessRequestByID

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

  • Note: ID can be obtained through getAuthorizedPartyList
Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
nonfbo_solbr 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error

2. If only nonfbo_solbr is provided, then the service throws an error
1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together

2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
id 1. If the request Id is not provided, then the system throws an error

2. If the request Id provided is already approved, then the service throws an error

3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error

4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error
1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information

2. Request with Request ID: #id already approved

3. You have request that is tied to different solicitation number

4. You have request that is tied to the same solicitation number but different notice type

approveExplicitAccessRequestByVendorData

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

  • Note: Vendor can be obtained through getAuthorizedPartyList
Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
nonfbo_solbr 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error

2. If only nonfbo_solbr is provided, then the service throws an error
1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together

2. approveExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
vendor 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error

2. If no match is found in the system for the vendor data provided, then the system throws an error

3. If the Explicit Access request found for the vendor and solnum is already approved, then the system throws an error
1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown

2. No contact match on vendor data provided

3. Request with Request ID: #id already approved

addAuthorizedParty

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

Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
nonfbo_solbr 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error

2. If only nonfbo_solbr is provided, then the service throws an error
1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together

2. addAuthorizedParty service is deprecated for Non-FBO Solicitations
vendor 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error

2. If no match is found in the system for the vendor data provided, then the system throws an error

3. If the vendor is already added as an authorized party on the notice, then the system throws an error
1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown

2. No contact match on vendor data provided

3. Duplicate request. Vendor is already added as an authorized party on the notice

rejectExplicitAccessRequestByID

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

Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique, then the system throws an error
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
nonfbo_solbr 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error

2. If only nonfbo_solbr is provided, then the service throws an error
1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together

2. rejectExplicitAccessRequestByID service is deprecated for Non-FBO Solicitations
id 1. If the request Id is not provided, then the system throws an error

2. If the request Id provided is already rejected, then the service throws an error

3. If the solicitation number provided does not match the solicitation number of the request Id, then the service throws an error

4. If the solicitation number provided matches with the solicitation number of the request Id but does not match with the provided N type, then the service throws an error
1. Internal ID is required. Use getAuthorizedPartyList to retrieve this information

2. Request with Request ID: #id already rejected

3. You have request that is tied to different solicitation number

4. You have request that is tied to the same solicitation number but different notice type
reason 1. This is a required field. If no value is provided, then the system throws an error 1. A reason must be provided with an explicit access rejection

rejectExplicitAccessRequestByVendorData

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

Element Name Business Rules Error Messages with respect to business rules (If any)
solnbr 1. This field is required where applicable. If no value is provided, then service throws an error

2. If invalid combination of ntype and solnbr is provided, then system throws an error

3. If ntype value is not provided and the solnbr is not unique or if multiple notices are found with same solnbr and ntype, then the system throws an error.
1. Solicitation Number is required

2. Notice not found

3. Multiple notices found. Please input more details.
ntype 1. If an invalid ntype is provided, then service throws an error 1. Invalid NTYPE value provided
nonfbo_solbr 1. If both solnbr and nonfbo_solbr are provided, then the service throws an error

2. If only nonfbo_solbr is provided, then the service throws an error
1. Solicitation Number and Non-FBO Solicitation Number cannot be specified together

2. rejectExplicitAccessRequestByVendorData service is deprecated for Non-FBO Solicitations
vendor 1. If all the elements in the Vendor Data complex definition are not provided, then the system throws an error

2. If no match is found in the system for the vendor data provided, then the system throws an error

3. If the Explicit Access request found for the vendor and solnum is already rejected, then the system throws an error
1. This method requires all fields from complex type VendorData to find a match in the system; if vendor data not fully provided this error will be thrown

2. No contact match on vendor data provided

3. Request with Request ID: #id already rejected
reason 1. This is a required field. If no value is provided, then the system throws an error 1. A reason must be provided with an explicit access rejection

Deprecated Methods

  • submitFairOpps (Instead use submitJA to perform the operation)
  • submitForeignGovernment
  • setBidModuleOptions
  • getBidModuleResponses
  • createSecureDocumentPackage
  • addFilesToSecureDocumentPackage
  • deleteFilesFromSecureDocumentPackage
  • deleteSecureDocumentPackage
  • releaseSecureDocumentPackage
  • attachSecureDocumentPackagesToNotice
  • createNonFBOSolicitation
  • attachSecureDocumentPackagesToNonFBOSolicitation
  • removeSecureDocumentPackagesFromNonFBOSolicitation
  • releaseNonFBOSolicitation
  • unreleaseNonFBOSolicitation
  • attachSecureDocumentPackagesToNotice
  • createNonFBOSolicitation
  • attachSecureDocumentPackagesToNonFBOSolicitation
  • removeSecureDocumentPackagesFromNonFBOSolicitation
  • releaseNonFBOSolicitation
  • unreleaseNonFBOSolicitation
  • createSecureDocumentPackage
  • addFilesToSecureDocumentPackage
  • deleteFilesFromSecureDocumentPackage
  • deleteSecureDocumentPackage

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/01/2019 v0.3 Added IP Address Validation and Type of Connection
8/01/2019 v0.4 Added the details for the Solicitation notice type and business rules for nType
8/19/2019 v0.5 SUBMITPRESOL/SOURCESSOUGHT, SUBMITCOMBINED, SUBMITAWARD, SUBMITSALEOFSURPLUS, SUBMITJA, SUBMITITB, SUBMITSPECIANOTICE, SUBMITMOD, ARCHIVENOTICE, UNARCHIVENOTICE, CANCELNOTICE, SUBMITDOCUMENTSANDLINKS, GETLIST, GETNOTICEDATA, GETFILEDATA, DELETENOTICE parameters updated
User Account Section Updated
9/25/2019 v0.6 Updated required fields for DocumentLink, DocumentFile, ArchiveNotice, UnArchiveNotice, CancelNotice and DeleteNoticeOrDocumentPackage ComplexType definitions
10/10/2019 v0.7 Updated the Set-Aside values with the latest codes
10/28/2019 v0.8 Documentation updates only. No change to Implementation
- Production WSDL link added
- Redundant Character Limit and Required columns removed from Specific Business Rules and Error Messages section
- Notice Types and Related Notices sections added for reference
- Consolidated and summarized list of deprecated methods
- Far13 added to Stauth Valid Values section
- Updated character limits
- Updated required column for submitAward, archiveNotice, submitPresol, submitCombined, submitMod, submitJA, submitSourcesSought, submitSpecialNotice, submitSaleofSurplus, submitITB, submitNotice, submitdocumentsandlinkstonotice
- Remove foja from getnoticedata response
11/04/2019 v0.9 Updated the character limits for contact and awardee fields for all the submit methods. Modified “donbr” as a not required field for Justification notice submission
11/12/2019 v1.0 Initial Release Finalized

Back to top