Regulator Facility Submittal Service Methods
Regulator Facility Submittal Query
Description:Allows UPAs to query for a set of Facility Submittal Elements based upon one or more query parameters/filters and receive results as XML format formatted using RegulatorFacilitySubmittalQuery.xsd. Avoid queries returning large counts of submittal elements by narrowing date ranges or other use of other filters. Documents referred to in the results can be retrieved by the document's CERSUniqueKey using the Regulator Facility Submittal Document Query endpoint.
Comments: XML output is formatted using RegulatorFacilitySubmittalExport.xsd. All query parameters should be URL-encoded. Multiple query parameters can be sent in a single request URL. If you send a query with a very large set of results, you may receive an HTTP 413 error (Request Entity Too Large) until Cal/EPA can implement deferred query processing via the Regulator Facility Submittal Query Transaction Query endpoint. In general Cal/EPA encourages EDT clients to use thoughtful/narrow queries whenever possible to avoid excessive processing loads on the CERS servers.
URL Template: https://cersservices.calepa.ca.gov/Staging/Regulator/FacilitySubmittal/Query?regulatorCode={regulatorCode}&[query parameters]
|
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.
|
|
submittedOnStart |
Returns are filtered to submittal elements submitted on or after the provided date/time based upon the value of the SubmittedOn field (CDR System field #20.0010). 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").
|
|
submittedOnEnd |
Results are filtered to submittal elements submitted on or before the provided date/time based upon the value of the SubmittedOn field (CDR System Field #20.0006). 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").
|
|
submittalActionOnStart |
Returns 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 (CDR System field #20.0006). 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").
|
|
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 (CDR System Field #20.0010). 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").
|
|
submittalElement |
Results are filtered to submittal elements for the specified submittal element type(s) (CDR System Field Submittal Element Code, #20.0071). Multiple type can be requested as comma-separate list.
|
|
cersid |
Results are filtered to submittal elements for for a specific facility based upon its 8-digit CERS ID (CDR System Field #1a)
|
|
status |
Submittal results are filtered to a single submittal element type (CDR System Field
Submittal Action (Submittal Status), #20.0005). "Draft" submittal elements
will not be returned.
|
Request: https://cersservices.calepa.ca.gov/Staging/Regulator/FacilitySubmittal/Query?regulatorCode={regulatorCode}&start=07-29-2012&end=07-30-2012
Response: RegulatorFacilitySubmittalQuery.xsd
Regulator Facility Submittal Document Query
Description: Allows UPAs to download a specific document in a CERS facility submittal based upon the document's CERSUniqueKey acquired from a Regulator Facility Submittal Query.
Comments: This service allows UPAs to download
any supplemental documents referenced in the results XML they received from the
Regulator Facility Submittal Query endpoint. Querying for a non-existent
CERSUniqueKey will result in a 404 error.
CERSUniqueKey is a CERS-assigned UUID for various entities in CERS, including document
uploads. See the sample XML below.
URL Template: https://cersservices.calepa.ca.gov/Staging/Regulator/FacilitySubmittal/Query/Document/{CERSUniqueKey}
Sample Request: https://cersservices.calepa.ca.gov/Staging/Regulator/FacilitySubmittal/Query/Document/2d1bb3d3-28ca-4807-864e-7cc43052105f
Response: A document file
Cal/EPA Unified Program: CERS Technology Services
CERS Central EDT Home Page: http://cers.calepa.ca.gov/EDT/