|
Agency Web Services
The Agency S2S Web Service Library Version 2.0 is described below. Index AssignAgencyTrackingNumberThis service assigns an agency-specific tracking number for a given Grants Gov Tracking Number. 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 was submitted | Required | Must be a valid Grants.gov tracking number for your agency. | GrantsCommonElements | | AgencyTrackingNumber | Agency specific tracking number to assign to specified tracking number | Required | | GrantsCommonElements |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| GrantsGovTrackingNumber | GRANT1234567 | Required | GrantsCommonElements | | ResponseMessage | AssignAgencyTrackingNumberClient successfully completed | Required | GrantsCommonElements |
ConfirmApplicationDeliveryThis service updates the status of a submission to “Received by Agency” for a given Grants Gov Tracking Number. A submission must have a status of “Validated” for this service to be executed. 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 was submitted | Required | Must be a valid Grants.gov Tracking number with “Validated” status for your agency. | GrantsCommonElements |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| GrantsGovTrackingNumber | GRANT1234567 | Required | GrantsCommonElements | | ResponseMessage | Confirmation of 'GRANT10580217': Success | Required | GrantsCommonElements |
CreateAdobeOpportunityThis service creates one or more opportunities from specified XMLs. This web service can also be used for new opportunities even if the opportunity already has package(s). 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 |
|---|
CreateAdobeOpportunityInfo
FundingOppSynopsis_2_0 | This is the V2.0 XML that is sent to Grants.gov to create the opportunity with synopsis, or if opportunity already exists with only package(s) it will create the synopsis. | Required (Multiple Occurrences Allowed) | | GrantsFundingSynopsis-V2.0 |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| Success | True | Required | | CreateAdobeOpportunityResult
FundingOpportunityNumber
ErrorDetails | Includes a funding opportunity number for each submitted opportunity. Error Details is only returned if there is an error. | Required (May have multiple occurrences) | GrantsCommonElements |
DeleteAdobeOpportunityThis service deletes entire opportunity, including Synopsis and any Single-Package and Multi-Package packages defined under this opportunity. 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 |
|---|
| FundingOpportunityNumber | Funding opportunity number you wish to delete | Required | Must be an existing opportunity for your agency | GrantsCommonElements | | UserID | Certificate serial number, also referred to as UserId | Required | | GrantsCommonElements |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| FundingOpportunityNumber | 04052012-AG | Required | GrantsCommonElements | | ResponseMessage | SUCCESS: DeleteAdobeOpportunityClient successfully completed | Required | GrantsCommonElements |
DeleteAdobeSynopsisThis service deletes the synopsis for a given funding opportunity number and user ID. There must be at least 1 Single or Multi-Project package created for this opportunity in order to delete the synopsis. Otherwise, an error message is thrown. For opportunities without packages, use DeleteAdobeOpportunity. 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 |
|---|
| FundingOpportunityNumber | Funding opportunity number for which you wish to delete the synopsis | Required | Must be an existing opportunity for your agency | GrantsCommonElements | | UserID | Certificate serial number, also referred to as UserId | Required | | GrantsCommonElements |
The above table includes the V2.0 parameters. For V0, the input Parameters are: CertificateSerialNumber and OpportunityNumber. Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| FundingOpportunityNumber | 07102012-AG | Required | GrantsCommonElements | | ResponseMessage | SUCCESS: DeleteAdobeSynopsisClient successfully completed | Required | GrantsCommonElements |
GetApplicationThis service returns the submission XML as a string and a collection of attachment objects (if any) for a given Grants Gov Tracking Number. In V2.0, this web service supports large submissions. 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 was submitted | Required | Must be an existing Tracking number for your agency | GrantsCommonElements |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| Submitted Application | Any submission XML | Optional | | | Attachment | Attachments if any | Optional (May have multiple occurrences) | GrantsCommonElements |
GetApplicationListThis service retrieves a list of submissions for the requesting agency 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 |
|---|
| ApplicationFilter | Filter can either be Status, Opportunity ID, CFDA Number, Submission Title, and/or Grants.gov Tracking Number. Multiple filters can be specified. | Optional (Multiple occurrences allowed) | | GrantsCommonElements |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| AvailableApplicationNumber | 91 | Optional | | | ApplicationInfo | | Optional (May have multiple occurrences) | | | FundingOpportunityNumber | 05292012-KJ-FIF | Optional | GrantsCommonElements | | CompetitionID | 06202012-KJ-RR-LATEST | Optional | GrantsCommonElements | | CFDANumber | 00.000 | Optional | GrantsCommonElements | | GrantsGovTrackingNumber | GRANT1234567 | Optional | GrantsCommonElements | | ReceivedDateTime | 2012-06-20T14:07:47.000-04:00 | Optional | | | GrantsGovApplicationStatus | Received | Optional | GrantsCommonElements |
GetApplicationZipThis service returns the submission XML as a string and a collection of attachment objects (if any) for a given Grants Gov Tracking Number. In V2.0, this web service supports large submissions. 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 was submitted | Required | Must be a valid Grants.gov tracking number for your agency. | GrantsCommonElements |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| FileDataHandler | If the web service is executed successfully, a zip file will be streamed to the client. If it fails, generic error handling procedure will take place. | Optional | |
ManagePackageThis web service creates, deletes, and updates Single-Package opportunities. Web Service Version(s)Input ParametersIn V1, the following input parameter(s) were defined in the AgencyManagePackageXML schema: | Input Parameter | Description | Required / Optional | Business Rules | V2.0 Web Service Schema |
|---|
| UserID | User ID of the user who created the opportunity | Required | | GrantsCommonElements | | FundingOpportunityNumber | | Required | Must be an existing opportunity, or newly created if “CreateOpportunityInfo” is specified in XML for your agency | GrantsCommonElements | | CreateOpportunityInfo | Creates Opportunity based on the XML Schema | Optional | See schema documentation for details | AgencyManagePackage | | CreatePackageInfo | Creates Package based on the XML Schema | Optional (Multiple occurrences allowed) | See schema documentation for details | AgencyManagePackage | | UpdatePackageInfo | Update Package based on the XML Schema | Optional (Multiple occurrences allowed) | See schema documentation for details | AgencyManagePackage | | DeletePackageInfo | Delete Package based on the XML Schema | Optional (Multiple occurrences allowed) | See schema documentation for details | AgencyManagePackage |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| UserID | Galexandr | Required | GrantsCommonElements | | FundingOpportunityNumber | 05292012-KJ-FIF | Required | GrantsCommonElements | | Success | True | Required | | | CreatePackageResult | Competition ID: 02032011-AGS2S-01-COMPID-02 /CFDA Number: 00.000) - Success! | Optional (May have multiple occurrences) | AgencyManagePackage | | UpdatePackageResult | | Optional (May have multiple occurrences) | AgencyManagePackage | | DeletePackageResult | | Optional (May have multiple occurrences) | AgencyManagePackage |
SaveAdobeOpportunityThis service creates or updates an opportunity. Web Service Version(s)In V2.0, the functionality of SaveAdobeOpportunity Web service was split into CreateAdobeOpportunity and UpdateAdobeOpportunity. Input ParametersThis service requires the following request parameter(s): | Input Parameter | Description | Required / Optional | Business Rules |
|---|
| OpportunityXML | XML for the Opportunity | Required | Based on DTD |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional |
|---|
| FundingOpportunityNumber | 05292012-KJ-FIF | Optional | | ResponseMessage | SUCCESS | Optional |
UpdateAdobeOpportunityThis service updates one or more existing opportunities for this agency. Web Service Version(s)For V0 and V1, the functionality existed in the SaveAdobeOpportunity web service. Input ParametersThis service requires the following request parameter(s): | Input Parameter | Description | Required / Optional | Business Rules | V2.0 Web Service Schema |
|---|
UpdateAdobeOpportunityInfo
FundingOppSynopsis_2_0 | This is the V2.0.0 XML that is sent to Grants.gov to update the opportunity with synopsis | R (Multiple occurrences allowed) | | GrantsFundingSynopsis-V2.0 |
Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| Success | True | Required | | UpdateAdobeOpportunityResult
FundingOpportunityNumber
ErrorDetails | Includes a funding opportunity number for each submitted opportunity. Error Details is only returned if there is an error. | Required (May have multiple occurrences) | GrantsCommonElements |
UpdateApplicationInfoThis service performs the following actions for a given Grants Gov Tracking number: - Assign agency tracking number
- Save agency notes
To assign the agency tracking number, this web service can replace the AssignAgencyTrackingNumber web service. 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 was submitted | Required | Must be a valid S2S Grants.gov tracking number for your agency. | GrantsCommonElements | | AssignAgencyTrackingNumber | Tracking number the agency will assign for the given Grants.gov Tracking Number | Optional | Agency tracking number can be assigned only once. | AgencyUpdateApplicationInfo | | SaveAgencyNotes | Agency Notes the agency will assign for the given Grants.gov Tracking Number | Optional | Agency notes can be assigned multiple times. | AgencyUpdateApplicationInfo |
Note: This web service assigns the Agency Tracking Number and Notes to the given Grants.Gov Tracking Number. The Agency Tracking Number can be assigned to submissions in “Received by Agency” state only once. The Agency Notes can be updated multiple times, in both the “Received by Agency” and “Agency Tracking Number Assigned” states. Return ValuesThis service returns a collection of objects containing the following details: | Return Value | Comment / Example | Required / Optional | V2.0 Web Service Schema |
|---|
| GrantsGovTrackingNumber | GRANT1234567 | Required | GrantsCommonElements | | Success | True | Required | | | AssignAgencyTrackingNumber | | Optional | AgencyUpdateApplicationInfo | | SaveAgencyNotesResult | | Optional | AgencyUpdateApplicationInfo |
|
RSS