8.4 Summary API

Use the Summary API to view the rate execution history for a specified number of prior requests.

• Method – GET
• URL - /ftpwebservices/v1/fetch-rates-hist?requestCount=<count>

Request Headers Details

The following lists the Request Headers:

• ofs_workspace_id - Workspace ID of the Application. The default value is WS001 and same should be passed each time.
• ofs_tenant_id - Tenant ID of the Application.
• ofs_service_id - Service ID of the Application.
• ofs_remote_user - User ID of the user.
• Authorization: Bearer <token> - Access token required to authenticate the API. For more information about the Bearer token, refer to Ways to Generate Access Token

Attributes

• requestCount - (Optional) Number of prior requests to return. Defaults to 10 if not passed. Maximum supported value is 40; if a higher value is passed, only the last 40 requests are returned.

Sample Response Body

Success:

{
    "severity": "info",
    "summary": "Rates history fetched successfully",
    "data": {
        "totalNoOfRequests": 2,
        "details": [
            {
                "requestId": 156,
                "request": [ { "...": "account request fields" } ],
                "response": [
                    {
                        "AS_OF_DATE": "2015-03-31",
                        "REQUEST_ID": "156",
                        "ACCOUNT_NUMBER": "RTTP_156_1",
                        "TRANSFER_RATE": "8.668865"
                    }
                ]
            }
        ]
    },
    "details": "Rates history fetched successfully",
    "status": "Success",
    "statusCode": "0"
}

Ongoing:

{
    "severity": "info",
    "summary": "FTP Engine Execution is Ongoing with Request Id: 94",
    "requestId": "94",
    "details": "FTP Engine Execution Ongoing",
    "status": "Ongoing",
    "statusCode": "2"
}

No Data:

{
    "severity": "info",
    "summary": "No data to fetch",
    "details": "",
    "status": "Success",
    "statusCode": "0"
}

Note:

If requestCount exceeds 40, only the last 40 requests are returned, with "details": "API retrieve only last 40 requests" in the response.