v1

latestSwagger 2.0This page was built with the Swagger API.2026-07-142241153.1 KB
Case Enforcement

Enforcement Case Paginated Results Service

GET_QID is passed with a query ID corresponding to a previously run get_cases query. It then returns a CASES object containing all matching cases. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.

get/case_rest_services.get_qid

Query parameters

output'JSONP' | 'JSON' | 'XML'

Output Format Flag. Enter one of the following keywords:

  • JSON = Data model formatted as Javascript Object Notation (default).
  • JSONP = Data model formatted as Javascript Object Notation with Padding.
  • XML = Data model formatted as Extensible Markup Language.
qidstring required

Query ID Selector. Enter the QueryID number from a previously run query.

pagenonumber

Indicates the number of the page to display. It is used only when the results are paginated.

callbackstring

JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.

newsortnumber

Output Sort Column. Enter the number of the column on which the data will be sorted. If unpopulated results will sort on the first column.

descending'Y' | 'N'

Output Sort Column Descending Flag. Enter Y to column identified in the newsort parameter descending. Enter N to use ascending sort order. Used only when newsort parameter is populated.

qcolumnsstring

Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions.

Response

Results are an array (page) of Cases from ICIS with the number of cases equal to the responseset (page size).

Example response

{
  "Results": {
    "Cases": [
      {
        "ActivityId": "???",
        "CaaFlag": "1",
        "CaseCategoryCode": "AIF",
        "CaseCategoryDesc": "Administrative - Informal",
        "CaseName": "Baltes Real Estate Company",
        "CaseNumber": "05-200021274",
        "CaseStatusCode": "ACH",
        "CaseStatusDesc": "Achieved",
        "CerclaFlag": "1",
        "CivilCriminalIndicator": "CI",
        "CostRecovery": "0",
        "CwaFlag": "1",
        "DOJDocketNmbr": "Achieved",
        "DateClosed": "07/21/2011",
        "DateFiled": "01/19/2005",
        "DateLodged": "04/28/2009",
        "EnfOutcome": "Final Order With Penalty",
        "EpcraFlag": "1",
        "FedPenalty": "$3,000.00",
        "FederalFlag": "1",
        "FifraFlag": "1",
        "Lead": "EPA",
        "MaxScore": "1",
        "PrimaryLaw": "TSCA",
        "PrimaryNAICSCode": "237310",
        "PrimarySICCode": "1220",
        "PrimarySection": "409",
        "RcraFlag": "1",
        "SEPCategories": "0",
        "SEPCost": "$4,100.00",
        "SEPTexts": "0",
        "SdwaFlag": "1",
        "SettlementCnt": "1",
        "SettlementDate": "05/5/2005",
        "TotalCompActionAmt": "279450"
      }
    ],
    "Message": "Success",
    "PageNo": "1",
    "QueryID": "245",
    "QueryRows": "5"
  }
}