Skip to content

Commit

Permalink
Update fsrs-bulkupload-api.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ritchasharmagsa authored Jan 15, 2024
1 parent 0034234 commit add670b
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions _apidocs/fsrs-bulkupload-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The following section describes each of the above endpoints in detail.

Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | header | string | Yes | Valid and authorized user ID
Authorization | header | string | Yes | Valid and authorized SAM user email ID
api_key | query | string | Yes | Valid System Account API Key
Request JSON | Body | JSON | Yes | [Refer Submit SubAward Report Contract JSON](#submit-subaward-report-contract-json)

Expand All @@ -147,7 +147,7 @@ HTTP Status Code | Response Type | Reason | Description
-----------------|---------------|---------|------------
201 | string | Report was created | As described below

The API will return HTTP Status code 201 if the report is saved successfully. If the request passes all validations, then the report is saved in Submitted status. If any validations fail, then the report is saved in "Work In Progress" status and the validation error messages are sent back as a part of the response body. see [s](#validation-failure-error-messages) for more information about validation errors. Users are expected to fix the validation errors and send an Update SubAward Report (Contracts) request to update the report so it can be submitted successfully.
The API will return HTTP Status code 201 if the report is saved. If the request passes all validations, then the report is saved in Submitted status. If any validations fail, then the report is saved in "Work In Progress" status and the validation error messages are sent back as a part of the response body. See [Validation Failure Error Messages](#validation-failure-error-messages) for more information about validation errors. Users are expected to fix the validation errors and send an Update SubAward Report (Contracts) request to update the report so it can be submitted successfully.

The API will return other HTTP Status codes in case of any other errors and the report will not be saved. Refer to the [General Error Messages](#general-error-messages) for specific details.

Expand Down Expand Up @@ -430,7 +430,7 @@ The API will return other HTTP Status codes in case of any other errors and the

Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | Header | string | Yes | Valid and authorized user ID
Authorization | Header | string | Yes | Valid and authorized SAM user email ID
api_key | query | string | Yes | Valid System Account API Key
Request JSON | Body | JSON | Yes | [Refer Submit SubAward Report Grant JSON](#submit-subaward-report-grant-json)

Expand All @@ -442,7 +442,7 @@ HTTP Status Code | Response Type | Reason | Description
-----------------|---------------|---------|------------
201 | string | Report was successfully created | As described below

The API will return HTTP Status code 201 if the report is saved successfully. If the request passes all validations, then the report is saved in Submitted status. If any validations fail, then the report is saved in "Work In Progress" status and the validation error messages are sent back as a part of the response body. see [s](#validation-failure-error-messages) for more information about validation errors. Users are expected to fix the validation errors and send an Update SubAward Report (Grants) request to update the report so it can be submitted successfully.
The API will return HTTP Status code 201 if the report is saved. If the request passes all validations, then the report is saved in Submitted status. If any validations fail, then the report is saved in "Work In Progress" status and the validation error messages are sent back as a part of the response body. see [Validation Failure Error Messages](#validation-failure-error-messages) for more information about validation errors. Users are expected to fix the validation errors and send an Update SubAward Report (Grants) request to update the report so it can be submitted successfully.

The API will return other HTTP Status codes in case of any other errors and the report will not be saved. Refer to the [General Error Messages](#general-error-messages) for specific details.

Expand Down Expand Up @@ -665,7 +665,7 @@ The API will return other HTTP Status codes in case of any other errors and the
"subAssistanceDollars": "150000",
"subAssistanceObligationOrActionDate": "2023-04-17",
"overallDescription": "My Description",
"placeOfPerformance": {
"placeOfPerformance": {
"streetAddress": "Test place",
"streetAddress2": "",
"city": "Atlanta",
Expand Down Expand Up @@ -746,7 +746,7 @@ The API will return other HTTP Status codes in case of any other errors and the

Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | header | string | Yes | Valid and authorized user ID
Authorization | header | string | Yes | Valid and authorized SAM user email ID
api_key | query | string | Yes | Valid System Account API Key
Request JSON | Body | JSON | Yes | [Refer Submit SubAward Report Contract JSON](#submit-subaward-report-contract-json)

Expand All @@ -758,7 +758,7 @@ HTTP Status Code | Response Type | Reason | Description
-----------------|---------------|---------|------------
200 | string | Report successfully updated| As described below

The API will return HTTP Status code 200 if the report is updated successfully. If the request passes all validations, then the report is updated to Submitted status. If any validations fail, then the report stays in "Work In Progress" status and the validation error messages are sent back as a part of the response body. see [s](#validation-failure-error-messages) for more information about validation errors. Users are expected to fix the validation errors and send the update request again to update the report so it can be submitted successfully.
The API will return HTTP Status code 200 if the report is updated successfully. If the request passes all validations, then the report is updated to Submitted status. If any validations fail, then the report stays in "Work In Progress" status and the validation error messages are sent back as a part of the response body. See [Validation Failure Error Messages](#validation-failure-error-messages) for more information about validation errors. Users are expected to fix the validation errors and send the update request again to update the report so it can be submitted successfully.

The API will return other HTTP Status codes in case of any other errors and the report will not be updated. Refer to the [General Error Messages](#general-error-messages) for specific details.

Expand All @@ -782,7 +782,7 @@ For examples, refer to Submit SubAward Report (Contracts) examples.

Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | Header | string | Yes | Valid and authorized user ID
Authorization | Header | string | Yes | Valid and authorized SAM user email ID
api_key | query | string | Yes | Valid System Account API Key
Request JSON | Body | JSON | Yes | [Refer Submit SubAward Report Grant JSON](#submit-subaward-report-grant-json)

Expand All @@ -794,7 +794,7 @@ HTTP Status Code | Response Type | Reason | Description
-----------------|---------------|---------|------------
200 | string | Report successfully updated | As described below

The API will return HTTP Status code 200 if the report is updated successfully. If the request passes all validations, then the report is updated to Submitted status. If any validations fail, then the report stays in "Work In Progress" status and the validation error messages are sent back as a part of the response body. see [s](#validation-failure-error-messages) for more information about validation errors. Users are expected to fix the validation errors and send the update request again to update the report so it can be submitted successfully.
The API will return HTTP Status code 200 if the report is updated successfully. If the request passes all validations, then the report is updated to Submitted status. If any validations fail, then the report stays in "Work In Progress" status and the validation error messages are sent back as a part of the response body. See [Validation Failure Error Messages](#validation-failure-error-messages) for more information about validation errors. Users are expected to fix the validation errors and send the update request again to update the report so it can be submitted successfully.

The API will return other HTTP Status codes in case of any other errors and the report will not be updated. Refer to the [General Error Messages](#general-error-messages) for specific details.

Expand All @@ -818,7 +818,7 @@ For examples, refer to Submit SubAward Report (Grants) examples.

Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | Header | string | Yes | Valid and authorized user ID
Authorization | Header | string | Yes | Valid and authorized SAM user email ID
api_key | query | string | Yes | Valid System Account API Key
Request JSON | Body | JSON | Yes |[Refer Delete SubAward Report Contract JSON](#delete-subaward-report-contract-json)

Expand Down Expand Up @@ -877,7 +877,7 @@ The API will return HTTP Status code 204 if the report is deleted successfully.

Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | Header | string | Yes | Valid and authorized user ID
Authorization | Header | string | Yes | Valid and authorized SAM user email ID
api_key | query | string | Yes | Valid System Account API Key
Request JSON | Body | JSON | Yes | [Refer Delete SubAward Report Grant JSON ](#delete-subaward-report-grant-json)

Expand Down Expand Up @@ -931,7 +931,7 @@ The API will return HTTP Status code 204 if the report is deleted successfully.

Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | Header | string | Yes | Valid and authorized user ID
Authorization | Header | string | Yes | Valid and authorized SAM user email ID
api_key | query | string | Yes | Valid System Account API Key
Request JSON | Body | JSON | Yes, at least one primeEntityInformation element is required. From the fields, at least one field is required | [Refer Get SubAward Report Contract JSON](#get-subaward-report-contract-json)

Expand Down Expand Up @@ -1155,7 +1155,7 @@ HTTP Status Code | Response Type | Reason | Description

Parameter Name | Parameter Type | Data Type | Required | Description
---------------|----------------|------------|----------|------------
Authorization | Header | string | Yes | Valid and authorized user ID
Authorization | Header | string | Yes | Valid and authorized SAM user email ID
api_key | query | string | Yes | Valid System Account API Key
Request JSON| Body| JSON| Yes, at least one primeEntityInformation element is required. From the fields, at least one field is required| [Refer Get SubAward Report Grant JSON](#get-subaward-report-grant-json)

Expand Down

0 comments on commit add670b

Please sign in to comment.