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:
Index AuthenticateAORThis 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)Input ParametersThis service requires the following request parameter(s): Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema |
---|
AORUserID | User ID of AOR user is being authenticated | Required | Must be a valid AOR User ID | | AORPassword | Password of AOR user is being authenticated | Required | Must be a valid AOR password | |
Return ValuesThis service returns the following values. Some values may be empty: Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema |
---|
Token | Token used to send Application through SubmitApplicationAsThirdPartyClient web service | Required | GrantsCommonElements | SecurityMessage | Security message is blank | Optional | GrantsCommonElements |
GetApplicationInfoThis service retrieves the following application information for a given Grants Gov Tracking Number: - Status detail
- Agency notes
Web Service Version(s)Input ParametersThis service requires the following request parameter(s): Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema |
---|
GrantsGovTrackingNumber | Tracking number assigned by Grants.gov when application is submitted | Required | Must be a valid Grants.gov tracking number submitted by this certificate | GrantsCommonElements |
Return ValuesThis service returns the following values. Some values may be empty: Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema |
---|
GrantsGovTrackingNumber | GRANT10580188 | Required | GrantsCommonElements | StatusDetail | Agency Tracking Number Assigned | Required | GrantsCommonElements | AgencyNotes | You forgot to add a document. Please include XYZ document and resubmit | Optional | GrantsCommonElements |
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)
Input Parameters
This service requires the following request parameter(s):
Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema | GrantsGovTrackingNumber | Tracking number assigned by Grants.gov when application is submitted | Required | Must be a valid Grants.gov tracking number submitted by this certificate | GrantsCommonElements |
Return Values
This service returns the following values. Some values may be empty:
Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema | GrantsGovTrackingNumber | GRANT10580188 | Required | GrantsCommonElements | StatusDetail | Agency Tracking Number Assigned | Required | GrantsCommonElements | AgencyNotes | You forgot to add a document. Please include XYZ document and resubmit | Optional | GrantsCommonElements | AgencyTrackingNumber | AA#1234 | Optional | GrantsCommonElements | GetApplicationListThis service returns application information objects specific to the submitted certificate and for a given criteria (application search filter). Web Service Version(s)Input ParametersThis service contains the following parameter(s): Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema |
---|
ApplicationFilter | Filter can be: Status, Opportunity ID, CFDA Number, Submission Title, and/or Grants.gov Tracking Number. Multiple filters may be specified. | Optional (Multiple Occurrences Allowed) | | GrantsCommonElements |
Return ValuesThis service returns the following values: Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema |
---|
AvailableApplicationNumber | the number of applications returned /91 | | | ApplicationInfo | | Optional (May have multiple occurrences) | | CFDANumber | 00.000 | Optional | GrantsCommonElements | FundingOpportunityNumber | 03272012-KJ-SP-MP | Optional | GrantsCommonElements | CompetitionID | 03272012-KJ-SP-MP | Optional | GrantsCommonElements | GrantsGovTrackingNumber | GRANT10578935 | Optional | GrantsCommonElements | ReceivedDateTime | 2012-06-08T10:13:49.000-04:00 | Optional | | GrantsGovApplicationStatus | | Optional | GrantsCommonElements | StatusDateTime | 2012-06-08T12:31:06.000-04:00 | Optional | | AgencyTrackingNumber | | Optional | GrantsCommonElements | SubmissionTitle | | Optional | GrantsCommonElements |
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)
Input Parameters
This service contains the following parameter(s):
Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema | ApplicationFilter | Filter can be: Status, Opportunity ID, CFDA Number, Submission Title, and/or Grants.gov Tracking Number. Multiple filters may be specified. | Optional (Multiple Occurrences Allowed) | | GrantsCommonElements |
Return Values
This service returns the following values:
Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema | AvailableApplicationNumber | the number of applications returned /91 | | | ApplicationInfo | | Optional (May have multiple occurrences) | | CFDANumber | 00.000 | Optional | GrantsCommonElements | FundingOpportunityNumber | 03272012-KJ-SP-MP | Optional | GrantsCommonElements | CompetitionID | 03272012-KJ-SP-MP | Optional | GrantsCommonElements | GrantsGovTrackingNumber | GRANT10578935 | Optional | GrantsCommonElements | ReceivedDateTime | 2012-06-08T10:13:49.000-04:00 | Optional | | GrantsGovApplicationStatus | | Optional | GrantsCommonElements | StatusDateTime | 2012-06-08T12:31:06.000-04:00 | Optional | | AgencyTrackingNumber | | Optional | GrantsCommonElements | SubmissionTitle | | Optional | GrantsCommonElements |
GetApplicationStatusDetailThis service retrieves the application status details for a given Grants Gov Tracking Number. Web Service Version(s)Input ParametersThis service requires the following parameter(s): Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema |
---|
GrantsGovTrackingNumber | Tracking number assigned by Grants.gov when application is submitted | Required | Must be a valid GrantsGovTrackingNumber submitted by this certificate | GrantsCommonElements |
Return ValuesThis service requires the following request parameter(s): Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema |
---|
GrantsGovTrackingNumber | Received By Agency or Tracking Number Assigned | Required | GrantsCommonElements | DetailedStatus | Detail status of the Application | Required | |
GetOpportunitiesThis service returns a collection of objects for all open opportunities. It allows applicant to filter the request using Input Parameters. Web Service Version(s)The GetOpportunities web service combined the functionality of GetOpportunityList and GetOpportunitiesWithInfo web services included in V0 and V1. GetOpportunities returns the IsMultiProject flag. Input ParametersThis service requires at least one of the following input parameters. If you specify Competition ID, must include CFDA Number, Opportunity ID or both. Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema |
---|
FundingOpportunityNumber | Opportunity Number | Optional | Must be a valid FundingOpportunityNumber | GrantsCommonElements | CFDANumber | CFDA Number | Optional | Must be a valid CFDANumber for your agency | GrantsCommonElements | CompetitionID | Competition Number | Optional | Must be a valid CompetitionID | GrantsCommonElements |
Return ValuesThis service returns the following values. Some values may be empty: Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema |
---|
OpportunityInfo | | Optional (May have multiple occurrences) | | FundingOpportunityNumber | 04252012-NF1 | Required | GrantsCommonElements | CFDANumber | 10.001 | Optional | GrantsCommonElements | CompetitionID | 04252012-NF-MP1 | Optional | GrantsCommonElements | OpeningDate | MM/DD/YYYY | Optional | | ClosingDate | MM/DD/YYYY | Required | | FundingOpportunityTitle | RG-07252011-Opp36-Title-Mod-Email! | Optional | GrantsCommonElements | OfferingAgency | NIH | Optional | GrantsCommonElements | AgencyContactInfo | Agency Contact Number | Optional | GrantsCommonElements | CFDADescription | Agricultural Research_Basic and Applied Research | Optional | GrantsCommonElements | SchemaURL | http://at07apply.grants.gov/apply/opportunities/schemas/applicant/opp04252012-NF1-CFDANumber10.001-cid04252012-NF-MP1.xsd | Optional | GrantsCommonElements | InstructionsURL | http://at07apply.grants.gov/apply/opportunities/instructions/opp04252012-NF1-CFDANumber10.001-cid04252012-NF-MP1-instructions.doc | Optional | GrantsCommonElements | IsMultiProject | True | Optional | |
GetOpportunitiesWithInfoThis 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)For V2.0, this functionality is included in Get Opportunities Input ParametersThis service requires at least one of the following input parameters. If you specify Competition ID, must include CFDA Number, Opportunity ID or both. Input Parameter | Description | Required/Optional | Business Rules |
---|
CFDANumber | CFDA Number | Optional | | OpportunityID | Opportunity Number | Optional | | CompetitionID | Competition ID | Optional | |
Return ValuesThis service returns the following values. Some values may be empty: Return Value | Comment / Example | Required/Optional |
---|
OpportunityID | 04252012-NF1 | Optional | OpportunityTitle | RG-07252011-Opp36-Title-Mod-Email! | Optional | OpeningDate | MM/DD/YYYY | Optional | ClosingDate | MM/DD/YYYY | Optional | CFDANumber | 10.001 | Optional | CompetitionID | 04252012-NF-MP1 | Optional | SchemaURL | http://at07apply.grants.gov/apply/opportunities/schemas/applicant/opp04252012-NF1-CFDANumber10.001-cid04252012-NF-MP1.xsd | Optional | InstructionURL | https://at07apply.grants.gov:446.grants.gov/apply/opportunities/instructions/opp04252012-NF1-CFDANumber10.001-cid04252012-NF-MP1-instructions.doc | Optional | CDFADescription | Agricultural Research_Basic and Applied Research | Optional | OfferingAgency | NIH | Optional | AgencyContact | Agency Contact Information (Number, email, etc) | Optional |
GetOpportunityListThis 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)For V2.0, this functionality is included in Get Opportunities Input ParametersThis service requires at least one of the following input parameters. If you specify Competition ID, must include CFDA Number, Opportunity ID or both. Input Parameter | Description | Required/Optional | Business Rules |
---|
CFDANumber | CFDA Number | Optional | | OpportunityID | Opportunity Number | Optional | | CompetitionID | Competition Number | Optional | |
Return ValuesThis service requires the following request parameter(s), some return values may be empty: Return Value | Comment / Example | Required/Optional |
---|
OpportunityID | 01242012-KV-4 | Optional | OpportunityTitle | 01242012-KV-4 | Optional | OpeningDate | | Optional | ClosingDate | 01/24/2014 | Optional | CFDANumber | | Optional | CompetitionID | ID: 1 | Optional | SchemaURL | https://ws07.grants.gov:446.gov/apply/opportunities/schemas/applicant/opp01242012-KV-4-cid1.xsd | Optional | InstructionURL | URL: https://ws07.grants.gov:446 /apply/opportunities/instructions/opp01242012-KV-4-cid1-instructions.doc | Optional |
SubmitApplicationThis 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 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 ParametersThis service requires one the following parameter(s): Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema |
---|
GrantApplicationXML | The XML must be prepared for submission to Grants.gov | Required | Uses the Opportunity schema URL retrieved from GetOpportunititesWIthInfo and Get OpportunityList | | Attachment | Submission attachments | Optional (May have multiple occurrences) | See GrantsCommonElements, Schema documentation | GrantsCommonElements |
Return ValuesThis service returns the following: Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema |
---|
GrantsGovTrackingNumber | GG Tracking Number: GRANT10580201 | Required | GrantsCommonElements | ReceivedDateTime | Received Date/Time: 2012-07-23 10:58:03 | Required | |
SubmitApplicationAsThirdPartyThis 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)Input ParametersThis service requires the following request parameter(s): Input Parameter | Description | Required/Optional | Business Rules | V2.0 Web Service Schema |
---|
Token | Token returned from AuthenticateAOR web service method. | Required | | GrantsCommonElements | GrantApplicationXML | The XML that needs to be prepared for submission to Grants.gov | Required | | | Attachment | Submission attachments | Optional (Multiple Occurrences Allowed) | | GrantsCommonElements |
Return ValuesThis service returns the following: Return Value | Comment / Example | Required/Optional | V2.0 Web Service Schema |
---|
GrantsGovTrackingNumber | GG Tracking Number: GRANT10580201 | Required | GrantsCommonElements | ReceivedDateTime | Received Date/Time: 2012-07-23 10:58:03 | Required | |
|