GET data/HHMDataPackage/GetDataPackage/{scope}/{coverage}/{timeSpan}/{year}/{sd}/{ed}?division={division}&region={region}&district={district}&mailcode={mailcode}

Request Information

URI Parameters

Name	Type	Additional information
division	string	Required
region	string	Required
district	string	Required
mailcode	string	Required
year	integer	Required
scope	string	None.
coverage	string	None.
timeSpan	string	None.
sd	string	None.
ed	string	None.

Body Parameters

None.

Response Information

Resource Description

HHMDataPackage

Name	Type	Additional information
SpendFacts	Collection of HHMSpendFact	None.
StreamFacts	Collection of HHMStreamFact	None.
RecentIncidents	Collection of HHMRecentIncidents	None.
RecentERs	Collection of HHMRecentERs	None.
NextPickup	Collection of HHMNextPickup	None.

Response Formats

application/json, text/json

Sample:

{
  "SpendFacts": [
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "FiscalYear": 6,
      "Spend": 7.1,
      "Plan": 8.1,
      "LytdSpend": 9.1,
      "TotCount": 10.1
    },
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "FiscalYear": 6,
      "Spend": 7.1,
      "Plan": 8.1,
      "LytdSpend": 9.1,
      "TotCount": 10.1
    }
  ],
  "StreamFacts": [
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "FiscalYear": 6,
      "Stream": "sample string 7",
      "TotCost": 8.1,
      "TotCount": 9.1
    },
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "FiscalYear": 6,
      "Stream": "sample string 7",
      "TotCost": 8.1,
      "TotCount": 9.1
    }
  ],
  "RecentIncidents": [
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "IncidentDate": "2025-05-02T22:36:10.3495956-04:00",
      "Category": "sample string 7",
      "Status": "sample string 8",
      "Type": "sample string 9",
      "Nature": "sample string 10",
      "NumViolations": 11,
      "Agency": "sample string 12"
    },
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "IncidentDate": "2025-05-02T22:36:10.3495956-04:00",
      "Category": "sample string 7",
      "Status": "sample string 8",
      "Type": "sample string 9",
      "Nature": "sample string 10",
      "NumViolations": 11,
      "Agency": "sample string 12"
    }
  ],
  "RecentERs": [
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "DateServiced": "2025-05-02T22:36:10.3495956-04:00",
      "ScheduleType": "sample string 7",
      "ServiceType": "sample string 8",
      "TotCost": 9.1
    },
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "DateServiced": "2025-05-02T22:36:10.3495956-04:00",
      "ScheduleType": "sample string 7",
      "ServiceType": "sample string 8",
      "TotCost": 9.1
    }
  ],
  "NextPickup": [
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "TargetDate": "2025-05-02T22:36:10.3495956-04:00"
    },
    {
      "Division": "sample string 1",
      "Region": "sample string 2",
      "District": "sample string 3",
      "MailCode": "sample string 4",
      "FacilityID": 5,
      "TargetDate": "2025-05-02T22:36:10.3495956-04:00"
    }
  ]
}