Recipient Award Spending Endpoint

recipient_award_spending_endpoint.md

Retrieve awarded amounts for all recipients

Route: /api/v2/award_spending/recipient

Method: GET

This route sends a request to the backend to retrieve awarded amounts for all recipients for a specified awarding agency based on the fiscal year.

Request example

/api/v2/award_spending/recipient?fiscal_year=2017&awarding_agency_id=1

Query Parameters Description

• fiscal_year - required - an integer representing the fiscal year to filter on
• awarding_agency_id - required - an integer representing the toptier agency ID to filter on

Response (JSON)

"results": [
  {
    "recipient": {
      "recipient_id": 123,
      "recipient_name": "The Justice Management Institute"
    },
    "obligated_amount": "-1.52"
  },
  {
    "recipient": {
      "recipient_id": 456,
      "recipient_name": "Cornerstone Assistance Network  Inc."
    },
    "obligated_amount": "0.00"
  }
]

Errors

Possible HTTP Status Codes:

• 400 : Missing parameters
• 500 : All other errors

{
  "message": "Sample error message"
}