CERS NextGen EDT
Tier 2: Regulator Query Services
The Regulator Query Services are a collection of endpoints UPAs can use to query/download XML-formatted data and JSON-formatted data about CERS Facilities, Facility Submittals (and their associated documents), and inspection/violation/enforcement (CME) data.
2.1 Regulator Facility Submittal Query (RFSQ)
Allows UPAs to query for a set of Facility Submittal Elements based upon one or more query parameters/filters and receive XML-formatted data and JSON-formatted data results. Documents referred to in the results can be retrieved by the document’s cersUniqueKey using the Regulator Facility Submittal Document Query endpoint. NOTE: If your query results result in too large of a return, it will result in an error. In general, CalEPA encourages EDT clients to use thoughtful/narrow queries whenever possible to avoid excessive processing loads on the CERS servers.
Parameters
Parameter Name | Parameter Description | Required |
|---|---|---|
regulatorCode | The CERS Regulator Code of the EDT-authorized UPA. Absent any other parameters, CUPAs will receive CME data for all of their facilities, and PAs will receive data for any facility they currently have a regulator relationship with, i.e., they are the regulator for at least one submittal element of a facility. regulatorCode=2700 | Yes |
Status | Submittal results are filtered to a single submittal element status. Submittal Statuses are: | No |
submittedOnStart | Results are filtered to submittal elements submitted on or after the provided date/time based upon the value of the submittedOn field. The date format is "MM-DD-YYYY". A time is optional--if not provided, it will default to 00:00:00 AM PST. Report time values using 24-hour notation ("military time"). | No |
submittedOnEnd | Results are filtered to submittal elements submitted on or before the provided date/time based upon the value of the SubmittedOn field. The date format is "MM-DD-YYYY". A time is optional--if not provided, it will default to 23:59:59 PM PST. Report time values using 24-hour notation ("military time"). | No |
submittalActionOnStart | Results are filtered to submittal elements acted upon (when Regulator changes the status of a submittal) on or after the provided date/time based upon the value of the submittalActionOn field. The date format is "MM-DD-YYYY". A time is optional--if not provided, it will default to 12:00:00 AM PST. Report time values using 24-hour notation ("military time"). | No |
submittalActionOnEnd | Results are filtered to submittal elements acted upon (when Regulator changes the status of a submittal) on or before the provided date/time based upon the value of the submittalActionOn field. The date format is "MM-DD-YYYY". A time is optional--if not provided, it will default to 11:59:59 PM PST. Report time values using 24-hour notation ("military time"). | No |
submittalElement | Results are filtered to submittal elements for the specified submittal element type(s). Multiple type can be requested as comma-separate list. | No |
UPAs to query for existing CERS Businesses (Organizations) by name, CERS Organization Code, a selected CERS ID that belongs to the Organization, or a Regulator.
2.2 Regulator Business Query (RBQ)
Allows UPA’s to query for existing CERS Businesses (Organizations) by name, CERS Organization Code, a selected CERS ID that belongs to the Organization, or new organization created since a specific date. The query also supports providing a listing of basic information for all of the facilities currently associated with the CERS Organization.
Parameters
Parameter Name | Parameter Description | Required |
|---|---|---|
regulatorCode | The CERS Regulator Code of the EDT-authorized UPA. Absent any other parameters, CUPAs will receive CME data for all of their facilities, and PAs will receive data for any facility they currently have a regulator relationship with, i.e., they are the regulator for at least one submittal element of a facility. regulatorCode=2700 | Yes |
cersId | Results are filtered to a specific CERS facility based upon its CERS ID cersId=10001001 | Yes |
establishedSince | The date the business was created in CERS. | No |
organizationCode | Results are filtered to the CERS Facilities for a specific CERS Business/Organization based upon its Organization Code. | No |
organizationHeadquarters | Additional information (such as corporate office location, etc) to assist in making an Organization or Business name unique. | No |
organizationName | The name of the business or organization that owns/operates a facility. The name is typically the legal or corporate name for the business but may be based on some other convention depending upon the business’ electronic reporting needs. For businesses reporting on only one facility, the business name and facility name are typically the same. | No |
includeFacilities | Results will include facility detail information | No |
Schema specifications
Schema specifications and output samples are available in the latest EDT Documentation release.
2.3 Regulator Facility Submittal Document Query (RFSDQ)
Allows UPAs to download from CERS a specific document based upon the document’s cersUniqueKey acquired from a Regulator Facility Submittal Query.
Parameters
Parameter Name | Parameter Description | Required |
|---|---|---|
regulatorCode | The CERS Regulator Code of the EDT-authorized UPA. Absent any other parameters, CUPAs will receive CME data for all of their facilities, and PAs will receive data for any facility they currently have a regulator relationship with, i.e., they are the regulator for at least one submittal element of a facility. regulatorCode=2700 | Yes |
cersUniqueKey | Identifying Key | Yes |
Schema specifications
Schema specifications and output samples are available in the latest EDT Documentation release.
2.4 Regulator CME Query (RCMEQ)
Allows UPAs to query for a set of CME data based upon one or more query parameters/filters.
Usage
All query parameters should be URL-encoded. Multiple query parameters can be sent in a single request URL. NOTE: If your query results result in too large of a return, it will result in an error. In general, CalEPA encourages EDT clients to use thoughtful/narrow queries whenever possible to avoid excessive processing loads on the CERS servers.
Parameters
Parameter Name | Parameter Description | Required |
|---|---|---|
regulatorCode | The CERS Regulator Code of the EDT-authorized UPA. Absent any other parameters, CUPAs will receive CME data for all of their facilities, and PAs will receive data for any facility they currently have a regulator relationship with, i.e., they are the regulator for at least one submittal element of a facility. regulatorCode=2700 | Yes |
cersId | Results are filtered to a specific CERS facility based upon its CERS ID | No |
endDate | Results are filtered to CME data entities occurring on or before the provided endDate (date format “MM-DD-YYYY”) based upon the value of the entity’s occurredOn field: | No |
startDate | Results are filtered to CME data entities occurring on or after the provided startDate (date format “MM-DD-YYYY”) based upon the value of the entity’s occurredOn field: | No |
status | Results are filtered to CME data entities having a specific status based upon each entity’s CME Data Status. Entities having a “Draft” CME Data Status will not be returned, and entities having a “Deleted” CME Data Status will only be returned if requested using this parameter. Multiple statuses can be requested by providing a comma-delimited list. | No |
Schema specifications
Schema specifications and output samples are available in the latest EDT Documentation release.
2.5 Regulator Facility Query (RFQ)
Allows UPAs to query for existing Facilities in CERS based upon one or more query parameters/filters. Typical usage would be for a CUPA to query for any new Facilities recently created in CERS.
Parameters
Parameter Name | Parameter Description | Required |
|---|---|---|
regulatorCode | The CERS Regulator Code of the EDT-authorized UPA. Absent any other parameters, CUPAs will receive CME data for all of their facilities, and PAs will receive data for any facility they currently have a regulator relationship with, i.e., they are the regulator for at least one submittal element of a facility. regulatorCode=2700 | Yes |
cersId | Results are filtered to a specific CERS facility based upon its CERS ID cersId=10001001 | Yes |
organizationCode | Results are filtered to the CERS Facilities for a specific CERS Business/Organization based upon its Organization Code. | No |
createdOnStart | Results are filtered to CERS Facilities created on or after the provided date/time based upon the date the facility was added to CERS. The date format is “MM-DD-YYYY”. A time is optional–if not provided, it will default to 00:00:00 PM PST. Report time values using 24-hour notation (“military time”). | No |
createdOnEnd | Results are filtered to CERS Facilities created on or before the provided date/time based upon the date the facility was added to CERS. The date format is “MM-DD-YYYY”. A time is optional–if not provided, it will default to 23:59:59 PM PST. Report time values using 24-hour notation (“military time”). createdOnEnd=07-30-2012 createdOnEnd=07-30-2012%2023:59:59 | No |
street | Results are filtered to CERS Facilities matching the accepted or standardized version of the facility street address submitted to the endpoint. street=1000%20main%20Street | No |
city | Results are filtered to CERS Facilities matching the accepted or standardized version of the facility city address submitted to the endpoint. street=1000%20main%20Street&city=San%20Francisco | No |
zip | Results are filtered to CERS Facilities matching the accepted or standardized version of the facility ZIP Code submitted to the endpoint. zip=95812 | No |
Schema specifications
Schema specifications and output samples are available in the latest EDT Documentation release.
2.6 Regulator Facility – Facility RTC Query (RFRQ)
Allows UPAs to query the system for when Facilities submit their RTC documentation via CERS NextGen.
Parameters
The parameters for this endpoint have not yet been identified. Parameters (if needed) will be provided in a future release of this documentation.
Schema specifications
Schema specifications and output samples are available in the latest EDT Documentation release.
2.7 Regulator Facility Profile – UST Operations Query (RFUQ)
Allows UPAs to query the system for Facility Profile – UST Operations information.
Parameters
The parameters for this endpoint have not yet been identified. Parameters (if needed) will be provided in a future release of this documentation.
Schema specifications
Schema specifications and output samples are available in the latest EDT Documentation release.
2.8 Regulator UST Profile – Tank Query (RUPQ)
Allows UPAs to query the system for UST tank profiles.
Parameters
The parameters for this endpoint have not yet been identified. Parameters (if needed) will be provided in a future release of this documentation.
Schema specifications
Schema specifications and output samples are available in the latest EDT Documentation release.
Content from the “Tier 2: Regulator EDT Query Services”
CERSNextGen EDT Services-v1-4
Pages8-14