Service Status Checker : Archive Testing Mode
Catalogs can provide their service lists to the SSC system and have it perform daily batch testing of all services. These results are saved in a database for quick retrieval and usage.
Note: The U.S. Geospatial One-Stop (GOS) portal currently implements this method for providing a score for its search results.
Request URL
The SSC web service is a HTTP based service. The web service is located at the following location:
http://registry.fgdc.gov/statuschecker/services/rest/index.php?
Figure 1. Any catalog can provide its list of services to SSC on daily basis in an ATOM feed.
The SSC runs in batch mode to test all services and save the results.
Figure 2. Clients can query the archived test results and incorporate them into their own applications.
Archive Testing Requests
Archive testing requests can be constructed through HTTP GET or POST requests. The below parameters are used to
construct testing requests to the SSC web service.
HTTP GET:
Requests through HTTP GET can be easily constructed through URLs that can work in your browser, through the command line or within your code. All GET requests start with the hostname and base path of the SSC service followed by a question mark. The remainder of the URL is followed by the actual request parameters which take the form of argument=value syntax and are separated by the ampersand (&).
http://registry.fgdc.gov/statuschecker/services/rest/index.php?id=<service_id>&type=<service_type>&formattype=<format>&requesttype=<request_type>
HTTP POST:
Requests through an XML POST method can be used to construct the SSC web service request. Using the POST method allows multiple requests to be sent at one time rather than making individual GET requests for each service. The tags are repeated for each service to be tested.
The same request parameters that are used in the HTTP GET are required in the POST XML request but they must be provided through an XML document. The schema document for this service request is located at: http:/registry.fgdc.gov/statuschecker/services/rest/requestSchema.xsd
| REQUEST PARAMETER |
DESCRIPTION |
REQUIRED |
DEFAULT VALUE |
| type |
Define the type of service to be tested. This parameter will designate what validation and specific tests are performed.
The following types are currently available:
- image: Will test the service as an ESRI ArcIMS Service.
- waf: Will test the service as an Web Accessible Folder (WAF).
- wfs: Will test the service as an OGC Web Feature Service (WFS).
- wms: Will test the service as an OGC Web Map Service (WMS).
- z3950: Will test the service as an Z39.50 Service.
|
Required |
- |
|---|
| id |
Provide the registered ID that uniquely identifies the service tested. This id, together with the "type" provided above, will be used to query the DB for archived results. |
Required |
- |
|---|
| requesttype |
Define if a full or brief report is returned.
- full: Returns all summary and specific test information.
- brief: Returns only the summary information.
|
Optional |
full |
|---|
| formattype |
Define the output format of the web service response.
- xml: XML is returned
- html: HTML is returned after the XML is styled through an XSL transformation
|
Optional |
xml |
|---|
| startdate |
Defines the start date for the range of test results requested.
- Date Format : 0000-00-00
NB: If startdate is not provided, the most current test date is used.
|
Optional |
Latest Test Date |
|---|
| enddate |
Defines the end date for the range of test results requested.
- Date Format : 0000-00-00
- General: End date can't be an ealier date than start date.
NB: If enddate is not provided, the most current test date is used.
|
Optional |
Latest Test Date |
|---|
Archive Testing Response Fields
The SSC web service returns an XML document describing the validation, scores and test results performed by the SSC system.
The schema document for this service response is located at:
http://registry.fgdc.gov/statuschecker/services/rest/responseSchema.xsd
The following information is returned from the SSC web service:
| RESPONSE FIELD |
DESCRIPTION |
|---|
| response |
Contains one or many service elements. |
|---|
| service |
Contains all the service testing results from the SSC web service for that specific service. It has the following attributes:
- type: Type of service tested
- date: Date and time that the tests were performed
- id: Provided id that uniquely identifies the service tested
|
|---|
| summary |
Contains a summary of the service tested, the validation of the service URL and the scoring results.
|
|---|
| providedURL |
Contains information about the provided service URL and attributes that determine its validity. It has the following attributes:
- type: Type of URL provided. E.g. a valid WMS is either a getMap or getCapabilities URL and ArcIMS requires the hostname+serviceName
- validity: Results on a validation test of the service URL. [ 1=Successful validation test / 0=Invalid validation test ]
|
|---|
| scoredTest |
Contains the scoring or health information of the service. It has the following attributes:
- type: Type of service test that will be used to generate a score for the overall service.
|
|---|
| performance |
Contains the scores or health information of the service. These scores are based upon the specific test indicated above
in the scoreTest value. It has the following attributes:
- currentSpeed: Time in seconds between 0-45 Seconds that the service was able to respond to the testing request.
[ -99.99 Service was not able to be tested ]
- currentScore: Service is provided a score between 0-100 based upon the ability to return results along with the
speed of the service. [ -99.99= Service was not able to be tested and scored ]
|
|---|
| test |
Contains the individual test results for each test performed on this service. Contains the following attributes:
- type: Defines the test that was performed. For example, a WMS services can contain the following test
results depending on which tests were performed: httpServer, getCapabilities, generatedGetCapabilties, getMap, generatedGetMap.
- startTime: Time the test was started
- endTime: Time the test ended
|
|---|
| input |
Contains information related to the inputs that were provided to the testing process. Some of the most common inputs include:
- URL: Defines the provided URL that was used to perform the test
|
|---|
| output |
Contains information related to the outputs or results returned from the testing process. Some of the most common outputs include:
- success: Reports the result of the test. [ 1= success / 0= failure / -99.99=not tested ]
- error: Reports any errors returned by the current test
|
|---|
Sample Service Requests and Responses
Select one of the below service types to view service specific requests and responses.
ArcIMS Image
Post Request
XML Request:
| <request xmlns="http://registry.gsdi.org/statuschecker/services/rest/"> |
| <formattype>xml</formattype> |
| <requesttype>full</requesttype> |
| <service> |
| <id>{69F22F34-A972-8639-AED9-71A87534DDFE}</id> |
| <type>image</type> |
| </service> |
| </request> |
Get Request
XML Response
| <?xml version="1.0"?> |
| <response xmlns="http://registry.gsdi.org/statuschecker/services/rest/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://registry.gsdi.org/statuschecker/services/rest/responseSchema.xsd"> |
| <service type="image" date="2009-11-12 11:36:38" id="{69F22F34-A972-8639-AED9-71A87534DDFE}" > |
| <summary> |
| <providedURL type="ArcIMSImage" validity="1">http://gis1.oit.ohio.gov?ServiceName=naip_2006</providedURL> |
| <scoredTest type="getImage"> |
| <performance type="currentSpeed">0.195937156677</performance> |
| <performance type="currentScore">99.85</performance> |
| </scoredTest> |
| </summary> |
| <test type="httpServer"> |
| <input type="URL">gis1.oit.ohio.gov</input> |
| <output type="success">1</output> |
| </test> |
| <test type="getServiceInfo"> |
| <input type="URL">http://gis1.oit.ohio.gov/servlet/com.esri.esrimap.Esrimap?ServiceName=naip_2006</input> |
| <output type="success">1</output>
|
| </test> |
| <test type="getImage"> |
| <input type="URL">http://gis1.oit.ohio.gov/output/naip_2006_gisprodapp01777643243.jpg</input> |
| <input type="extent">minx=260301 miny=4270327 maxx=305803 maxy=4333777</input> |
| <output type="success">1</output> |
| </test> |
| </service> |
| </response> |
WAF
Post Request
XML Request:
| <request xmlns="http://registry.gsdi.org/statuschecker/services/rest/"> |
| <formattype>xml</formattype> |
| <requesttype>full</requesttype> |
| <service> |
| <id>{9C6D37F7-52FF-4072-9FFC-4A46EE6491E0}</id> |
| <type>waf</type> |
| </service> |
| </request> |
Get Request
XML Response
| <?xml version="1.0"?> |
| <response xmlns="http://registry.gsdi.org/statuschecker/services/rest/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://registry.gsdi.org/statuschecker/services/rest/responseSchema.xsd"> |
| <service type="waf" date="2010-01-14 9:00:31" id="{9C6D37F7-52FF-4072-9FFC-4A46EE6491E0}"> |
| <summary> |
| <providedURL type="waf" validity="1">http://www.geosur.info/WAF</providedURL> |
| <scoredTest type="validateWAFContents"> |
| <performance type="currentSpeed">0.013031</performance> |
| <performance type="currentScore">99.99</performance> |
| </scoredTest> |
| </summary> |
| <test type="httpServer"> |
| <input type="URL">http://www.geosur.info</input> |
| <output type="success">1</output> |
| </test> |
| <test type="validateWAFPath"> |
| <input type="URL">http://www.geosur.info/WAF/</input> |
| <output type="success">1</output> |
| </test> |
| <test type="validateWAFContents"> |
| <input type="URL">http://www.geosur.info/WAF/aeropuertos_mtdspa.xml</input> |
| <output type="success">1</output> |
| </test> |
| </service> |
| </response> |
WFS
Post Request
XML Request:
| <request xmlns="http://registry.gsdi.org/statuschecker/services/rest/"> |
| <formattype>xml</formattype> |
| <requesttype>full</requesttype> |
| <service> |
| <id>{3FBFA110-DFC0-9794-E4AD-B4A0771FC14C}</id> |
| <type>wfs</type> |
| </service> |
| </request> |
Get Request
XML Response
| <?xml version="1.0"?> |
| <response xmlns="http://registry.gsdi.org/statuschecker/services/rest/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://registry.gsdi.org/statuschecker/services/rest/responseSchema.xsd"> |
| <service type="wfs" date="2009-11-12 11:36:38" id="{3FBFA110-DFC0-9794-E4AD-B4A0771FC14C}" > |
| <summary> |
| <providedURL type="getCapabilities" validity="1">http://geodata.epa.gov/wfsconnector/com.esri.wfs.Esrimap/EPA_ER_Quads?request=getcapabilities&service=wfs</providedURL> |
| <scoredTest type="getFeature"> |
| <performance type="currentSpeed">0.195937156677</performance> |
| <performance type="currentScore">99.85</performance> |
| </scoredTest> |
| </summary> |
| <test type="httpServer"> |
| <input type="URL">http://geodata.epa.gov</input> |
| <output type="success">1</output> |
| </test> |
| <test type="getCapabilities"> |
| <input type="URL">http://geodata.epa.gov/wfsconnector/com.esri.wfs.Esrimap/EPA_ER_Quads?request=getcapabilities&service=wfs</input> |
| <output type="success">1</output> |
| </test> |
| <test type="getFeature"> |
| <input type="URL">http://geodata.epa.gov:80/wfsconnector/com.esri.wfs.Esrimap/EPA_ER_QUADS?Request=GetFeature&Service=WFS&Version=1.1.0&MaxFeatures=5&Typename=EPA_6K_QUADS-6k</input> |
| <output type="success">1</output> |
| </test> |
| </service> |
| </response> |
WMS
Post Request
XML Request:
| <request xmlns="http://registry.gsdi.org/statuschecker/services/rest/"> |
| <formattype>xml</formattype> |
| <requesttype>full</requesttype> |
| <service> |
| <id>{5EBBB4F3-AE88-D40E-1700-00C3D5EC26A4}</id> |
| <type>wms</type> |
| </service> |
| </request> |
Get Request
XML Response
| <?xml version="1.0"?> |
| <response xmlns="http://registry.gsdi.org/statuschecker/services/rest/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://registry.gsdi.org/statuschecker/services/rest/responseSchema.xsd"> |
| <service type="wms" date="2009-11-12 11:36:38" id="{5EBBB4F3-AE88-D40E-1700-00C3D5EC26A4}" > |
| <summary> |
| <providedURL type="getCapabilities" validity="1">http://map.ngdc.noaa.gov/wmsconnector/com.esri.wms.Esrimap/nos_hydro?request=getcapabilities&Service=wms&version=1.1.1</providedURL> |
| <scoredTest type="getMap"> |
| <performance type="currentSpeed">0.195937156677</performance> |
| <performance type="currentScore">99.85</performance> |
| </scoredTest> |
| </summary> |
| <test type="httpServer"> |
| <input type="URL">http://map.ngdc.noaa.gov</input> |
| <output type="success">1</output> |
| </test> |
| <test type="getCapabilities"> |
| <input type="URL">http://map.ngdc.noaa.gov/wmsconnector/com.esri.wms.Esrimap/nos_hydro?request=getcapabilities&Service=wms&version=1.1.1</input> |
| <output type="success">1</output> |
| </test> |
| <test type="getMap"> |
| <input type="URL">http://map.ngdc.noaa.gov:80/wmsconnector/com.esri.wms.Esrimap/nos_hydro?VERSION=1.1.1&REQUEST=GetMap&LAYERS=35&SRS=EPSG:4326&BBOX=-180,-89.899243489,180,89.8992434051&WIDTH=250&HEIGHT=250&FORMAT=image/png&STYLES=&</input> |
| <output type="success">1</output> |
| </test> |
| </service> |
| </response> |
Z39.50
Post Request
XML Request:
| <request xmlns="http://registry.gsdi.org/statuschecker/services/rest/"> |
| <formattype>xml</formattype> |
| <requesttype>full</requesttype> |
| <service> |
| <id>1</id> |
| <type>z3950</type> |
| </service> |
| </request> |
Get Request
XML Response
| <?xml version="1.0"?> |
| <response xmlns="http://registry.gsdi.org/statuschecker/services/rest/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://registry.gsdi.org/statuschecker/services/rest/responseSchema.xsd"> |
| <service type="z3950" date="2009-11-12 11:36:38" id="1" > |
| <summary> |
| <providedURL type="z3950" validity="1">z3950s://edclxs25.cr.usgs.gov:5210/adds</providedURL> |
| <scoredTest type="searchSpatial"> |
| <performance type="currentSpeed">0.195937156677</performance> |
| <performance type="currentScore">99.85</performance> |
| </scoredTest> |
| </summary> |
| <test type="testZ3950Server"> |
| <input type="URL">z3950s://edclxs25.cr.usgs.gov:5210/adds</input> |
| <output type="success">1</output> |
| </test> |
| <test type="searchText"> |
| <input type="URL">edclxs25.cr.usgs.gov:5210/adds</input> |
| <input type="query">CGADMN1</input> |
| <output type="success">1</output> |
| <output type="recordsReturned">1</output> |
| </test> |
| <test type="searchSpatial"> |
| <input type="URL">edclxs25.cr.usgs.gov:5210/adds</input> |
| <input type="coordinates">90 -180 -90 180</input> |
| <output type="success">1</output> |
| <output type="recordsReturned">135</output> |
| </test> |
| </service> |
| </response> |
Additional examples along with a sample post request form can be found on the web service form.
