« Documentation
« Web Service Form
« FAQ
« Case Study
« Counselor Tools
GOS Test Results
« WMS Services
« ArcIMS Image Services
« WFS Services
« Z39.50 Services
« WAF Services
GeoSUR Test Results
« WMS Services
« ArcIMS Image Services
« WFS Services
« Z39.50 Services
« WAF Services
Spain IDEC Test Results
« WMS Services
FGDC Registry Test Results
« Z39.50 Services
 
Document Actions

Service Status Checker : Real Time Testing Mode

Requests can be made to the SSC web service and it will perform real time tests on each service and immediately return the results. This document will describe the real time testing mode of the SSC service.


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 service can be tested by the SSC through a real time XML request. All tests are immediately tested with results returned to the requestor.


Real Time Testing Requests

Real time testing requests can be constructed through HTTP GET or POST requests. The following 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?url=<service_url>&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 -
url Define the URL of the service to be tested. This URL will be validated and tested according to the above "type" of service.
  • image: The "url" parameter needs to be provided as the base URL along with the servicename.
    URL Format: <url>?ServiceName=<serviceName> Example URL: http://gis1.oit.ohio.gov?ServiceName=naip_2004
  • waf: The "url" parameter needs to be provided as a Web Accessible Folder (WAF) URL.
  • wfs: The "url" parameter needs to be provided as a getCapabilities or getFeature URL.
  • wms: The "url" parameter needs to be provided as a getCapabilities or getMap URL.
  • z3950: The "url" parameter needs to be provided as the base URL along with the port and database name.
    URL Format: z3950s://<hostName>:<port>/<databaseName>
    Example URL: z3950s://edclxs25.cr.usgs.gov:5210/adds
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



Real Time 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
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 how it was tested to be valid. It has the following attributes:
  • type: Type of URL provided. E.g. WMS requires 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 current 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 current 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 current 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.

expand imageArcIMS Image
expand imageWAF
expand imageWFS
expand imageWMS
expand imageZ39.50

Additional examples along with a sample post request form can be found on the web service form.