Applicant Web Services

The Applicant S2S Web Service Library Version 2.0 is described below with business rules required by Grants.gov validation. For Agency specific instructions and validations, please refer to the Agency’s grant website. For any form specific instructions and validations, please see the Data Analysis Templates (DATs) in the Forms Repository:

• Training Environment: http://at07web.grants.gov/agencies/aforms_repository_information.jsp
• Production Environment: http://www07.grants.gov/agencies/aforms_repository_information.jsp

Index

 AuthenticateAOR

This service authenticates an Authorized Organization Representative (AOR) and returns a token object used to send Application through SubmitApplicationAsThirdParty web service. If the Applicant has the Authorized Applicant role, then the web service returns an AOR Status of Authorized. Otherwise, it returns an AOR status of Unauthorized. For more information on ThirdPartySubmissions please contact the PMO.

Web Service Version(s)

• V1
• V2.0

Input Parameters

This service requires the following request parameter(s):

Return Values

This service returns the following values. Some values may be empty:

GetApplicationInfo

This service retrieves the following application information for a given Grants Gov Tracking Number:

• Status detail
• Agency notes

Web Service Version(s)

• V1
• V2.0

Input Parameters

This service requires the following request parameter(s):

Return Values

This service returns the following values. Some values may be empty:

GetApplicationInfoAsThirdParty

The GetApplicationInfoAsThirdParty web service is similar to the ApplicantWebServices-V2.0 GetApplicationInfo web service.  GetApplicationListAsThirdParty returns information for the requested application if the third party certificate matches the submitter.  This web service also returns an additional parameter when available, Agency Tracking Number. 

This service retrieves the following application information for the requested Grants.Gov Tracking Number:

• Status Detail
• Agency Notes
• Agency Tracking Number

Web Service Version(s)

• V2.0

Input Parameters

This service requires the following request parameter(s):

Return Values

This service returns the following values. Some values may be empty:

GetApplicationList

This service returns application information objects specific to the submitted certificate and for a given criteria (application search filter).

Web Service Version(s)

• V0
• V1
• V2.0

Input Parameters

This service contains the following parameter(s):

Return Values

This service returns the following values:

GetApplicationListAsThirdParty

The GetApplicationListAsThirdParty web service is similar to the ApplicantWebService-V2.0 GetApplicationList web service.  GetApplicationListAsThirdParty returns the list of submitted applications submitted by the third party certificate regardless of the submitted application’s AOR.  The returned list is filtered based on the application search criteria provided in the input parameter.

Web Service Version(s)

• V2.0

Input Parameters

This service contains the following parameter(s):

Return Values

This service returns the following values:

 GetApplicationStatusDetail

This service retrieves the application status details for a given Grants Gov Tracking Number.

Web Service Version(s)

• V0
• V1
• V2.0

Input Parameters

This service requires the following parameter(s):

Return Values

This service requires the following request parameter(s):

 GetOpportunities

This service returns a collection of objects for all open opportunities. It allows applicant to filter the request using Input Parameters.

Web Service Version(s)

• V1
• V2.0

The GetOpportunities web service combined the functionality of GetOpportunityList and GetOpportunitiesWithInfo web services included in V0 and V1. GetOpportunities returns the IsMultiProject flag.

Input Parameters

This service requires at least one of the following input parameters. If you specify Competition ID, must include CFDA Number, Opportunity ID or both.

Return Values

This service returns the following values. Some values may be empty:

 GetOpportunitiesWithInfo

This service returns a collection of objects for all open opportunities. It allows the applicant to filter the request using Input Parameters.

Web Service Version(s)

• V0
• V1

For V2.0, this functionality is included in Get Opportunities

Input Parameters

This service requires at least one of the following input parameters. If you specify Competition ID, must include CFDA Number, Opportunity ID or both.

Return Values

This service returns the following values. Some values may be empty:

 GetOpportunityList

This service returns a collection of objects for an open opportunity, containing funding opportunity information. It allows applicant to filter the request using Input Parameters.

Web Service Version(s)

• V0
• V1

For V2.0, this functionality is included in Get Opportunities

Input Parameters

This service requires at least one of the following input parameters. If you specify Competition ID, must include CFDA Number, Opportunity ID or both.

Return Values

This service requires the following request parameter(s), some return values may be empty:

 SubmitApplication

This service allows an applicant client to submit a single-project or multi-project submission. The attachments are sent as binary streams. Streaming is only available in V2.0.

Web Service Version(s)

• V0
• V1
• V2.0

V0 allowed only Single-Project submissions. V1 allowed Single-Project and Multi-Project submissions. In V2.0, the web service supports large submissions for Single-Project and Multi-Project.

Input Parameters

This service requires one the following parameter(s):

Return Values

This service returns the following:

 SubmitApplicationAsThirdParty

This service allows an applicant client to submit a single-project or multi-project submission on behalf of another applicant. Certificates should have a special role called Third Party Submitter role that will be designated by PMO. This service must be used in conjunction with AuthenticateAOR. The token received from AuthenticateAOR is sent as one of the request parameters for this service. For more information on ThirdPartySubmissions please contact the PMO.

Web Service Version(s)

• V1
• V2.0

Input Parameters

This service requires the following request parameter(s):

Return Values

This service returns the following: