WMTS Response Codes

The OnEarth module is implemented to analyze request URLs to provide detailed error information if a valid tile cannot be returned. Exceptions are returned in the following format:

 <?xml version="1.0" encoding="UTF-8"?>
 <ExceptionReport xmlns="http://www.opengis.net/ows/1.1"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                  xsi:schemaLocation="http://schemas.opengis.net/ows/1.1.0/owsExceptionReport.xsd" 
                  version="1.1.0" xml:lang="en">
    <Exception exceptionCode="MissingParameterValue" locator="FORMAT">
        <ExceptionText>Missing FORMAT parameter</exceptiontext>
    </exception>
    <Exception exceptionCode="InvalidParameterValue" locator="TILEROW">
        <ExceptionText>TILEROW is not a valid integer</exceptiontext>
    </exception>
    <Exception exceptionCode="InvalidParameterValue" locator="TILECOL">
        <ExceptionText>TILECOL is not a valid integer</exceptiontext>
    </exception>
 </exceptionreport>

Note that he response may contain multiple exceptions. However, the HTTP status code for the first exception will be returned. The following table outlines the success and failure cases handled by the WMTS OnEarth module.

Note: Differences between OnEarth v2 and OnEarth v1 are highlighted in bold.

OnEarth v2

Action	Result	Exception code value	Code	Locator value	Exception text
Server error	Exception	NoApplicableCode	500		Internal server error
Malformed REST URL	Exception	Varies based on malformation	Varies based on malformation (400, 404)		Varies based on malformation
Missing required parameter (SERVICE, REQUEST, VERSION, LAYER, FORMAT, TILEMATRIXSET, TILEMATRIX, TILEROW, TILECOL)	Exception	MissingParameterValue	400	Name of missing parameter	Missing [*] parameter
Invalid SERVICE value	Exception	InvalidParameterValue	400	SERVICE	Unrecognized service
Invalid REQUEST value	Exception	OperationNotSupported	501	REQUEST	The request type is not supported
Invalid VERSION value	Exception	InvalidParameterValue	400	VERSION	VERSION is invalid
Invalid LAYER value	Exception	InvalidParameterValue	400	LAYER	LAYER does not exist
Invalid parameter value (STYLE, FORMAT, TILEMATRIXSET)	Exception	InvalidParameterValue	400	Name of parameter with invalid value	[STYLE/FORMAT/TILEMATRIXSET] is invalid for LAYER
Invalid (non-positive integer) parameter value (TILEMATRIX, TILEROW, TILECOL)	Exception	InvalidParameterValue	400	Name of parameter with invalid value	[TILEMATRIX/TILEROW/TILECOL] is not a valid integer.
Invalid TILEMATRIX value	Exception	TileOutOfRange	400	TILEMATRIX	TILEMATRIX is out of range, maximum value is []
Tile out of range (TILEROW, TILECOL)	Exception	TileOutOfRange	400	TILEROW or TILECOL	[TILEROW/TILECOL] is out of range, maximum value is []
Invalid TIME format	Exception	InvalidParameterValue	400	TIME	Invalid time format (must be YYYY-MM-DD)
Time out of range (before start time or after end time)	Exception		404		Not Found
Valid layer, missing tile	Blank tile		200
Unknown parameter	Tile		200
Valid request	Tile		200

OnEarth v1

Action	Result	Exception code value	Code	Locator value	Exception text
Server error	Exception	NoApplicableCode	500		Internal server error
Malformed REST URL	Exception	FileNotFound	404		File not found
Missing required parameter (SERVICE, REQUEST, VERSION, LAYER, FORMAT, TILEMATRIXSET, TILEMATRIX, TILEROW, TILECOL)	Exception	MissingParameterValue	400	Name of missing parameter	Missing [*] parameter
Invalid SERVICE value	Exception	InvalidParameterValue	400	SERVICE	Unrecognized service
Invalid REQUEST value	Exception	OperationNotSupported	501	REQUEST	The request type is not supported
Invalid VERSION value	Exception	InvalidParameterValue	400	VERSION	VERSION is invalid
Invalid LAYER value	Exception	InvalidParameterValue	400	LAYER	LAYER does not exist
Invalid parameter value (STYLE, FORMAT, TILEMATRIXSET)	Exception	InvalidParameterValue	400	Name of parameter with invalid value	[STYLE/FORMAT/TILEMATRIXSET] is invalid for LAYER
Invalid (non-positive integer) parameter value (TILEMATRIX, TILEROW, TILECOL)	Exception	InvalidParameterValue	400	Name of parameter with invalid value	[TILEMATRIX/TILEROW/TILECOL] is not a valid integer.
Invalid TILEMATRIX value	Exception	InvalidParameterValue	400	TILEMATRIX	Invalid TILEMATRIX
Tile out of range (TILEROW, TILECOL)	Exception	TileOutOfRange	400	TILEROW or TILECOL	[TILEROW/TILECOL] is out of range, maximum value is []
Invalid TIME format	Exception	InvalidParameterValue	400	TIME	Invalid time format (must be YYYY-MM-DD)
Time out of range (before start time or after end time)	Blank Tile		200
Valid layer, missing tile	Blank tile		200
Unknown parameter	Tile		200
Valid request	Tile		200