Changes

Page history
Create home authored by Chad Leong's avatar Chad Leong
Show whitespace changes
Inline Side-by-side
home.md 0 → 100644
View page @ 3d2357d1
# CRS Catalog Service
## Table of Contents <a name="TOC"></a>
- [Introduction](#introduction)
- [Fundamental Concepts](#fundamental-concepts)
- [Service Authentication](#service-authentication)
- [Main Use Cases](#main-use-cases)
* [CRS Search](#crs-search)
* [Get all CRSs](#get-all-crss)
* [Entire Catalog Request](#entire-catalog-request)
- [API Versions](#api_versions)
- [CRS Catalog API Overview](#preferred-api-v2)
* [Search keywords for Coordinate Reference Systems (CRS)](#crs-search-keywords-v2)
* [Search keywords for Cartographic Transformations (CT)](#ct-search-keywords-v2)
* [Search keywords for Area of Use](#area-search-keywords)
- [API Data Structures](#response-data-structures-v2)
* [Catalog Item Types](#catalog-item-types-v2)
* [Request Types](#request-types-v2)
* [Response Types](#response-types-v2)
- [Legacy API (V1)](#legacy-api-v1)
* [API Transition V1 to V2](#transition-v1-to-v2)
* [Catalog Item Types V1](#catalog-item-types-v1)
* [API Data Structures (V1)](#response-data-structures-v1)
* [Response Types V1](#response-types-v1)
### Introduction <a name="introduction"></a>
The main goals of the Spatial Reference Catalog service are to offer
- *Coordinate Reference Systems* (CRSs) to enable end-users to
make a CRS selection.
- Search for CRSs given a number of constraints.
- Download of the entire catalog for local caching and when the cache
has to be refreshed.
- Access to various sub-sets of the catalog.
- Once a CRS is found, produce a persistable reference to be stored with
the data, which fully describes the CRS; this persistable reference string
becomes catalog independent. This means any consumer will be able to
understand the CRS definition even if a different catalog is used in the
future context.
[Back to table of contents](#TOC)
### Fundamental Concepts <a name="fundamental-concepts"></a>
Coordinate Reference Systems (`CRS`) consists of a
[coordinate systems](https://en.wikipedia.org/wiki/Coordinate_system)
combined with geodetic reference. The [geodetic reference](https://en.wikipedia.org/wiki/Geodetic_datum),
aka. geodetic datum or geographic coordinate reference system takes an ellipsoid as
mathematical approximation of the earth and a prime meridian where the longitude is zero.
Latitude is zero at the equator. Latitude and longitude are measured in plane angles
([spherical coordinate system](https://en.wikipedia.org/wiki/Spherical_coordinate_system)).
Since the mathematical shape is an approximation, there
are many realizations of geodetic references, often optimizing to a single landmass or continent.
Examples are [NAD27](https://en.wikipedia.org/wiki/North_American_Datum),
NAD83 in North America, [ED50](https://en.wikipedia.org/wiki/ED50) in Europe.
With the introduction of satellites, one world-wide approximation has been defined, which is the
[World Geodetic System of 1984 (WGS 84)](https://en.wikipedia.org/wiki/World_Geodetic_System).
This is the reference used in the [Global Positioning System](https://en.wikipedia.org/wiki/Global_Positioning_System).
WGS 84 is still a mathematical approximation. Over time, plate tectonics
moves the continents under the ellipsoid. At the moment, the relative shifts
are in the order of normal GPS resolution, but will accumulate further over time.
Eventually the geospatial references will become time dependent. The current
catalog does not contain any time-dependent elements yet.
Each geodetic reference is independent. One physical position will manifest
itself with different numeric coordinate values based on different geodetic
references. The operation to perform a datum transformation is called a
[cartographic transformation](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion#Datum_transformations) (`CT`).
The CRS catalog contains a list of such transformations. Often there are
many realizations of transformations for a given pair of geodetic datums.
The choice of transformation is non-trivial and typically the responsibility
of geodesists or geomatics specialists. Ordinary end users or data consumers
will not be able to make such decisions.
This is the reason why so-called early-bound coordinate reference systems (`EarlyBoundCRS`)
were introduced: An early-bound CRS pairs a (late-bound or un-bound) `LateBoundCRS`
with a unique cartographic transformation CT. Typically this transformation
links the CRS's geodetic reference to WGS 84. Different early-bound CRSs
then enable the *any datum* to *any datum* case, via the hub CRS WGS 84.
Generally, only `EarlyBoundCRS` are of any practical use to applications
because of their versatility to be converted to any other `EarlyBoundCRS`.
Only `LateBoundCRS` based on WGS 84 can deliver the same versatility.
For simplicity, all CRS types have a property `transformationReady`; if
this property is `true` then data can likely be converted to any other
geodetic reference.
Finally, there are map projections based on geographic CRSs, so-called
projected CRSs. Projected CRSs use a
[Cartesian coordinate system](https://en.wikipedia.org/wiki/Cartesian_coordinate_system),
i.e. both axes are measured in length. All projected CRSs are initially
defined as late-bound or un-bound CRSs. When such a CRS is bound to a
cartographic transformation, a projected, early-bound CRS is created.
So far we only covered 2D CRSs, i.e. the third dimension is implicitly
given as height above mean sea level (MSL). Almost all CRSs currently
in use are 2D CRSs. Currently transformations between 2D CRSs will not
change the vertical values (z-coordinate) since the values refer
implicitly to the same MSL reference surface.
Eventually more formal 3D CRSs will be introduced, `CompoundCRS`. Such CRSs will combine
a horizontal CRS (a conventional 2D CRS) with a 1D vertical CRS. Both CRSs
can be early-bound, i.e. associated to a transformation to WGS 84 (2D)
or associated to a transformation to MSL (1D). The CRS catalog contains
a few examples of WGS 84 based UTM projections (2D) paired with the EGM96
height CRS (1D). These CRSs are 'demonstrators' for the concept but
currently not supported by the coordinate conversion service.
Some further notes about cartographic transformations: There are two types
of transformations:
* `SingleCT`, a single transformation, the most common type.
* `CompoundCT`,
which consists of many `SingleCT` items with a `policy` of how to use them.
* The
`policy` 'fallback' means that the list of transformations is tried one
by one until a point is successfully transformed.
* The `policy` 'concatenated'
means that the points are sequentially transformed, e.g. T1->T2->T3.
Finally, to aid the selection process, `CRS` and `CT` can be associated
`AreaOfUse` definitions, which provide a simple bounding box in WGS 84
latitude and longitude. The CRS catalog offers a list of such definitions.
Overview of types delivered by the CRS Catalog:
Item Type | Link to Item Details
----------|---------------------
`LateBoundCRS` | [late-bound or un-bound CRS details](#LateBoundCRS)
`EarlyBoundCRS` | [early-bound CRS details](#EarlyBoundCRS)
`CompoundCRS` | [compound CRS details](#CompoundCRS)
`SingleCT` | [single CT details](#SingleCT)
`CompoundCT` | [compound CT details](#CompoundCT)
`AreaOfUse` | [Area of Use details](#AreaOfUse-v2)
[Back to table of contents](#TOC)
### Service Authentication <a name="service-authentication"></a>
Typically the CRS catalog services are used by other apps and services.
To authenticate, see [SAuth Service Identity](/solutions/dataecosystem/tutorials/entitlementssauthserviceidentity)
about how to obtain the SAuth Java Web Token (JWT).
In the http header, populate:
```
Authorization: Bearer <JWT>
ApiKey: <AppKey as registered with DELFI>
```
The user must also belong to the following entitlement groups to be properly authorized:
```
users@common.{domain}.com (e.g. users@instance.osdu.opengroup.org)
service.entitlements.user (for common tenant)
```
Examples can be found and tried by the "<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/search-crs" target="_blank">Try it out (opens in another window)</a>".
Generate an example token (Custom Token button), 'Try it out' and
inspect the Request. You will find the the populated http request.
### API Versions <a name="api_versions"><a>
The current API is version 2. The previous version, version 1, is still
operational. It is, however, recommended to transition to the latest version 2.
To ease the this transition, see the section [Transitioning V2 to V2](#v1_to_v2_transition).
The main difference between the versions are:
- Simpler encoding of the so-called essence of the elements, i.e.
coordinate reference systems (CRSs), cartographic transformations (CTs)
and areas of use.
- Shorter JSON property names leading to more concise persistable reference (see example below)
strings.
- Turn some GET to POST requests where the length of the URL path grew too long.
Data are now passed in the request body and are no longer subject to encoding.
**Note**: persistable reference strings from version 1 are accepted by the
catalog implementation of version2 - but not vice versa. Related services
consume any version of persistable reference string, for example
[CRS Conversion Service](/solutions/dataecosystem/tutorials/crsconversionservice).
Below a persistable reference string comparison for the same `LateBoundCRS` with authority code EPSG,26782 - the contents is the same:
```
persistableReferenceV2: "{\"wkt\":\"PROJCS[\\\"NAD_1927_StatePlane_Louisiana_South_FIPS_1702\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],PROJECTION[\\\"Lambert_Conformal_Conic\\\"],PARAMETER[\\\"False_Easting\\\",2000000.0],PARAMETER[\\\"False_Northing\\\",0.0],PARAMETER[\\\"Central_Meridian\\\",-91.3333333333333],PARAMETER[\\\"Standard_Parallel_1\\\",29.3],PARAMETER[\\\"Standard_Parallel_2\\\",30.7],PARAMETER[\\\"Latitude_Of_Origin\\\",28.6666666666667],UNIT[\\\"Foot_US\\\",0.304800609601219],AUTHORITY[\\\"EPSG\\\",26782]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_StatePlane_Louisiana_South_FIPS_1702\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"26782\"},\"type\":\"LBC\"}"
persistableReferenceV1: "%7B%22WKT%22%3A%22PROJCS%5B%5C%22NAD_1927_StatePlane_Louisiana_South_FIPS_1702%5C%22%2CGEOGCS%5B%5C%22GCS_North_American_1927%5C%22%2CDATUM%5B%5C%22D_North_American_1927%5C%22%2CSPHEROID%5B%5C%22Clarke_1866%5C%22%2C6378206.4%2C294.9786982%5D%5D%2CPRIMEM%5B%5C%22Greenwich%5C%22%2C0.0%5D%2CUNIT%5B%5C%22Degree%5C%22%2C0.0174532925199433%5D%5D%2CPROJECTION%5B%5C%22Lambert_Conformal_Conic%5C%22%5D%2CPARAMETER%5B%5C%22False_Easting%5C%22%2C2000000.0%5D%2CPARAMETER%5B%5C%22False_Northing%5C%22%2C0.0%5D%2CPARAMETER%5B%5C%22Central_Meridian%5C%22%2C-91.3333333333333%5D%2CPARAMETER%5B%5C%22Standard_Parallel_1%5C%22%2C29.3%5D%2CPARAMETER%5B%5C%22Standard_Parallel_2%5C%22%2C30.7%5D%2CPARAMETER%5B%5C%22Latitude_Of_Origin%5C%22%2C28.6666666666667%5D%2CUNIT%5B%5C%22Foot_US%5C%22%2C0.304800609601219%5D%2CAUTHORITY%5B%5C%22EPSG%5C%22%2C26782%5D%5D%22%2C%22Type%22%3A%22LBCRS%22%2C%22EngineVersion%22%3A%22PE_10_3_1%22%2C%22Name%22%3A%22NAD_1927_StatePlane_Louisiana_South_FIPS_1702%22%2C%22AuthorityCode%22%3A%7B%22Authority%22%3A%22EPSG%22%2C%22Code%22%3A%2226782%22%7D%7D"
```
The following sections elaborate a few use cases.
[Back to table of contents](#TOC)
### Main Use cases <a name="main-use-cases"></a>
#### CRS Search <a name="crs-search"></a>
Find all CRSs in a given area, which are data CRS candidates
A coordinate reference system is often not enough to enable flexible
coordinate conversion/transformation. To
ensure that this is the case it is possible to require
*transformation-ready* CRSs, i.e. CRSs, which allow transformations to
other geodetic datums.
Optionally, the area of use can be constrained. Decimal values are
expected in degrees latitude, longitude referring to the
[*WGS 84*](https://en.wikipedia.org/wiki/World_Geodetic_System) CRS.
The four values span a bounding box in spherical coordinates:
![Geographical Constraints by Latitude/Longitude Box](https://storage.googleapis.com/devportal-live-public/AreaConstraint.png)
Let us run an example with the following constraints:
- Only return CRS, which are bound to a cartographic transformation to WGS 84 or based on WGS 84. This becomes a query constraint.
- Only return CRS, which are based on NAD27, EPSG, 4267. This becomes a query constraint.
- Longitude range between 100°W and 80°W \[-100, -80\].
- Latitude range between 20°N and 50°N \[20, 50\].
- Limit the response to the first two items in the catalog.
- Request returned data to contain the JSON structure of the essence rather than the persistable reference (default).
Parameter|Value in path
---------|-------------------------------
{longitudeLeft}|```-100``` (in degrees; negative W, positive E, range \[-180,180\]
{latitudeLower}|```20``` (in degrees; negative S, positive N, range \[-90,90\]
{longitudeRight}|```-80``` (in degrees; negative W, positive E, range \[-180,180\]
{latitudeUpper}|```50``` (in degrees; negative S, positive N, range \[-90,90\]
{offset}|```0``` (default 0)
{limit}|```2``` (default 100)
{mode}|What kind of response `persistable_reference` (default), populates `namedReference`) or `essence`, populates `essence` property or `persistable_and_essence` to have both `namedReference` and `essence` populated.
Query constraint passed via the request body (JSON encoded). For valid search keywords, please see the [keyword table below](#crs-search-keywords-v2):
```
{
"query": "baseCRS.code:4267 transformationReady:true"
}
```
The query with the example values below:
```
POST /api/v2/search/crs?longitudeLeft=-100&latitudeLower=20&longitudeRight=-80&latitudeUpper=50&offset=0&limit=2&mode=essence
```
<details><summary>CURL search command</summary>
```
curl --request POST \
--url '{root-url}/api/v2/search/crs?mode=essence&limit=2&offset=0&longitudeLeft=-100&longitudeRight=-80&latitudeLower=20&latitudeUpper=50' \
--header 'Authorization: Bearer {Java-Web-Token}' \
--header 'AppKey: {DELFI Api-Key}'
--header 'Content-Type: application/json' \
-d '{
"query": "baseCRS.code:4267 transformationReady:true"
}'
```
</details>
<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/search-crs" target="_blank">Try this example by opening the API catalog in another window</a>.
The request with the parameters above creates the following response:
<a name="search-response-example"></a>
<details><summary>Response example</summary>
```
{
"offset": 0,
"count": 2,
"totalCount": 49,
"crses": [
{
"description": "NAD_1927_StatePlane_Louisiana_North_FIPS_1701 bound to NAD_1927_To_WGS_1984_79_CONUS [26781,15851]",
"lastModified": "20170614",
"aliasNames": [
"LA-N",
"SPCS27_1701"
],
"namedReference": null,
"source": "SIS factory catalog",
"numberOfAxes": 2,
"axisUnits": [
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":0.3048006096012192},\"symbol\":\"ftUS\",\"type\":\"USO\"}",
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":0.3048006096012192},\"symbol\":\"ftUS\",\"type\":\"USO\"}"
],
"deprecationInfo": null,
"essence": {
"authCode": {
"auth": "SLB",
"code": "26781079"
},
"type": "EBC",
"ver": "PE_10_3_1",
"name": "NAD27 * OGP-Usa Conus / Louisiana North [26781,15851]",
"lateBoundCRS": {
"authCode": {
"auth": "EPSG",
"code": "26781"
},
"type": "LBC",
"ver": "PE_10_3_1",
"name": "NAD_1927_StatePlane_Louisiana_North_FIPS_1701",
"wkt": "PROJCS[\"NAD_1927_StatePlane_Louisiana_North_FIPS_1701\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Lambert_Conformal_Conic\"],PARAMETER[\"False_Easting\",2000000.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",-92.5],PARAMETER[\"Standard_Parallel_1\",31.1666666666667],PARAMETER[\"Standard_Parallel_2\",32.6666666666667],PARAMETER[\"Latitude_Of_Origin\",30.6666666666667],UNIT[\"Foot_US\",0.304800609601219],AUTHORITY[\"EPSG\",26781]]"
},
"singleCT": {
"authCode": {
"auth": "EPSG",
"code": "15851"
},
"type": "ST",
"ver": "PE_10_3_1",
"name": "NAD_1927_To_WGS_1984_79_CONUS",
"wkt": "GEOGTRAN[\"NAD_1927_To_WGS_1984_79_CONUS\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],METHOD[\"NADCON\"],PARAMETER[\"Dataset_conus\",0.0],AUTHORITY[\"EPSG\",15851]]"
},
"compoundCT": null
},
"transformationReady": true,
"crstype": "Projected",
"baseCRSAuthorityCode": {
"auth": "EPSG",
"code": "4267"
},
"areaOfUse": {
"description": "United States (USA) - Louisiana - counties of Avoyelles; Bienville; Bossier; Caddo; Caldwell; Catahoula; Claiborne; Concordia; De Soto; East Carroll; Franklin; Grant; Jackson; La Salle; Lincoln; Madison; Morehouse; Natchitoches; Ouachita; Rapides; Red River; Richland; Sabine; Tensas; Union; Vernon; Webster; West Carroll; Winn.",
"lastModified": "20140501",
"aliasNames": [],
"namedReference": null,
"name": "USA - Louisiana - SPCS - N",
"deprecationInfo": null,
"essence": {
"name": null,
"authCode": {
"auth": "EPSG",
"code": "2204"
},
"type": "AOU",
"boundBox": {
"lonMin": -94.05,
"latMin": 30.85,
"lonMax": -90.86,
"latMax": 33.03
}
}
}
},
{
"description": "NAD_1927_StatePlane_Texas_North_FIPS_4201 bound to NAD_1927_To_WGS_1984_79_CONUS [32037,15851]",
"lastModified": "20170614",
"aliasNames": [
"SPCS27_4201",
"TX-N"
],
"namedReference": null,
"source": "SIS factory catalog",
"numberOfAxes": 2,
"axisUnits": [
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":0.3048006096012192},\"symbol\":\"ftUS\",\"type\":\"USO\"}",
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":0.3048006096012192},\"symbol\":\"ftUS\",\"type\":\"USO\"}"
],
"deprecationInfo": null,
"essence": {
"authCode": {
"auth": "SLB",
"code": "32037079"
},
"type": "EBC",
"ver": "PE_10_3_1",
"name": "NAD27 * OGP-Usa Conus / Texas North [32037,15851]",
"lateBoundCRS": {
"authCode": {
"auth": "EPSG",
"code": "32037"
},
"type": "LBC",
"ver": "PE_10_3_1",
"name": "NAD_1927_StatePlane_Texas_North_FIPS_4201",
"wkt": "PROJCS[\"NAD_1927_StatePlane_Texas_North_FIPS_4201\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Lambert_Conformal_Conic\"],PARAMETER[\"False_Easting\",2000000.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",-101.5],PARAMETER[\"Standard_Parallel_1\",34.65],PARAMETER[\"Standard_Parallel_2\",36.1833333333333],PARAMETER[\"Latitude_Of_Origin\",34.0],UNIT[\"Foot_US\",0.304800609601219],AUTHORITY[\"EPSG\",32037]]"
},
"singleCT": {
"authCode": {
"auth": "EPSG",
"code": "15851"
},
"type": "ST",
"ver": "PE_10_3_1",
"name": "NAD_1927_To_WGS_1984_79_CONUS",
"wkt": "GEOGTRAN[\"NAD_1927_To_WGS_1984_79_CONUS\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],METHOD[\"NADCON\"],PARAMETER[\"Dataset_conus\",0.0],AUTHORITY[\"EPSG\",15851]]"
},
"compoundCT": null
},
"transformationReady": true,
"crstype": "Projected",
"baseCRSAuthorityCode": {
"auth": "EPSG",
"code": "4267"
},
"areaOfUse": {
"description": "United States (USA) - Texas - counties of: Armstrong; Briscoe; Carson; Castro; Childress; Collingsworth; Dallam; Deaf Smith; Donley; Gray; Hall; Hansford; Hartley; Hemphill; Hutchinson; Lipscomb; Moore; Ochiltree; Oldham; Parmer; Potter; Randall; Roberts; Sherman; Swisher; Wheeler.",
"lastModified": "20140501",
"aliasNames": [],
"namedReference": null,
"name": "USA - Texas - SPCS - N",
"deprecationInfo": null,
"essence": {
"name": null,
"authCode": {
"auth": "EPSG",
"code": "2253"
},
"type": "AOU",
"boundBox": {
"lonMin": -103.03,
"latMin": 34.3,
"lonMax": -99.99,
"latMax": 36.5
}
}
}
}
]
}
```
</details>
[Back to table of contents](#TOC)
### Get all CRSs <a name="get-all-crss"></a>
When populating a multi-purpose CRS selector, this method offers access to all CRSs of any sub-type as defined in the catalog:
```
GET /api/v2/crs?offset={offset}&limit={limit}
```
Parameter|Value
---------|-----------------
{offset}|```0``` (default 0)
{limit}|```1000``` (default 100, -1 for all)
{mode}|What kind of response `persistable_reference` (default), populates `namedReference`) or `essence`, populates `essence` property or `persistable_and_essence` to have both `namedReference` and `essence` populated.
Open <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-crs" target="_blank">Try it out: get-all-crs</a>
The response structure is of type [CRSResults](#CRSResults), which is the same structure as for the [search use case above](#search-response-example).
<details><summary>CURL Get all CRS command</summary>
```
curl --request GET \
--url '{root-url}/api/v2/crs?limit=1000&offset=0&mode=essence' \
--header 'Authorization: Bearer {Java-Web-Token}' \
--header 'AppKey: {DELFI App-Key}'
```
</details>
[Back to table of contents](#TOC)
### Entire Catalog Request <a name="entire-catalog-request"></a>
In some cases apps may want to cache the entire catalog of coordinate reference systems and cartographic transforms.
The CRS catalog service supports this with the following two methods:
1. ```/catalog``` to request the catalog summary -
Open <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-catalog-summary" target="_blank">Try it out in new window</a>. The response is of type [Catalog](#catalog-v2).
The response comes with a number of arrays, but all of them are empty. Corresponding to each array there is a count. API clients can decide which arrays to populate and e.g. keep in a long-term cache.
1. ```/catalog/attributes``` to request the last modification date of the catalog.
Open <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcatalogattributes" target="_blank">Try it out in new window</a>. The response if of type [CatalogAttributes](#catalogattributes-v1).
The latter method allows apps to determine when the cached contents has become stale and needs a refresh.
The following table associates the arrays with the appropriate API methods to populate.
Array/List | Type | Count| API | Description
-----------|------|------|-----|------------
**lateBoundCRSes** | [**list\[LateBoundCRS\]**](#LateBoundCRS) | **lateBoundCRSesCount** | <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-lateboundcrs" target="_blank">Try it out: get-all-lateboundcrs</a> | The list of late-bound coordinate reference systems.
**earlyBoundCRSes** | [**list\[EarlyBoundCRS\]**](#EarlyBoundCRS) | **earlyBoundCRSesCount** | <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-earlyboundcrs" target="_blank">Try it out: get-all-earlyboundcrs</a> | The list of early-bound coordinate reference systems.
**compoundCRSes** | [**list\[CompoundCRS\]**](#CompoundCRS) | **compoundCRSesCount** | <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-compoundcrs" target="_blank">Try it out: get-all-compoundcrs</a> | The list of compound coordinate reference systems.
**singleCTs** | [**list\[SingleCT\]**](#SingleCT) | **singleCTsCount** | <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-singlect" target="_blank">Try it out: get-all-singlect</a> | The list of single cartographic transforms.
**compoundCTs** | [**list\[CompoundCT\]**](#CompoundCT) | **compoundCTsCount** | <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-compoundct" target="_blank">Try it out: get-all-compoundct</a> | The list of compound cartographic transforms.
**areaOfUses** | [**list\[AreaOfUse\]**](#AreaOfUse-v2) | **areaOfUseCount** | <a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-areas-use" target="_blank">Try it out: get-all-areas-use</a> | The list of areas of use.
[Back to table of contents](#TOC)
## CRS Catalog API Overview <a name="preferred-api-v2"></a>
Method|Try it out (in new window)|Request Type|Response Type
------|--------------------------|------------|-------------
|***Catalog API***| |
`GET /api/v2/catalog`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-catalog-summary" target="_blank">Try it out: get-catalog-summary</a>|-|[Catalog](#catalog-v2)
`GET /api/v2/catalog/attributes`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-catalog-attributes" target="_blank">Try it out: get-catalog-attributes</a>|-|[CatalogAttributes](#CatalogAttributes-v2)
|***Coordinate Reference System API***| |
`GET /api/v2/crs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-crs" target="_blank">Try it out: get-all-crs</a>|-|[CRSResults](#CRSResults)
`POST /api/v2/crs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-crs" target="_blank">Try it out: get-one-crs</a>|[CRSRequest](#CRSRequest)|[CRS](#CRS)
`GET /api/v2/lateboundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-lateboundcrs" target="_blank">Try it out: get-all-lateboundcrs</a>|-|[LateBoundCRSResults](#LateBoundCRSResults)
`POST /api/v2/lateboundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-lateboundcrs" target="_blank">Try it out: get-one-lateboundcrs</a>|[LateBoundCRSRequest](#LateBoundCRSRequest)|[LateBoundCRS](#LateBoundCRS)
`GET /api/v2/earlyboundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-earlyboundcrs" target="_blank">Try it out: get-all-earlyboundcrs</a>|-|[EarlyBoundCRSResults](#EarlyBoundCRSResults)
`POST /api/v2/earlyboundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-earlyboundcrs" target="_blank">Try it out: get-all-earlyboundcrs</a>|[EarlyBoundCRSRequest](#EarlyBoundCRSRequest)|[EarlyBoundCRS](#EarlyBoundCRS)
`GET /api/v2/compoundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-compoundcrs" target="_blank">Try it out: get-all-compoundcrs</a>|-|[CompoundCRSResults](#CompoundCRSResults)
`POST /api/v2/compoundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-compoundcrs" target="_blank">Try it out: get-one-compoundcrs</a>|[CompoundCRSRequest](#CompoundCRSRequest)|[CompoundCRS](#CompoundCRS)
`POST /api/v2/search/crs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/search-crs" target="_blank">Try it out: search-crs</a>|[SearchCRSRequest](#SearchCRSRequest), [search keywords](#crs-search-keywords-v2) |[CRSResults](#CRSResults)
|***Cartographic Transformations API***| |
`GET /api/v2/ct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-ct" target="_blank">Try it out: get-all-ct</a>|-|[CTResults](#CTResults)
`POST /api/v2/ct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-ct" target="_blank">Try it out: get-one-ct</a>|[CTRequest](#CTRequest)|[CT](#CT)
`GET /api/v2/singlect`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-singlect" target="_blank">Try it out: get-all-singlect</a>|-|[SingleCTResults](#SingleCTResults)
`POST /api/v2/singlect`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-singlect" target="_blank">Try it out: get-one-singlect</a>|[SingleCTRequest](#SingleCTRequest)|[SingleCT](#SingleCT)
`GET /api/v2/compoundct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-compoundct" target="_blank">Try it out: get-all-compoundct</a>|-|[CompoundCTResults](#CompoundCTResults)
`POST /api/v2/compoundct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-compoundct" target="_blank">Try it out: get-one-compoundct</a>|[CompoundCTRequest](#CompoundCTRequest)|[CompoundCT](#CompoundCT)
`POST /api/v2/search/ct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/search-ct" target="_blank">Try it out: search-ct</a>|[SearchCTRequest](#SearchCTRequest), [search keywords](#ct-search-keywords-v2)|[CTResults](#CTResults)
|***Area of Use API***| |
`GET /api/v2/area`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-areas-use" target="_blank">Try it out: get-all-areas-use</a>|-|[AreaOfUseResults](#AreaOfUseResults)
`POST /api/v2/area`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-area-use" target="_blank">Try it out: get-one-area-use</a>|[AreaOfUseRequest](#AreaOfUseRequest)|[AreaOfUse](#AreaOfUse)
`POST /api/v2/search/area`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/search-area-use" target="_blank">Try it out: search-area-use</a>|[SearchAreaOfUseRequest](#SearchAreaOfUseRequest), [search keywords](#area-search-keywords)|[AreaOfUseResults](#AreaOfUseResults)
[Back to table of contents](#TOC)
#### CRS search keywords <a name="crs-search-keywords-v2"></a>
The following table lists the keyword codes for the Lucene style query elements.
Keyword code|Constrain by|Values in use or example
------------|------------|-------------
`name:`|specific words/sub-strings in the name| Example: `name:*ED50*`
`description:`|specific sub-strings in the description|
`type:`| Type code for the CRS | `type:LBCRS` (late-bound or un-bound CRS), `type:EBCRS` (early-bound CRS), `type:CCRS` (compound CRS)
`authority:`|Authority|Example: `authority:EPSG`
`code:`|Authority code number|Example: `code:4326`
`deprecationState:`|State of deprecation | `deprecationState:identical` (can be swapped) or `deprecationState:corrected` non-trivial deprecation
`remarks:`|specific sub-strings in the deprecation remarks| Example: `remarks:Deprecated`
`lastModified:`|specific last modification dates| Example: `lastModified:20070827`
`source:`|CRS source|Example: `source:OGP`
`wellKnownText:`|specific words/sub-strings in the well-known text (late-bound or un-bound CRSs only)|Example: `wellKnownText:*Clarke_1880_RGS*`
`crsType:`|Coordinate Reference System (CRS) type|Example: `crsType:"Compound Projected"`
`baseCRS.authority:`|projected CRS's base CRS authority|Example: `baseCRS.authority:EPSG`
`baseCRS.code:`|projected CRS's base CRS authority code|Example: `baseCRS.code:4267` (NAD27)
`horizontalCRS.authority:`|compound CRS's horizontal CRS authority|Example: `horizontalCRS.authority:EPSG`
`horizontalCRS.code:`|compound CRS's horizontal CRS authority code|Example: `horizontalCRS.code:32615`
`verticalCRS.authority:`|compound CRS's vertical CRS authority|Example: `verticalCRS.authority:EPSG`
`verticalCRS.code:`|compound CRS's vertical CRS authority code|Example: `verticalCRS.code:5773`
`lateBoundCRS.authority:`|early-bound CRS's (late-bound) CRS authority|Example: `lateBoundCRS.authority:EPSG`
`lateBoundCRS.code:`|early-bound CRS's (late-bound) CRS authority code|Example: `lateBoundCRS.code:23031`
`ct.authority:`|early-bound CRS's cartographic transform authority|Example: `ct.authority:EPSG`
`ct.code:`|early-bound CRS's cartographic transform authority code|Example: `ct.code:1612`
`transformationReady:`|CRS's transformation readiness, i.e. is the CRS ready to be used in datum transformations (true or false)|`transformationReady:true` or `transformationReady:false`
[Back to table of contents](#TOC)
#### CT search keywords <a name="ct-search-keywords-v2"></a>
The following table lists the keyword codes for the Lucene style query elements.
Keyword code|Constrain by|Values in use or example
------------|------------|-------------
`name:`|specific words/sub-strings in the name| Example: `name:*NAD_1927*`
`description:`|specific sub-strings in the description|
`type:`|Type code for the Cartographic Transform (CT) | `type:ST` (single CT), `type:CT` (compound CT)
`authority:`|Authority|Example: `authority:EPSG`
`code:`|Authority code number|Example: `code:15851`
`deprecationState:`|State of deprecation | `deprecationState:identical` (can be swapped) or `deprecationState:corrected` non-trivial deprecation
`remarks:`|specific sub-strings in the deprecation remarks| Example: `remarks:*PE_10_1_0*`
`lastModified:`|specific last modification dates| Example: `lastModified:20180611`
`source:`|CT source|Example: `source:OGP`
`wellKnownText:`|specific words/sub-strings in the well-known text (late-bound or un-bound CRSs only)|Example: `wellKnownText:*Dataset_conus*`
`fromCRS.authority:`|source CRS authority|`fromCRS.authority:EPSG`
`fromCRS.code:`|source CRS code|`fromCRS.code:4267`
`toCRS.authority:`|target CRS authority|`toCRS.authority:EPSG`
`toCRS.code:`|target CRS code|`toCRS.code:4328`
`policy:`|compound transformation policy|`policy:fallback` or `policy:concatenated`
[Back to table of contents](#TOC)
#### Area of Use search keywords <a name="area-search-keywords"></a>
The following table lists the keyword codes for the Lucene style query elements. The keywords apply to all API versions.
Keyword code|Constrain by|Values in use or example
------------|------------|-------------
`name:`|specific words/sub-strings in the name| Example: `name:*America*`
`description:`|specific sub-strings in the description| Example: `description:*DMA ED50*`
`authority:`|Authority|Example: `authority:SLB`
`code:`|Authority code number|Example: `code:2205`
`deprecationState:`|State of deprecation | `deprecationState:identical` (can be swapped) or `deprecationState:corrected` non-trivial deprecation
`remarks:`|specific sub-strings in the deprecation remarks|
`lastModified:`|specific last modification dates| Example: `lastModified:20180611`
[Back to table of contents](#TOC)
## API Data Structures <a name="response-data-structures-v2"></a>
* [Catalog Item Types](#catalog-item-types-v2)
* [Request Types](#request-types-v2)
* [Response Types](#response-types-v2)
### Catalog Item Types <a name="catalog-item-types-v2"></a>
#### Catalog <a name="catalog-v2"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**areaOfUseCount** | **int** | The total number of Area Of Uses in the catalog. | \[optional\]
**areaOfUses** | [**list\[AreaOfUse\]**](#AreaOfUse-v2) | The complete list of areas of use. | \[optional\]
**attributes** | [**CatalogAttributes**](#CatalogAttributes-v2) | The name and last modification time of the catalog. | \[optional\]
**compoundCTsCount** | **int** | The total number of compoundCTs in the catalog. | \[optional\]
**compoundCTs** | [**list\[CompoundCT\]**](#CompoundCT) | The complete list of compound cartographic transforms | \[optional\]
**compoundCRSesCount** | **int** | The total number of compoundCRSes in the catalog. | \[optional\]
**compoundCRSes** | [**list\[CompoundCRS\]**](#CompoundCRS) | The complete list of compound coordinate reference systems. | \[optional\]
**earlyBoundCRSesCount** | **int** | The total number of earlyBoundCRSes in the catalog. | \[optional\]
**earlyBoundCRSes** | [**list\[EarlyBoundCRS\]**](#EarlyBoundCRS) | The complete list of early-bound coordinate reference systems. | \[optional\]
**lateBoundCRSesCount** | **int** | The total number of lateBoundCRSes in the catalog. | \[optional\]
**lateBoundCRSes** | [**list\[LateBoundCRS\]**](#LateBoundCRS) | The complete list of late-bound coordinate reference systems. | \[optional\]
**singleCTsCount** | **int** | The total number of singleCTs in the catalog. | \[optional\]
**singleCTs** | [**list\[SingleCT\]**](#SingleCT) | The complete list of single cartographic transforms | \[optional\]
<details><summary>Catalog example</summary>
```
{
"lateBoundCRSes": [],
"lateBoundCRSesCount": 1151,
"earlyBoundCRSes": [],
"earlyBoundCRSesCount": 1059,
"compoundCRSesCount": 60,
"singleCTs": [],
"singleCTsCount": 227,
"compoundCTs": [],
"compoundCTsCount": 1,
"areaOfUseCount": 953,
"attributes": {
"name": "Minimal EPSG standard catalog",
"description": "Catalog containing selected ESRI's standard EPSG coordinate reference systems and cartographic transforms, and limited early-bound coordinate reference systems where the CRS and TRF area-of-use intersect; augmented by Ocean factory catalog standard definitions",
"lastModified": "2018-06-11T15:39:55.1229803Z"
},
"areasOfUse": [],
"compoundCRSes": []
}
```
</details>
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CatalogAttributes <a name="CatalogAttributes-v2"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | \[optional\]
**lastModified** | **str** | The last modification date and time (UTC) of this catalog. | \[optional\]
**name** | **str** | Name of the catalog | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### LateBoundCRS <a name="LateBoundCRS"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**crstype** | **str** | The type of the LateBoundCRS. | \[optional\]
**source** | **str** | The source of the LateBoundCRS. | \[optional\]
**transformationReady** | **bool** | The Transformation readiness of the LateBoundCRS. | \[optional\]
**baseCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The base authority code of the LateBoundCRS. | \[optional\]
**aliasNames** | **list\[str\]** | Alias names for this LateBoundCRS. | \[optional\]
**axisUnits** | **list\[str\]** | Axis Unit Essences. | \[optional\]
**numberOfAxes** | **int** | The NumberOfAxes of the LateBoundCRS. | \[optional\]
**description** | **str** | The description of the LateBoundCRS. | \[optional\]
**lastModified** | **str** | The LastModified of the LateBoundCRS. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#AreaOfUse-v2) | The Area of Use for this CRS. | \[optional\]
**deprecationInfo** | [**CRSDeprecationInfo**](#CRSDeprecationInfo) | Only if deprecated - additional information and potentially a recommended replacement CRS. | \[optional\]
**namedReference** | [**NamedReference**](#NamedReference) | A structure containing the item Name and the persistable Reference string; populated if the request mode&#x3D;&#39;persistableReference&#39;. | \[optional\]
**essence** | [**LateBoundCRSEssence**](#LateBoundCRSEssence) | The Essence of the LateBoundCRS; populated if the request mode&#x3D;&#39;essence&#39;. | \[optional\]
<details><summary>LateBoundCRS example</summary>
```
{
"description": "CRS Scope: Geodetic survey.",
"lastModified": "20040106",
"aliasNames": [
"Pointe Noire",
"Congo 1960 Pointe Noire"
],
"namedReference": {
"name": "GCS_Pointe_Noire",
"persistableReference": "{\"wkt\":\"GEOGCS[\\\"GCS_Pointe_Noire\\\",DATUM[\\\"D_Pointe_Noire\\\",SPHEROID[\\\"Clarke_1880_IGN\\\",6378249.2,293.466021293627]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433],AUTHORITY[\\\"EPSG\\\",4282]]\",\"ver\":\"PE_10_3_1\",\"name\":\"GCS_Pointe_Noire\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"4282\"},\"type\":\"LBC\"}"
},
"source": "",
"numberOfAxes": 2,
"axisUnits": [
"{\"measurement\":{\"ancestry\":\"Plane_Angle\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":0.0174532925199433},\"symbol\":\"dega\",\"type\":\"USO\"}",
"{\"measurement\":{\"ancestry\":\"Plane_Angle\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":0.0174532925199433},\"symbol\":\"dega\",\"type\":\"USO\"}"
],
"deprecationInfo": null,
"essence": {
"authCode": {
"auth": "EPSG",
"code": "4282"
},
"type": "LBC",
"ver": "PE_10_3_1",
"name": "GCS_Pointe_Noire",
"wkt": "GEOGCS[\"GCS_Pointe_Noire\",DATUM[\"D_Pointe_Noire\",SPHEROID[\"Clarke_1880_IGN\",6378249.2,293.466021293627]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433],AUTHORITY[\"EPSG\",4282]]"
},
"transformationReady": false,
"crstype": "Geographic2D",
"baseCRSAuthorityCode": null,
"areaOfUse": {
"description": "Congo - onshore and offshore.",
"lastModified": "20140501",
"aliasNames": [],
"namedReference": null,
"name": "Congo",
"deprecationInfo": null,
"essence": {
"name": null,
"authCode": {
"auth": "EPSG",
"code": "1072"
},
"type": "AOU",
"boundBox": {
"lonMin": 8.84,
"latMin": -6.91,
"lonMax": 18.65,
"latMax": 3.72
}
}
}
}
```
</details>
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### LateBoundCRSEssence <a name="LateBoundCRSEssence"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier, fixed to &#39;LBC&#39;. | \[default to 'LBC'\]
**name** | **str** | The name of the late-bound coordinate reference system. |
**ver** | **str** | The engine version issuing the definition. | \[optional\]
**wkt** | **str** | Well-known text (Esri style) of the late-bound coordinate reference system. |
**authCode** | [**AuthCode**](#AuthCode) | The authority code for this item. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### EarlyBoundCRS <a name="EarlyBoundCRS"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**crsType** | **str** | The type of the EarlyBoundCRS. | \[optional\]
**source** | **str** | The source of the EarlyBoundCRS. | \[optional\]
**transformationReady** | **bool** | The TransformationReadyness of the EarlyBoundCRS. | \[optional\]
**baseCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The base authority code of the LateBoundCRS. | \[optional\]
**aliasNames** | **list\[str\]** | Alias names for this EarlyBoundCRS. | \[optional\]
**axisUnits** | **list\[str\]** | Axis Unit Essences. | \[optional\]
**numberOfAxes** | **int** | The NumberOfAxes of the EarlyBoundCRS. | \[optional\]
**description** | **str** | The description of the EarlyBoundCRS. | \[optional\]
**lastModified** | **str** | The LastModified of the EarlyBoundCRS. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#AreaOfUse-v2) | The Area of Use for this CRS. | \[optional\]
**deprecationInfo** | [**CRSDeprecationInfo**](#CRSDeprecationInfo) | Only if deprecated - additional information and potentially a recommended replacement CRS. | \[optional\]
**namedReference** | [**NamedReference**](#NamedReference) | A structure containing the item Name and the persistable Reference string; populated if the request mode&#x3D;&#39;persistableReference&#39;. | \[optional\]
**essence** | [**EarlyBoundCRSEssence**](#EarlyBoundCRSEssence) | The Essence of the EarlyBoundCRS. | \[optional\]
<details><summary>EarlyBoundCRS example</summary>
```
{
"description": "ED_1950_UTM_Zone_31N bound to ED_1950_To_WGS_1984_24 [23031,1613]",
"lastModified": "20180611",
"aliasNames": [],
"namedReference": {
"name": "ED50 * EPSG-Nor S62 2001 / UTM zone 31N [23031,1613]",
"persistableReference": "{\"lateBoundCRS\":{\"wkt\":\"PROJCS[\\\"ED_1950_UTM_Zone_31N\\\",GEOGCS[\\\"GCS_European_1950\\\",DATUM[\\\"D_European_1950\\\",SPHEROID[\\\"International_1924\\\",6378388.0,297.0]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],PROJECTION[\\\"Transverse_Mercator\\\"],PARAMETER[\\\"False_Easting\\\",500000.0],PARAMETER[\\\"False_Northing\\\",0.0],PARAMETER[\\\"Central_Meridian\\\",3.0],PARAMETER[\\\"Scale_Factor\\\",0.9996],PARAMETER[\\\"Latitude_Of_Origin\\\",0.0],UNIT[\\\"Meter\\\",1.0],AUTHORITY[\\\"EPSG\\\",23031]]\",\"ver\":\"PE_10_3_1\",\"name\":\"ED_1950_UTM_Zone_31N\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"23031\"},\"type\":\"LBC\"},\"singleCT\":{\"wkt\":\"GEOGTRAN[\\\"ED_1950_To_WGS_1984_24\\\",GEOGCS[\\\"GCS_European_1950\\\",DATUM[\\\"D_European_1950\\\",SPHEROID[\\\"International_1924\\\",6378388.0,297.0]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],GEOGCS[\\\"GCS_WGS_1984\\\",DATUM[\\\"D_WGS_1984\\\",SPHEROID[\\\"WGS_1984\\\",6378137.0,298.257223563]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],METHOD[\\\"Position_Vector\\\"],PARAMETER[\\\"X_Axis_Translation\\\",-90.365],PARAMETER[\\\"Y_Axis_Translation\\\",-101.13],PARAMETER[\\\"Z_Axis_Translation\\\",-123.384],PARAMETER[\\\"X_Axis_Rotation\\\",0.333],PARAMETER[\\\"Y_Axis_Rotation\\\",0.077],PARAMETER[\\\"Z_Axis_Rotation\\\",0.894],PARAMETER[\\\"Scale_Difference\\\",1.994],AUTHORITY[\\\"EPSG\\\",1613]]\",\"ver\":\"PE_10_3_1\",\"name\":\"ED_1950_To_WGS_1984_24\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"1613\"},\"type\":\"ST\"},\"ver\":\"PE_10_3_1\",\"name\":\"ED50 * EPSG-Nor S62 2001 / UTM zone 31N [23031,1613]\",\"authCode\":{\"auth\":\"SLB\",\"code\":\"23031024\"},\"type\":\"EBC\"}"
},
"source": "Ocean catalog",
"numberOfAxes": 2,
"axisUnits": [
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":1.0},\"symbol\":\"m\",\"type\":\"USO\"}",
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":1.0},\"symbol\":\"m\",\"type\":\"USO\"}"
],
"deprecationInfo": null,
"essence": {
"authCode": {
"auth": "SLB",
"code": "23031024"
},
"type": "EBC",
"ver": "PE_10_3_1",
"name": "ED50 * EPSG-Nor S62 2001 / UTM zone 31N [23031,1613]",
"lateBoundCRS": {
"authCode": {
"auth": "EPSG",
"code": "23031"
},
"type": "LBC",
"ver": "PE_10_3_1",
"name": "ED_1950_UTM_Zone_31N",
"wkt": "PROJCS[\"ED_1950_UTM_Zone_31N\",GEOGCS[\"GCS_European_1950\",DATUM[\"D_European_1950\",SPHEROID[\"International_1924\",6378388.0,297.0]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Transverse_Mercator\"],PARAMETER[\"False_Easting\",500000.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",3.0],PARAMETER[\"Scale_Factor\",0.9996],PARAMETER[\"Latitude_Of_Origin\",0.0],UNIT[\"Meter\",1.0],AUTHORITY[\"EPSG\",23031]]"
},
"singleCT": {
"authCode": {
"auth": "EPSG",
"code": "1613"
},
"type": "ST",
"ver": "PE_10_3_1",
"name": "ED_1950_To_WGS_1984_24",
"wkt": "GEOGTRAN[\"ED_1950_To_WGS_1984_24\",GEOGCS[\"GCS_European_1950\",DATUM[\"D_European_1950\",SPHEROID[\"International_1924\",6378388.0,297.0]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],METHOD[\"Position_Vector\"],PARAMETER[\"X_Axis_Translation\",-90.365],PARAMETER[\"Y_Axis_Translation\",-101.13],PARAMETER[\"Z_Axis_Translation\",-123.384],PARAMETER[\"X_Axis_Rotation\",0.333],PARAMETER[\"Y_Axis_Rotation\",0.077],PARAMETER[\"Z_Axis_Rotation\",0.894],PARAMETER[\"Scale_Difference\",1.994],AUTHORITY[\"EPSG\",1613]]"
},
"compoundCT": null
},
"transformationReady": true,
"crstype": "Projected",
"baseCRSAuthorityCode": {
"auth": "EPSG",
"code": "4230"
},
"areaOfUse": {
"description": "Intersection of Europe - 0°E to 6°E and ED50 by country [1634] and Norway - North Sea - offshore south of 62°N [2334]",
"lastModified": "20180611",
"aliasNames": [],
"namedReference": null,
"name": "Europe - 0°E to 6°E and ED50 by country, Norway - North Sea - offshore south of 62°N",
"deprecationInfo": null,
"essence": {
"name": null,
"authCode": {
"auth": "SLB",
"code": "16342334"
},
"type": "AOU",
"boundBox": {
"lonMin": 1.37,
"latMin": 56.08,
"lonMax": 6.01,
"latMax": 62
}
}
}
}
```
</details>
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### EarlyBoundCRSEssence <a name="EarlyBoundCRSEssence"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier, fixed to &#39;EBC&#39;. | \[default to 'EBC'\]
**name** | **str** | The name of the early-bound coordinate reference system. |
**ver** | **str** | The engine version issuing the definition. | \[optional\]
**lateBoundCRS** | [**LateBoundCRSEssence**](#LateBoundCRSEssence) | Late-bound CRS, which is bound to a single (st) or compound (ct) transformation to WGS 84. |
**single_ct** | [**SingleCTEssence**](#SingleCTEssence) | Single Transformation, which binds the late-bound CRS (lb) to WGS 84. If absent, a compound transformation (ct) must be present. | \[optional\]
**compound_ct** | [**CompoundCTEssence**](#CompoundCTEssence) | Compound transformation, which binds the late-bound CRS (lb) to WGS 84. If absent, a single transformation (st) must be present. | \[optional\]
**auth_code** | [**AuthCode**](#AuthCode) | The authority code for this item. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CompoundCRS <a name="CompoundCRS"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**crstype** | **str** | The type of the CompoundCRS. | \[optional\]
**source** | **str** | The source of the CompoundCRS. | \[optional\]
**transformationReady** | **bool** | The TransformationReadyness of the CompoundCRS. | \[optional\]
**baseCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The base authority code of the LateBoundCRS. | \[optional\]
**aliasNames** | **list\[str\]** | Alias names for this CompoundCRS. | \[optional\]
**axisUnits** | **list\[str\]** | Axis Unit Essences. | \[optional\]
**numberOfAxes** | **int** | The NumberOfAxes of the CompoundCRS. | \[optional\]
**description** | **str** | The description of the CompoundCRS. | \[optional\]
**lastModified** | **str** | The LastModified of the CompoundCRS. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#AreaOfUse-v2) | The Area of Use for this CRS. | \[optional\]
**deprecationInfo** | [**CRSDeprecationInfo**](#CRSDeprecationInfo) | Only if deprecated - additional information and potentially a recommended replacement CRS. | \[optional\]
**namedReference** | [**NamedReference**](#NamedReference) | A structure containing the item Name and the persistable Reference string; populated if the request mode&#x3D;&#39;persistableReference&#39;. | \[optional\]
**essence** | [**CompoundCRSEssence**](#CompoundCRSEssence) | The Essence of the CompoundCRS. | \[optional\]
<details><summary>CompoundCRS example</summary>
```
{
"description": "Horizontal CRS: CRS Scope: Large and medium scale topographic mapping and engineering survey.; Vertical CRS: CRS Scope: Geodesy. | Remarks: Zero-height surface resulting from the application of the EGM96 geoid model to the WGS 84 ellipsoid. Replaces EGM84 height (CRS code 5798). Replaced by EGM2008 height (CRS code 3855). | Information Source: NASA http://cddis.gsfc.nasa.gov/926/egm96/egm96.html",
"lastModified": "20180611",
"aliasNames": [],
"namedReference": {
"name": "WGS 84 / UTM zone 31N + EGM96 height",
"persistableReference": "{\"horzLateBoundCRS\":{\"wkt\":\"PROJCS[\\\"WGS_1984_UTM_Zone_31N\\\",GEOGCS[\\\"GCS_WGS_1984\\\",DATUM[\\\"D_WGS_1984\\\",SPHEROID[\\\"WGS_1984\\\",6378137.0,298.257223563]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],PROJECTION[\\\"Transverse_Mercator\\\"],PARAMETER[\\\"False_Easting\\\",500000.0],PARAMETER[\\\"False_Northing\\\",0.0],PARAMETER[\\\"Central_Meridian\\\",3.0],PARAMETER[\\\"Scale_Factor\\\",0.9996],PARAMETER[\\\"Latitude_Of_Origin\\\",0.0],UNIT[\\\"Meter\\\",1.0],AUTHORITY[\\\"EPSG\\\",32631]]\",\"ver\":\"PE_10_3_1\",\"name\":\"WGS_1984_UTM_Zone_31N\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"32631\"},\"type\":\"LBC\"},\"vertLateBoundCRS\":{\"wkt\":\"VERTCS[\\\"EGM96_Geoid\\\",VDATUM[\\\"EGM96_Geoid\\\"],PARAMETER[\\\"Vertical_Shift\\\",0.0],PARAMETER[\\\"Direction\\\",1.0],UNIT[\\\"Meter\\\",1.0],AUTHORITY[\\\"EPSG\\\",5773]]\",\"ver\":\"PE_10_3_1\",\"name\":\"EGM96_Geoid\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"5773\"},\"type\":\"LBC\"},\"ver\":\"PE_10_3_1\",\"name\":\"WGS 84 / UTM zone 31N + EGM96 height\",\"authCode\":{\"auth\":\"SLB\",\"code\":\"326315773\"},\"type\":\"CC\"}"
},
"source": "Ocean catalog",
"numberOfAxes": 3,
"axisUnits": [
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":1.0},\"symbol\":\"m\",\"type\":\"USO\"}",
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":1.0},\"symbol\":\"m\",\"type\":\"USO\"}",
"{\"measurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"scaleOffset\":{\"offset\":0.0,\"scale\":1.0},\"symbol\":\"m\",\"type\":\"USO\"}"
],
"deprecationInfo": null,
"essence": {
"authCode": {
"auth": "SLB",
"code": "326315773"
},
"type": "CC",
"ver": "PE_10_3_1",
"name": "WGS 84 / UTM zone 31N + EGM96 height",
"horzLateBoundCRS": {
"authCode": {
"auth": "EPSG",
"code": "32631"
},
"type": "LBC",
"ver": "PE_10_3_1",
"name": "WGS_1984_UTM_Zone_31N",
"wkt": "PROJCS[\"WGS_1984_UTM_Zone_31N\",GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Transverse_Mercator\"],PARAMETER[\"False_Easting\",500000.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",3.0],PARAMETER[\"Scale_Factor\",0.9996],PARAMETER[\"Latitude_Of_Origin\",0.0],UNIT[\"Meter\",1.0],AUTHORITY[\"EPSG\",32631]]"
},
"vertLateBoundCRS": {
"authCode": {
"auth": "EPSG",
"code": "5773"
},
"type": "LBC",
"ver": "PE_10_3_1",
"name": "EGM96_Geoid",
"wkt": "VERTCS[\"EGM96_Geoid\",VDATUM[\"EGM96_Geoid\"],PARAMETER[\"Vertical_Shift\",0.0],PARAMETER[\"Direction\",1.0],UNIT[\"Meter\",1.0],AUTHORITY[\"EPSG\",5773]]"
},
"horzEarlyBoundCRS": null,
"vertEarlyBoundCRS": null
},
"transformationReady": false,
"crstype": "Compound Projected Vertical",
"baseCRSAuthorityCode": {
"auth": "EPSG",
"code": "4326"
},
"areaOfUse": {
"description": "Between 0°E and 6°E, northern hemisphere between equator and 84°N, onshore and offshore. Algeria. Andorra. Belgium. Benin. Burkina Faso. Denmark - North Sea. France. Germany - North Sea. Ghana. Luxembourg. Mali. Netherlands. Niger. Nigeria. Norway. Spain. Togo. United Kingdom (UK) - North Sea.",
"lastModified": "20150104",
"aliasNames": [],
"namedReference": null,
"name": "World - N hemisphere - 0°E to 6°E - by country",
"deprecationInfo": null,
"essence": {
"name": null,
"authCode": {
"auth": "EPSG",
"code": "2060"
},
"type": "AOU",
"boundBox": {
"lonMin": 0,
"latMin": 0,
"lonMax": 6,
"latMax": 84
}
}
}
}
```
</details>
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CompoundCRSEssence <a name="CompoundCRSEssence"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier. fixed to &#39;CC&#39;. | \[default to 'CC'\]
**name** | **str** | The name of the compound coordinate reference system. |
**ver** | **str** | The engine version issuing the definition. | \[optional\]
**horzLateBoundCRS** | [**LateBoundCRSEssence**](#LateBoundCRSEssence.) | The horizontal CRS of a Compound CRS as late-bound CRS. If &#39;horzLateBoundCRS&#39; is non-null, &#39;horzEarlyBoundCRS&#39; must be null. | \[optional\]
**horzEarlyBoundCRS** | [**EarlyBoundCRSEssence**](#EarlyBoundCRSEssence) | The horizontal CRS of a Compound CRS as early-bound CRS. If &#39;horzEarlyBoundCRS&#39; is non-null, &#39;horzLateBoundCRS&#39; must be null. | \[optional\]
**vertLateBoundCRS** | [**LateBoundCRSEssence**](#LateBoundCRSEssence) | The vertical CRS of the Compound CRS as late-bound CRS. If &#39;vertLateBoundCRS&#39; is non-null, &#39;vertEarlyBoundCRS&#39; must be null. | \[optional\]
**vertEarlyBoundCRS** | [**EarlyBoundCRSEssence**](#EarlyBoundCRSEssence) | The vertical CRS of the Compound CRS as early-bound CRS. If &#39;vertEarlyBoundCRS&#39; is non-null, &#39;vertLateBoundCRS&#39; must be null. | \[optional\]
**authCode** | [**AuthCode**](#AuthCode) | The authority code for this item. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### SingleCT <a name="SingleCT"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **str** | The source of the SingleCT. | \[optional\]
**aliasNames** | **list\[str\]** | Alias names for this SingleCT. | \[optional\]
**description** | **str** | The description of the SingleCT. | \[optional\]
**fromCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The &#39;from CRS&#39; authority code of this SingleCT. | \[optional\]
**toCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The &#39;to CRS&#39; authority code of this SingleCT. | \[optional\]
**lastModified** | **str** | The LastModified of the SingleCT. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#AreaOfUse-v2) | The Area of Use for this SingleCT. | \[optional\]
**deprecationInfo** | [**CTDeprecationInfo**](#CTDeprecationInfo) | Only if deprecated - additional information and potentially a recommended replacement CT. | \[optional\]
**namedReference** | [**NamedReference**](#NamedReference) | A structure containing the item Name and the persistable Reference string; populated if the request mode&#x3D;&#39;persistableReference&#39;. | \[optional\]
**essence** | [**SingleCTEssence**](#SingleCTEssence) | The Essence of the SingleCT. | \[optional\]
<details><summary>SingleCT example</summary>
```
{
"description": "Coord Op Scope: Recommended for oil industry use in US Gulf of Mexico (GoM). Accuracy at 67% confidence level is 0.15m onshore, 5m nearshore and undetermined farther offshore. | Tfm Accuracy: 5 | Remarks: Transformation taken from NAD27 to NAD83 (1) (code 1241) assuming that NAD83 is equivalent to WGS 84 within the accuracy of this tfm. Uses NADCON method which expects longitudes positive west; EPSG CRS codes 4267 and 4326 have longitudes positive east. | Information Source: OGP",
"lastModified": "20060306",
"aliasNames": [
"NAD27 to WGS 84 (79)"
],
"namedReference": {
"name": "NAD_1927_To_WGS_1984_79_CONUS",
"persistableReference": "{\"wkt\":\"GEOGTRAN[\\\"NAD_1927_To_WGS_1984_79_CONUS\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],GEOGCS[\\\"GCS_WGS_1984\\\",DATUM[\\\"D_WGS_1984\\\",SPHEROID[\\\"WGS_1984\\\",6378137.0,298.257223563]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],METHOD[\\\"NADCON\\\"],PARAMETER[\\\"Dataset_conus\\\",0.0],AUTHORITY[\\\"EPSG\\\",15851]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_To_WGS_1984_79_CONUS\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"15851\"},\"type\":\"ST\"}"
},
"source": "OGP",
"essence": {
"authCode": {
"auth": "EPSG",
"code": "15851"
},
"type": "ST",
"ver": "PE_10_3_1",
"name": "NAD_1927_To_WGS_1984_79_CONUS",
"wkt": "GEOGTRAN[\"NAD_1927_To_WGS_1984_79_CONUS\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],METHOD[\"NADCON\"],PARAMETER[\"Dataset_conus\",0.0],AUTHORITY[\"EPSG\",15851]]"
},
"toCRSAuthorityCode": {
"auth": "EPSG",
"code": "4326"
},
"fromCRSAuthorityCode": {
"auth": "EPSG",
"code": "4267"
},
"areaOfUse": {
"description": "United States (USA) - CONUS including EEZ -onshore and offshore - Alabama; Arizona; Arkansas; California; Colorado; Connecticut; Delaware; Florida; Georgia; Idaho; Illinois; Indiana; Iowa; Kansas; Kentucky; Louisiana; Maine; Maryland; Massachusetts; Michigan; Minnesota; Mississippi; Missouri; Montana; Nebraska; Nevada; New Hampshire; New Jersey; New Mexico; New York; North Carolina; North Dakota; Ohio; Oklahoma; Oregon; Pennsylvania; Rhode Island; South Carolina; South Dakota; Tennessee; Texas; Utah; Vermont; Virginia; Washington; West Virginia; Wisconsin; Wyoming. US Gulf of Mexico (GoM) OCS.",
"lastModified": "20140501",
"aliasNames": [],
"namedReference": null,
"name": "USA - CONUS including EEZ",
"deprecationInfo": null,
"essence": {
"name": null,
"authCode": {
"auth": "EPSG",
"code": "2374"
},
"type": "AOU",
"boundBox": {
"lonMin": -129.17,
"latMin": 23.81,
"lonMax": -65.69,
"latMax": 49.38
}
}
},
"deprecationInfo": null
}
```
</details>
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### SingleCTEssence <a name="SingleCTEssence"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier, fixed to &#39;ST&#39;. | \[default to 'ST'\]
**name** | **str** | The name of the simple cartographic transformation. |
**ver** | **str** | The engine version issuing the definition. | \[optional\]
**wkt** | **str** | The well-known text (Esri style) defining this transformation. |
**authCode** | [**AuthCode**](#AuthCode-v2) | The authority code for this item. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CompoundCT <a name="CompoundCT"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **str** | The source of the CompoundCT. | \[optional\]
**aliasNames** | **list\[str\]** | Alias names for this CompoundCT. | \[optional\]
**description** | **str** | The description of the CompoundCT. | \[optional\]
**fromCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The &#39;from CRS&#39; authority code of this CompoundCT. | \[optional\]
**toCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The &#39;to CRS&#39; authority code of this CompoundCT. | \[optional\]
**lastModified** | **str** | The LastModified of the CompoundCT. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#AreaOfUse-v2) | The Area of Use for this CompoundCT. | \[optional\]
**deprecationInfo** | [**CTDeprecationInfo**](#CTDeprecationInfo) | Only if deprecated - additional information and potentially a recommended replacement CT. | \[optional\]
**namedReference** | [**NamedReference**](#NamedReference) | A structure containing the item Name and the persistable Reference string; populated if the request mode&#x3D;&#39;persistableReference&#39;. | \[optional\]
**essence** | [**CompoundCTEssence**](#CompoundCTEssence) | The Essence of the CompoundCT. | \[optional\]
<details><summary>CompoundCT example</summary>
```
{
"description": "Fallback Coord Op Scope: Recommended for oil industry use in US Gulf of Mexico (GoM). Accuracy at 67% confidence level is 0.15m onshore, 5m nearshore and undetermined farther offshore. | Tfm Accuracy: 5 | Remarks: Transformation taken from NAD27 to NAD83 (1) (code 1241) assuming that NAD83 is equivalent to WGS 84 within the accuracy of this tfm. Uses NADCON method which expects longitudes positive west; EPSG CRS codes 4267 and 4326 have longitudes positive east. | Information Source: OGP/Coord Op Scope: Approximation at the +/- 1m level. | Tfm Accuracy: 1 | Remarks: Parameter file is from NAD27 to NAD83 (4) (code 1313) assuming that NAD83 is equivalent to WGS 84 within the accuracy of the transformation. | Information Source: OGP",
"lastModified": "20180611",
"aliasNames": [],
"namedReference": {
"name": "Fallback NAD27 to WGS 84 (79)/NAD27 to WGS 84 (33)",
"persistableReference": "{\"policy\":\"Fallback\",\"cts\":[{\"wkt\":\"GEOGTRAN[\\\"NAD_1927_To_WGS_1984_79_CONUS\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],GEOGCS[\\\"GCS_WGS_1984\\\",DATUM[\\\"D_WGS_1984\\\",SPHEROID[\\\"WGS_1984\\\",6378137.0,298.257223563]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],METHOD[\\\"NADCON\\\"],PARAMETER[\\\"Dataset_conus\\\",0.0],AUTHORITY[\\\"EPSG\\\",15851]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_To_WGS_1984_79_CONUS\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"15851\"},\"type\":\"ST\"},{\"wkt\":\"GEOGTRAN[\\\"NAD_1927_To_WGS_1984_33\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],GEOGCS[\\\"GCS_WGS_1984\\\",DATUM[\\\"D_WGS_1984\\\",SPHEROID[\\\"WGS_1984\\\",6378137.0,298.257223563]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],METHOD[\\\"NTv2\\\"],PARAMETER[\\\"Dataset_canada/Ntv2_0\\\",0.0],AUTHORITY[\\\"EPSG\\\",1693]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_To_WGS_1984_33\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"1693\"},\"type\":\"ST\"}],\"ver\":\"PE_10_3_1\",\"name\":\"Fallback NAD27 to WGS 84 (79)/NAD27 to WGS 84 (33)\",\"authCode\":{\"auth\":\"SLB\",\"code\":\"158511693\"},\"type\":\"CT\"}"
},
"source": "Ocean catalog",
"essence": {
"authCode": {
"auth": "SLB",
"code": "158511693"
},
"type": "CT",
"ver": "PE_10_3_1",
"name": "Fallback NAD27 to WGS 84 (79)/NAD27 to WGS 84 (33)",
"policy": "Fallback",
"cts": [
{
"authCode": {
"auth": "EPSG",
"code": "15851"
},
"type": "ST",
"ver": "PE_10_3_1",
"name": "NAD_1927_To_WGS_1984_79_CONUS",
"wkt": "GEOGTRAN[\"NAD_1927_To_WGS_1984_79_CONUS\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],METHOD[\"NADCON\"],PARAMETER[\"Dataset_conus\",0.0],AUTHORITY[\"EPSG\",15851]]"
},
{
"authCode": {
"auth": "EPSG",
"code": "1693"
},
"type": "ST",
"ver": "PE_10_3_1",
"name": "NAD_1927_To_WGS_1984_33",
"wkt": "GEOGTRAN[\"NAD_1927_To_WGS_1984_33\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],METHOD[\"NTv2\"],PARAMETER[\"Dataset_canada/Ntv2_0\",0.0],AUTHORITY[\"EPSG\",1693]]"
}
]
},
"toCRSAuthorityCode": {
"auth": "EPSG",
"code": "4326"
},
"fromCRSAuthorityCode": {
"auth": "EPSG",
"code": "4267"
},
"areaOfUse": {
"description": "Intersection of USA - CONUS including EEZ [2374] and Canada - NAD27 [4517]",
"lastModified": "20180611",
"aliasNames": [],
"namedReference": null,
"name": "USA - CONUS including EEZ + Canada - NAD27",
"deprecationInfo": null,
"essence": {
"name": null,
"authCode": {
"auth": "SLB",
"code": "23744517"
},
"type": "AOU",
"boundBox": {
"lonMin": -129.17,
"latMin": 23.81,
"lonMax": -65.69,
"latMax": 86.46
}
}
},
"deprecationInfo": null
}
```
</details>
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CompoundCTEssence <a name="CompoundCTEssence"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier, fixed to &#39;CT&#39;. | \[default to 'CT'\]
**name** | **str** | The name of the compound cartographic transformation. |
**ver** | **str** | The engine version issuing the definition. | \[optional\]
**policy** | **str** | The transformation policy - concatenated or fallback. |
**cts** | [**list\[SingleCTEssence\]**](#SingleCTEssence) | The ordered list of cartographic transformations. |
**authCode** | [**AuthCode**](#AuthCode) | The authority code for this item. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CRS (generic) <a name="CRS"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**essence** | [**AnyCRSEssence**](#AnyCRSEssence) | The CRS&#39;s essence either a LateBoundCRSEssence, EarlyBoundCRSEssence or CompoundCRSEssence. | \[optional\]
**crsType** | **str** | The type of ths CRS. | \[optional\]
**source** | **str** | The source of ths CRS. | \[optional\]
**transformation_ready** | **bool** | The Transformation readiness of this CRS. | \[optional\]
**baseCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The base authority code of this CRS. | \[optional\]
**aliasNames** | **list\[str\]** | Alias names for this CRS. | \[optional\]
**axisUnits** | **list\[str\]** | Axis Unit Essences. | \[optional\]
**numberOfAxes** | **int** | The NumberOfAxes of this CRS. | \[optional\]
**description** | **str** | The description of this CRS. | \[optional\]
**lastModified** | **str** | The LastModified of this CRS. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#AreaOfUse-v2) | The Area of Use for this CRS. | \[optional\]
**deprecation_info** | [**CRSDeprecationInfo**](#CRSDeprecationInfo) | Only if deprecated - additional information and potentially a recommended replacement CRS. | \[optional\]
**namedReference** | [**NamedReference**](#NamedReference) | A structure containing the item Name and the persistable Reference string; populated if the request mode&#x3D;&#39;persistable_reference&#39;. | \[optional\]
#### AnyCRSEssence <a name="AnyCRSEssence"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier. |
**name** | **str** | The name of the coordinate reference system. |
**ver** | **str** | The engine version issuing the definition. | \[optional\]
**wkt** | **str** | Well-known text (Esri style) of the late-bound coordinate reference system. | \[optional\]
**lateBoundCRS** | [**LateBoundCRSEssence**](#LateBoundCRSEssence) | Late-bound CRS, which is bound to a single (st) or compound (ct) transformation to WGS 84. | \[optional\]
**singleCT** | [**SingleCTEssence**](#SingleCTEssence) | Single Transformation, which binds the late-bound CRS (lb) to WGS 84. If absent, a compound transformation (ct) must be present. | \[optional\]
**compoundCT** | [**CompoundCTEssence**](#CompoundCTEssence) | Compound transformation, which binds the late-bound CRS (lb) to WGS 84. If absent, a single transformation (st) must be present. | \[optional\]
**horzLateBoundCRS** | [**LateBoundCRSEssence**](#LateBoundCRSEssence) | The horizontal CRS of a Compound CRS as late-bound CRS. If &#39;horzLateBoundCRS&#39; is non-null, &#39;horzEarlyBoundCRS&#39; must be null. | \[optional\]
**horzEarlyBoundCRS** | [**EarlyBoundCRSEssence**](#EarlyBoundCRSEssence) | The horizontal CRS of a Compound CRS as early-bound CRS. If &#39;horzEarlyBoundCRS&#39; is non-null, &#39;horzLateBoundCRS&#39; must be null. | \[optional\]
**vertLateBoundCRS** | [**LateBoundCRSEssence**](#LateBoundCRSEssence) | The vertical CRS of the Compound CRS as late-bound CRS. If &#39;vertLateBoundCRS&#39; is non-null, &#39;vertEarlyBoundCRS&#39; must be null. | \[optional\]
**vertEarlyBoundCRS** | [**EarlyBoundCRSEssence**](#EarlyBoundCRSEssence) | The vertical CRS of the Compound CRS as early-bound CRS. If &#39;vertEarlyBoundCRS&#39; is non-null, &#39;vertLateBoundCRS&#39; must be null. | \[optional\]
**authCode** | [**AuthCode**](#AuthCode) | The authority code for this item. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CT (generic) <a name="CT"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **str** | The source of the cartographic transformation. | \[optional\]
**aliasNames** | **list[str]** | Alias names for this cartographic transformation. | \[optional\]
**description** | **str** | The description of the cartographic transformation. | \[optional\]
**fromCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The &#39;from CRS&#39; authority code of this cartographic transformation. | \[optional\]
**toCRSAuthorityCode** | [**AuthCode**](#AuthCode) | The &#39;to CRS&#39; authority code of this cartographic transformation. | \[optional\]
**lastModified** | **str** | The LastModified of the cartographic transformation. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#AreaOfUse-v2) | The Area of Use for this cartographic transformation. | \[optional\]
**deprecationInfo** | [**CTDeprecationInfo**](#CTDeprecationInfo) | Only if deprecated - additional information and potentially a recommended replacement cartographic transformation. | \[optional\]
**namedReference** | [**NamedReference**](#NamedReference) | A structure containing the item Name and the persistable Reference string; populated if the request mode&#x3D;&#39;persistable_reference&#39;. | \[optional\]
**essence** | [**AnyCTEssence**](#AnyCTEssence) | The Essence of the cartographic transformation. | \[optional\]
#### AnyCTEssence <a name="AnyCTEssence"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier, either &#39;ST&#39; or &#39;CT&#39;. |
**name** | **str** | The name of the simple cartographic transformation. |
**ver** | **str** | The engine version issuing the definition. | \[optional\]
**wkt** | **str** | The well-known text (Esri style) defining this transformation. | \[optional\]
**policy** | **str** | The transformation policy - concatenated or fallback. | \[optional\]
**cts** | [**list\[SingleCTEssence\]**](#SingleCTEssence) | The ordered list of cartographic transformations. | \[optional\]
**authCode** | [**AuthCode**](#AuthCode) | The authority code for this item. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### AreaOfUse <a name="AreaOfUse-v2"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The Internal Id of the AreaOfUse. | \[optional\]
**name** | **str** | The name of the AreaOfUse. | \[optional\]
**description** | **str** | The description of the AreaOfUse. | \[optional\]
**lastModified** | **str** | The LastModified of the AreaOfUse. | \[optional\]
**namedReference** | [**NamedReference**](#NamedReference) | A structure containing the item Name and the persistable Reference string; populated if the request mode&#x3D;&#39;persistableReference&#39;. | \[optional\]
**essence** | [**AreaOfUseEssence**](#AreaOfUseEssence-v2) | The Essence of the AreaOfUse. | \[optional\]
<details><summary>AreaOfUse example</summary>
```
{
"description": "United States (USA) - CONUS including EEZ -onshore and offshore - Alabama; Arizona; Arkansas; California; Colorado; Connecticut; Delaware; Florida; Georgia; Idaho; Illinois; Indiana; Iowa; Kansas; Kentucky; Louisiana; Maine; Maryland; Massachusetts; Michigan; Minnesota; Mississippi; Missouri; Montana; Nebraska; Nevada; New Hampshire; New Jersey; New Mexico; New York; North Carolina; North Dakota; Ohio; Oklahoma; Oregon; Pennsylvania; Rhode Island; South Carolina; South Dakota; Tennessee; Texas; Utah; Vermont; Virginia; Washington; West Virginia; Wisconsin; Wyoming. US Gulf of Mexico (GoM) OCS.",
"lastModified": "20140501",
"aliasNames": [],
"namedReference": {
"name": "USA - CONUS including EEZ",
"persistableReference": "{\"boundBox\":{\"lonMin\":-129.17,\"latMin\":23.81,\"lonMax\":-65.69,\"latMax\":49.38},\"authCode\":{\"auth\":\"EPSG\",\"code\":\"2374\"},\"type\":\"AOU\"}"
},
"name": "USA - CONUS including EEZ",
"deprecationInfo": null,
"essence": {
"name": null,
"authCode": {
"auth": "EPSG",
"code": "2374"
},
"type": "AOU",
"boundBox": {
"lonMin": -129.17,
"latMin": 23.81,
"lonMax": -65.69,
"latMax": 49.38
}
}
}
```
</details>
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### AreaOfUseEssence <a name="AreaOfUseEssence-v2"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier, fixed to &#39;AOU&#39;. | \[default to 'AOU'\]
**boundBox** | [**BoundBox**](#BoundBox) | The bounding box in latitude and longitude WGS 84 based. |
**authCode** | [**AuthCode**](#AuthCode) | The authority code for this item. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### BoundBox <a name="BoundBox"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**lon_min** | **float** | The left longitude limit in degrees; the longitude can wrap around the datum line. |
**lon_max** | **float** | The right longitude limit in degrees; the longitude can wrap around the datum line. |
**lat_min** | **float** | The upper latitude limit in degrees. |
**lat_max** | **float** | The lower latitude limit in degrees. |
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### AuthCode <a name="AuthCode"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auth** | **str** | The name of the authority issuing the code. Usually a string but it can be NULL for transient items. | \[default to 'NULL'\]
**code** | **str** | The code issued by the authority. Usually a number but it can be NULL for transient items. | \[default to 'NULL'\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### NamedReference <a name="NamedReference"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the item. | \[optional\]
**persistableReference** | **str** | The item &#39;essence&#39; serialized into a JSON string. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CTDeprecationInfo <a name="CTDeprecationInfo"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecationState** | **str** | State - one of {identical, corrected, unresolved} | \[optional\]
**remarks** | **str** | Further explanation of the deprecation. | \[optional\]
**supersededByCT** | **str** | The cartographic transform to be used instead - if any is recommended. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CRSDeprecationInfo <a name="CRSDeprecationInfo"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecationState** | **str** | State - one of {identical, corrected, unresolved} | \[optional\]
**remarks** | **str** | Further explanation of the deprecation. | \[optional\]
**supersededByCRS** | **str** | The coordinate reference system to be used instead - if any is recommended. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### AreaOfUseDeprecationInfo <a name="AreaOfUseDeprecationInfo-v2"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecation_state** | **str** | State - one of {identical, corrected, unresolved} | \[optional\]
**remarks** | **str** | Further explanation of the deprecation. | \[optional\]
**supersededByAou** | **str** | The AreaOfUse Id to be used instead - if any is recommended. | \[optional\]
### Request Types <a name="request-types-v2"></a>
#### LateBoundCRSRequest <a name="LateBoundCRSRequest"></a>
##### Properties
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistableReference** | **str** | The persistable reference string, either the essence of the LateBoundCRS serialized into a JSON string or an encoded string (version 1). | \[optional\]
**essence** | [**LateBoundCRSEssence**](#LateBoundCRSEssence) | The essence for the LateBoundCRS. Either the essence or persistableReference must be non-null. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### EarlyBoundCRSRequest <a name="EarlyBoundCRSRequest"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistableReference** | **str** | The persistable reference string, either the essence of the EarlyBoundCRS serialized into a JSON string or an encoded string (version 1). | \[optional\]
**essence** | [**EarlyBoundCRSEssence**](#EarlyBoundCRSEssence) | The essence for the EarlyBoundCRS. Either the essence or persistableReference must be non-null. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CompoundCRSRequest <a name="CompoundCRSRequest"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistableReference** | **str** | The persistable reference string, either the essence of the CompoundCRS serialized into a JSON string or an encoded string (version 1). | \[optional\]
**essence** | [**CompoundCRSEssence**](#CompoundCRSEssence) | The essence for the CompoundCRS. Either the essence or persistableReference must be non-null. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CRSRequest <a name="CRSRequest"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistableReference** | **str** | The persistable reference string, either the essence of the CRS serialized into a JSON string or an encoded string (version 1). | \[optional\]
**essence** | [**AnyCRSEssence**](#AnyCRSEssence) | The essence Json for the CRS. Either the essence or persistableReference must be non-null. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### SingleCTRequest <a name="SingleCTRequest"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistableReference** | **str** | The persistable reference string, either the essence of the SingleCT serialized into a JSON string or an encoded string (version 1). | \[optional\]
**essence** | [**SingleCTEssence**](#SingleCTEssence) | The essence for the SingleCT. Either the essence or persistableReference must be non-null. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CompoundCTRequest <a name="CompoundCTRequest"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistableReference** | **str** | The persistable reference string, either the essence of the CompoundCT serialized into a JSON string or an encoded string (version 1). | \[optional\]
**essence** | [**CompoundCTEssence**](#CompoundCTEssence) | The essence for the CompoundCT. Either the essence or persistableReference must be non-null. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CTRequest <a name="CTRequest"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistableReference** | **str** | The persistable reference string, either the essence of the cartographic transform (CT) serialized into a JSON string or an encoded string (version 1). | \[optional\]
**essence** | [**AnyCTEssence**](#AnyCTEssence) | The essence Json for the CT. Either the essence or persistableReference must be non-null. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### AreaOfUseRequest <a name="AreaOfUseRequest"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistableReference** | **str** | The persistable reference string, either the essence of the AreaOfUse serialized into a JSON string or an encoded string (version 1). | \[optional\]
**essence** | [**AreaOfUseEssence**](#AreaOfUseEssence-v2) | Area of use essence. Either the essence or persistableReference must be non-null. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
### Response Types <a name="response-types-v2"></a>
#### AreaOfUseResults <a name="AreaOfUseResults"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**areasOfUse** | [**list\[AreaOfUse\]**](#AreaOfUse-v2) | An array of AreaOfUse | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### LateBoundCRSResults <a name="LateBoundCRSResults"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**crses** | [**list\[LateBoundCRS\]**](#LateBoundCRS) | An array of LateBoundCRS | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### EarlyBoundCRSResults <a name="EarlyBoundCRSResults"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**crses** | [**list\[EarlyBoundCRS\]**](#EarlyBoundCRS) | An array of EarlyBoundCRS | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CompoundCRSResults <a name="CompoundCRSResults"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**crses** | [**list\[CompoundCRS\]**](#CompoundCRS) | An array of CompoundCRS | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CRSResults <a name="CRSResults"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**crses** | [**list\[CRS\]**](#CRS) | An array of (any sub-type of) CRS | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### SingleCTResults <a name="SingleCTResults"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cts** | [**list\[SingleCT\]**](#SingleCT) | An array of SingleCTs | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CompoundCTResults <a name="CompoundCTResults"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cts** | [**list\[CompoundCT\]**](#CompoundCT) | An array of CompoundCTs | \[optional\]
**count** | **int** | Number of items returned in this response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Total number of items in the catalog. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
#### CTResults <a name="CTResults"></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cts** | [**list\[CT\]**](#CT) | An array of (any sub-type of) cartographic transforms | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to API Data Structures](#response-data-structures-v2) - [Back to table of contents](#TOC)
## Legacy API (Version 1) <a name="legacy-api-v1"></a>
Further sections:
* [API Transition V1 to V2](#transition-v1-to-v2)
* [API Data Structures (V1)](#response-data-structures-v1)
* [Catalog Item Types V1](#catalog-item-types-v1)
* [Response Types V1](#response-types-v1)
Method|Try it out (in new window)|Response Type
------|--------------------------|-------------
|***Coordinate Reference System API V1***|
`GET /api/v1/coordinateReferenceSystem`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetallcoordinatereferencesystems" target="_blank">Try it out: crsgetallcoordinatereferencesystems</a>|[CoordinateReferenceSystemResults](#coordinatereferencesystemresults)
`GET /api/v1/coordinateReferenceSystem/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcoordinatereferencesystem" target="_blank">Try it out: crsgetcoordinatereferencesystem</a>|[CoordinateReferenceSystem](#coordinateseferencesystem)
`GET /api/v1/lateBoundCoordinateReferenceSystem`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetlateboundcoordinatereferencesystems" target="_blank">Try it out: crsgetlateboundcoordinatereferencesystems</a>|[LateBoundCoordinateReferenceSystemResults](#lateboundcoordinatereferencesystemresults)
`GET /api/v1/lateBoundCoordinateReferenceSystem/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetlateboundcoordinatereferencesystem" target="_blank">Try it out: crsgetlateboundcoordinatereferencesystem</a>|[LateBoundCoordinateReferenceSystem](#lateboundcoordinatereferencesystem)
`GET /api/v1/earlyBoundCoordinateReferenceSystem`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetearlyboundcoordinatereferencesystems" target="_blank">Try it out: crsgetearlyboundcoordinatereferencesystems</a>|[EarlyBoundCoordinateReferenceSystemResults](#earlyboundcoordinatereferencesystemresults)
`GET /api/v1/earlyBoundCoordinateReferenceSystem/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetearlyboundcoordinatereferencesystem" target="_blank">Try it out: crsgetearlyboundcoordinatereferencesystem</a>|[EarlyBoundCoordinateReferenceSystem](#earlyboundcoordinatereferencesystem)
`GET /api/v1/compoundCoordinateReferenceSystem`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcompoundcoordinatereferencesystems" target="_blank">Try it out: crsgetcompoundcoordinatereferencesystems</a>|[CompoundCoordinateReferenceSystemResults](#compoundcoordinatereferencesystemresults)
`GET /api/v1/compoundCoordinateReferenceSystem/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcompoundcoordinatereferencesystem" target="_blank">Try it out: crsgetcompoundcoordinatereferencesystem</a>|[CompoundCoordinateReferenceSystem](#compoundcoordinatereferencesystem)
`GET /api/v1/coordinateReferenceSystem/search`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crssearchcoordinatereferencesystems" target="_blank">Try it out: crssearchcoordinatereferencesystems</a>, [search keywords](#crs-search-keywords-v1)|[CoordinateReferenceSystemResults](#coordinatereferencesystemresults)
|***Cartographic Transformations API V1***|
`GET /api/v1/cartographicTransform`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetallcartographictransforms" target="_blank">Try it out: crsgetallcartographictransforms</a>|[CartographicTransformResults](#cartographictransformresults)
`GET /api/v1/cartographicTransform/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcartographictransform" target="_blank">Try it out: crsgetcartographictransform</a>|[CartographicTransform](#cartographictransform)
`GET /api/v1/singleCartographicTransform`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetsinglecartographictransforms" target="_blank">Try it out: crsgetsinglecartographictransforms</a>|[SingleCartographicTransformResults](#singlecartographictransformresults)
`GET /api/v1/singleCartographicTransform/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetsinglecartographictransform" target="_blank">Try it out: crsgetsinglecartographictransform</a>|[SingleCartographicTransform](#singlecartographictransform)
`GET /api/v1/compoundCartographicTransform`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcompoundcartographictransforms" target="_blank">Try it out: crsgetcompoundcartographictransforms</a>|[CompoundCartographicTransformResults](#compoundcartographictransformresults)
`GET /api/v1/compoundCartographicTransform/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcompoundcartographictransform" target="_blank">Try it out: crsgetcompoundcartographictransform</a>|[CompoundCartographicTransform](#compoundcartographictransform)
`GET /api/v1/cartographicTransform/search`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crssearchcartographictransforms" target="_blank">Try it out: crssearchcartographictransforms</a>, [search keywords](#ct-search-keywords-v1)|[CartographicTransformResults](#cartographictransformresults)
|***Area of Use API V1***|
`GET /api/v1/areaOfUse`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetareasofuse" target="_blank">Try it out: crsgetareasofuse</a>|[AreaOfUseResults](#areaofuseresults)
`GET /api/v1/areaOfUse/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetareaofuse" target="_blank">Try it out: crsgetareaofuse</a>|[AreaOfUse](#areaofuse)
`GET /api/v1/areaOfUse/search`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crssearchareasofuse" target="_blank">Try it out: crssearchareasofuse</a>, [search keywords](#area-search-keywords)|[AreaOfUseResults](#areaofuseresults)
[Back to Legacy API V1](#legacy-api-v1) [Back to table of contents](#TOC)
#### CRS search keywords, deprecated version V1 <a name="crs-search-keywords-v1"></a>
The following table lists the keyword codes for the Lucene style query elements.
Keyword code|Constrain by|Values in use or example
------------|------------|-------------
`name:`|specific words/sub-strings in the name| Example: `name:*ED50*`
`description:`|specific sub-strings in the description|
`type:`| Type code for the CRS | `type:LBCRS` (late-bound or un-bound CRS), `type:EBCRS` (early-bound CRS), `type:CCRS` (compound CRS)
`authority:`|Authority|Example: `authority:EPSG`
`code:`|Authority code number|Example: `code:4326`
`deprecationState:`|State of deprecation | `deprecationState:identical` (can be swapped) or `deprecationState:corrected` non-trivial deprecation
`remarks:`|specific sub-strings in the deprecation remarks| Example: `remarks:Deprecated`
`lastModified:`|specific last modification dates| Example: `lastModified:20070827`
`source:`|CRS source|Example: `source:OGP`
`wellKnownText:`|specific words/sub-strings in the well-known text (late-bound or un-bound CRSs only)|Example: `wellKnownText:*Clarke_1880_RGS*`
`crsType:`|Coordinate Reference System (CRS) type|Example: `crsType:"Compound Projected"`
`basCrs.authority:`|projected CRS's base CRS authority|Example: `baseCrs.authority:EPSG`
`baseCrs.code:`|projected CRS's base CRS authority code|Example: `baseCrs.code:4267` (NAD27)
`horizontalCrs.authority:`|compound CRS's horizontal CRS authority|Example: `horizontalCrs.authority:EPSG`
`horizontalCrs.code:`|compound CRS's horizontal CRS authority code|Example: `horizontalCrs.code:32615`
`verticalCrs.authority:`|compound CRS's vertical CRS authority|Example: `verticalCrs.authority:EPSG`
`verticalCrs.code:`|compound CRS's vertical CRS authority code|Example: `verticalCrs.code:5773`
`lateBoundCrs.authority:`|early-bound CRS's (late-bound) CRS authority|Example: `lateBoundCrs.authority:EPSG`
`lateBoundCrs.code:`|early-bound CRS's (late-bound) CRS authority code|Example: `lateBoundCrs.code:23031`
`trf.authority:`|early-bound CRS's cartographic transform authority|Example: `trf.authority:EPSG`
`trf.code:`|early-bound CRS's cartographic transform authority code|Example: `trf.code:1612`
`transformationReady:`|CRS's transformation readiness, i.e. is the CRS ready to be used in datum transformations (true or false)|`transformationReady:true` or `transformationReady:false`
[Back to Legacy API V1](#legacy-api-v1) [Back to table of contents](#TOC)
#### CT search keywords, deprecated version V1 <a name="ct-search-keywords-v1"></a>
The following table lists the keyword codes for the Lucene style query elements.
Keyword code|Constrain by|Values in use or example
------------|------------|-------------
`name:`|specific words/sub-strings in the name| Example: `name:*NAD_1927*`
`description:`|specific sub-strings in the description|
`type:`|Type code for the Cartographic Transform (CT) | `type:ST` (single CT), `type:CT` (compound CT)
`authority:`|Authority|Example: `authority:EPSG`
`code:`|Authority code number|Example: `code:15851`
`deprecationState:`|State of deprecation | `deprecationState:identical` (can be swapped) or `deprecationState:corrected` non-trivial deprecation
`remarks:`|specific sub-strings in the deprecation remarks| Example: `remarks:*PE_10_1_0*`
`lastModified:`|specific last modification dates| Example: `lastModified:20180611`
`source:`|CT source|Example: `source:OGP`
`wellKnownText:`|specific words/sub-strings in the well-known text (late-bound or un-bound CRSs only)|Example: `wellKnownText:*Dataset_conus*`
`fromCrs.authority:`|source CRS authority|`fromCrs.authority:EPSG`
`fromCrs.code:`|source CRS code|`fromCrs.code:4267`
`toCrs.authority:`|target CRS authority|`toCrs.authority:EPSG`
`toCrs.code:`|target CRS code|`toCrs.code:4328`
`policy:`|compound transformation policy|`policy:fallback` or `policy:concatenated`
[Back to Legacy API V1](#legacy-api-v1) [Back to table of contents](#TOC)
## Transition from deprecated Version 1 to current version (V2) APIs <a name="transition-v1-to-v2"></a>
The following table provides the aid to transition. The links open the 'Try it out' in a new window.
V1 Method|V1 'Try it out' Link|V2 Method|V2 'Try it out' Link|Notes
---------|-------|--------|-------|-----
`GET /api/v1/catalog`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcatalog" target="_blank">crsgetcatalog</a>|`GET /api/v2/catalog`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-catalog-summary" target="_blank">get-catalog-summary</a>|The V2 catalog response does not populate the arrays of catalog items. Use the V2 GET requests to populate the catalog item arrays. The V1 allCoordinateReferenceSystems ai achieved by combining V2 lateBoundCRSes, earlyBoundCRSes and compoundCRSes. The V1 allCartographicTransforms is achieved by combining the V2 singleCTs and compoundCTs.
`GET /api/v1/catalog/attributes`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcatalogattributes" target="_blank">crsgetcatalogattributes</a>|`GET /api/v2/catalog/attributes`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-catalog-attributes" target="_blank">get-catalog-attributes</a>|
`GET /api/v1/coordinateReferenceSystem`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetallcoordinatereferencesystems" target="_blank">crsgetallcoordinatereferencesystems</a>|`GET /api/v2/crs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-crs" target="_blank">get-all-crs</a>|
`GET /api/v1/lateBoundCoordinateReferenceSystem`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetlateboundcoordinatereferencesystems" target="_blank">crsgetlateboundcoordinatereferencesystems</a>|`GET /api/v2/lateboundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-lateboundcrs" target="_blank">get-all-lateboundcrs</a>|
`GET /api/v1/earlyBoundCoordinateReferenceSystem`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetearlyboundcoordinatereferencesystems" target="_blank">crsgetearlyboundcoordinatereferencesystems</a>|`GET /api/v2/earlyboundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-earlyboundcrs" target="_blank">get-all-earlyboundcrs</a>|
`GET /api/v1/compoundCoordinateReferenceSystem`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcompoundcoordinatereferencesystems" target="_blank">crsgetcompoundcoordinatereferencesystems</a>|`GET /api/v2/compoundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-compoundcrs" target="_blank">get-all-compoundcrs</a>|
`GET /api/v1/coordinateReferenceSystem/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcoordinatereferencesystem" target="_blank">crsgetcoordinatereferencesystem</a>|`POST /api/v2/crs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-crs" target="_blank">get-one-crs</a>|The persistableReference string {pr} moves into the request body.
`GET /api/v1/lateBoundCoordinateReferenceSystem/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetlateboundcoordinatereferencesystem" target="_blank">crsgetlateboundcoordinatereferencesystem</a>|`POST /api/v2/lateboundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-lateboundcrs" target="_blank">get-one-lateboundcrs</a>|The persistableReference string {pr} moves into the request body.
`GET /api/v1/earlyBoundCoordinateReferenceSystem/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetearlyboundcoordinatereferencesystem" target="_blank">crsgetearlyboundcoordinatereferencesystem</a>|`POST /api/v2/earlyboundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-earlyboundcrs" target="_blank">get-one-earlyboundcrs</a>|The persistableReference string {pr} moves into the request body.
`GET /api/v1/compoundCoordinateReferenceSystem/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcompoundcoordinatereferencesystem" target="_blank">crsgetcompoundcoordinatereferencesystem</a>|`POST /api/v2/compoundcrs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-compoundcrs" target="_blank">get-one-compoundcrs</a>|The persistableReference string {pr} moves into the request body.
`GET /api/v1/coordinateReferenceSystem/search`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crssearchcoordinatereferencesystems" target="_blank">crssearchcoordinatereferencesystems</a>|`POST /api/v2/search/crs`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/search-crs" target="_blank">search-crs</a>|The keyword query moves to the request body; the optional query constraints stay in in int url path.
`GET /api/v1/cartographicTransform`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetallcartographictransforms" target="_blank">crsgetallcartographictransforms</a>|`GET /api/v2/ct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-ct" target="_blank">get-all-ct</a>|
`GET /api/v1/singleCartographicTransform`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetsinglecartographictransforms" target="_blank">crsgetsinglecartographictransforms</a>|`GET /api/v2/singlect`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-singlect" target="_blank">get-all-singlect</a>|
`GET /api/v1/compoundCartographicTransform`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcompoundcartographictransforms" target="_blank">crsgetcompoundcartographictransforms</a>|`GET /api/v2/compoundct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-compoundct" target="_blank">get-all-compoundct</a>|
`GET /api/v1/cartographicTransform/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcartographictransform" target="_blank">crsgetcartographictransform</a>|`POST /api/v2/ct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-ct" target="_blank">get-one-ct</a>|The persistableReference string {pr} moves into the request body.
`GET /api/v1/singleCartographicTransform/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetsinglecartographictransform" target="_blank">crsgetsinglecartographictransform</a>|`POST /api/v2/singlect`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-singlect" target="_blank">get-one-singlect</a>|The persistableReference string {pr} moves into the request body.
`GET /api/v1/compoundCartographicTransform/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetcompoundcartographictransform" target="_blank">crsgetcompoundcartographictransform</a>|`POST /api/v2/compoundct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-compoundct" target="_blank">get-one-compoundct</a>|The persistableReference string {pr} moves into the request body.
`GET /api/v1/cartographicTransform/search`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crssearchcartographictransforms" target="_blank">crssearchcartographictransforms</a>|`POST /api/v2/search/ct`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/search-ct" target="_blank">search-ct</a>|The keyword query moves to the request body; the optional query constraints stay in in int url path.
`GET /api/v1/areaOfUse`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetareasofuse" target="_blank">crsgetareasofuse</a>|`GET /api/v2/area`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-all-areas-use" target="_blank">get-all-areas-use</a>|
`GET /api/v1/areaOfUse/reference/{pr}`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crsgetareaofuse" target="_blank">crsgetareaofuse</a>|`POST /api/v2/area`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/get-one-area-use" target="_blank">get-one-area-use</a>|The persistableReference string {pr} moves into the request body.
`GET /api/v1/areaOfUse/search`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service/crssearchareasofuse" target="_blank">crssearchareasofuse</a>|`POST /api/v2/search/area`|<a href="/solutions/dataecosystem/apis/p4d-data-ecosystem-crs-catalog-service-v2/search-area-use" target="_blank">search-area-use</a>|The keyword query moves to the request body; the optional query constraints stay in in int url path.
[Back to Legacy API V1](#legacy-api-v1) [Back to table of contents](#TOC)
## API Data Structures (Version 1) <a name="response-data-structures-v1" ></a>
* [Catalog Item Types V1](#catalog-item-types-v1)
* [Response Types V1](#response-types-v1)
### Catalog Item Types V1 <a name="catalog-item-types-v1"></a>
#### Catalog V1 <a name="catalog-v1" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allCartographicTransforms** | [**list\[CartographicTransform\]**](#cartographictransform) | The complete list of cartographic transforms. | \[optional\]
**allCoordinateReferenceSystems** | [**list\[CoordinateReferenceSystem\]**](#coordinatereferencesystem) | The complete list of coordinate reference systems. | \[optional\]
**areasOfUse** | [**list\[AreaOfUse\]**](#areaofuse) | The complete list of areas of use. | \[optional\]
**attributes** | [**CatalogAttributes**](#catalogattributes-v1) | The name and last modification time of the catalog. | \[optional\]
**compoundCartographicTransforms** | [**list\[CompoundCartographicTransform\]**](#compoundcartographictransform) | The complete list of compound cartographic transforms | \[optional\]
**compoundCoordinateReferenceSystems** | [**list\[CompoundCoordinateReferenceSystem\]**](#compoundcoordinatereferencesystem) | The complete list of compound coordinate reference systems. | \[optional\]
**earlyBoundCoordinateReferenceSystems** | [**list\[EarlyBoundCoordinateReferenceSystem\]**](#earlyboundcoordinatereferencesystem) | The complete list of early-bound coordinate reference systems. | \[optional\]
**lateBoundCoordinateReferenceSystems** | [**list\[LateBoundCoordinateReferenceSystem\]**](#lateboundcoordinatereferencesystem) | The complete list of late-bound coordinate reference systems. | \[optional\]
**singleCartographicTransforms** | [**list\[SingleCartographicTransform\]**](#singlecartographictransform) | The complete list of single cartographic transforms | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CatalogAttributes V1 <a name="catalogattributes-v1" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | \[optional\]
**lastModified** | **str** | The last modification date and time (UTC) of this catalog. | \[optional\]
**name** | **str** | Name of the catalog | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CartographicTransform V1 <a name="cartographictransform" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aliasNames** | **list\[str\]** | Array of alternative names - used by search. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#areaofuse) | The intended area of use for this cartographic transform. | \[optional\]
**deprecationInfo** | [**TrfDeprecationInfo**](#trfdeprecationinfo) | Only if deprecated - additional information and potentially a recommended replacement transform. | \[optional\]
**description** | **str** | A text further describing this cartographic transform. | \[optional\]
**essence** | [**CartographicTransformEssence**](#cartographictransformessence) | The essence of this CartographicTransform | \[optional\]
**fromCrsAuthorityCode** | [**AuthorityCode**](#authorityCode) | The AuthorityCode of the &#39;from&#39; coordinate reference system. | \[optional\]
**lastModified** | **str** | The last modification date of this item (YYYYMMDD). | \[optional\]
**source** | **str** | Description of the source of this item. | \[optional\]
**toCrsAuthorityCode** | [**AuthorityCode**](#authorityCode) | The AuthorityCode of the &#39;to&#39; coordinate reference system. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CartographicTransformEssence V1 <a name="cartographictransformessence" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of this cartographic transform. | \[optional\]
**engineVersion** | **str** | Spatial engine type and version, which issued the spatial definitions. | \[optional\]
**name** | **str** | Name of this cartographic transform | \[optional\]
**persistableReference** | **str** | The persistable reference string containing the full parameterization of the cartographic transform. | \[optional\]
**type** | **str** | The item type code (STRF for single TRFs or CTRF for compound TRFs) |
**wellKnownText** | **str** | The well-known text representation for the cartographic transform. Only populated for single cartographic transforms (type&#x3D;STRF). | \[optional\]
**policy** | **str** | The policy describing how the list of transforms is to be processed. Only populated for compound TRFs (type&#x3D;CTRF). | \[optional\]
**trfAuthorityCodes** | [**list\[AuthorityCode\]**](#authoritycode) | The ordered list of AuthorityCode representing the compound CartographicTransformations. Only populated for compound TRFs (type&#x3D;CTRF). | \[optional\]
**trfReferences** | **list\[str\]** | The ordered list of persistable references. Only populated for compound TRFs (type&#x3D;CTRF). | \[optional\]
**trfs** | [**list\[CartographicTransform\]**](#cartographictransform) | The ordered list of CartographicTransform. Only populated for compound TRFs (type&#x3D;CTRF). | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CompoundCartographicTransform V1 <a name="compoundcartographictransform" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aliasNames** | **list\[str\]** | Array of alternative names - used by search. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#areaofuse) | The intended area of use for this compound transform. | \[optional\]
**essence** | [**CompoundCartographicTransformEssence**](#compoundcartographictransformessence) | The essence of this CompoundCartographicTransform | \[optional\]
**deprecationInfo** | [**TrfDeprecationInfo**](#trfdeprecationinfo) | Only if deprecated - additional information and potentially a recommended replacement transform. | \[optional\]
**description** | **str** | A text further describing this compound transform. | \[optional\]
**fromCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the &#39;from&#39; coordinate reference system. | \[optional\]
**lastModified** | **str** | The last modification date of this item (YYYYMMDD). | \[optional\]
**source** | **str** | Description of the source of this item. | \[optional\]
**toCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the &#39;to&#39; coordinate reference system. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CompoundCartographicTransformEssence V1 <a name="compoundcartographictransformessence" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the compound cartographic transform. | \[optional\]
**engineVersion** | **str** | Spatial engine type and version, which issued the spatial definitions. | \[optional\]
**name** | **str** | Name of the compound cartographic transform. | \[optional\]
**persistableReference** | **str** | The persistable references string containing the full description. | \[optional\]
**policy** | **str** | The policy describing how the list of transforms is to be processed - &#39;Fallback&#39;: trying the ordered list of transforms until a point is successfully transformed; &#39;Concatenated&#39;: apply the transformations in a chain connecting input/output. | \[optional\]
**trfAuthorityCodes** | [**list\[AuthorityCode\]**](#authoritycode) | The ordered list of AuthorityCode representing the CartographicTransformations. | \[optional\]
**trfReferences** | **list\[str\]** | The ordered list of persistable references. | \[optional\]
**trfs** | [**list\[CartographicTransform\]**](#cartographictransform) | The ordered list of CartographicTransform. | \[optional\]
**type** | **str** | The item type code | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CompoundCoordinateReferenceSystem V1 <a name="compoundcoordinatereferencesystem" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aliasNames** | **list\[str\]** | An array of alternative names - used by search. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#areaofuse) | The intended area of use for this compound CRS. | \[optional\]
**axisUnits** | **list\[str\]** | The array of persistable unit references describing the axes of this compound CRS | \[optional\]
**baseCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | Used only for a projected horizontal CRS: the base geographic CRS AuthorityCode. | \[optional\]
**essence** | [**CompoundCoordinateReferenceSystemEssence**](#compoundcoordinatereferencesystemessence) | The essence of this compound CRS | \[optional\]
**crsType** | **str** | The type of CRS, one of {Compound Projected Vertical, Compound Geographic2D Vertical} | \[optional\]
**deprecationInfo** | [**CrsDeprecationInfo**](#crsdeprecationinfo) | Only if deprecated - additional information and potentially a recommended replacement CRS. | \[optional\]
**description** | **str** | A text further describing the early-bound CRS. | \[optional\]
**lastModified** | **str** | The last modification date of this item (YYYYMMDD). | \[optional\]
**numberOfAxes** | **int** | The number of axes (dimension) of this CRS. | \[optional\]
**source** | **str** | Description of the source of this item. | \[optional\]
**transformationReady** | **bool** | True if the components are either based on WGS 84/Mean Sea Level or associated with a cartographic transform to WGS 84/Mean Sea Level; else false. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CompoundCoordinateReferenceSystemEssence V1 <a name="compoundcoordinatereferencesystemessence" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of this compound CRS. | \[optional\]
**engineVersion** | **str** | Spatial engine type and version, which issued the spatial definitions. | \[optional\]
**horizontalCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the horizontal CRS. | \[optional\]
**name** | **str** | The name of this compound CRS. | \[optional\]
**persistableReference** | **str** | The persistable reference of this compound CRS. | \[optional\]
**type** | **str** | The type code for this CRS. | \[optional\]
**verticalCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the vertical CRS. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CoordinateReferenceSystem V1 <a name="coordinatereferencesystem" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aliasNames** | **list\[str\]** | Array of alternative names, used by search. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#areaofuse) | The intended area of use for this CRS. | \[optional\]
**axisUnits** | **list\[str\]** | The array of persistable unit references describing the axes of this CRS | \[optional\]
**baseCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | Used only for a projected CRS: the base geographic CRS AuthorityCode. | \[optional\]
**crsType** | **str** | The type of CRS, one of {Projected, Geographic2D, Vertical, Compound Projected Vertical, Compound Geographic2D Vertical} | \[optional\]
**deprecationInfo** | [**CrsDeprecationInfo**](#crsdeprecationinfo) | Only if deprecated - additional information and potentially a recommended replacement CRS. | \[optional\]
**description** | **str** | A text further describing this CRS. | \[optional\]
**essence** | [**CoordinateReferenceSystemEssence**](#coordinatereferencesystemessence) | The essence of this CRS | \[optional\]
**lastModified** | **str** | The last modification date of this item (YYYYMMDD). | \[optional\]
**numberOfAxes** | **int** | The number of axes (dimension) of this CRS. | \[optional\]
**source** | **str** | Description of the source of this item. | \[optional\]
**transformationReady** | **bool** | True if the CRS is either based on WGS 84 or associated with a cartographic transform to WGS 84; else false. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CoordinateReferenceSystemEssence V1 <a name="coordinatereferencesystemessence" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of this CRS. | \[optional\]
**engineVersion** | **str** | Spatial engine type and version, which issued the spatial definitions. | \[optional\]
**name** | **str** | The name of this early-bound CRS. | \[optional\]
**persistableReference** | **str** | The persistable reference of this CRS. | \[optional\]
**type** | **str** | The type code for this CRS; LBCRS: LateBoundCoordinateReferenceSystem; EBCRS: EarlyBoundCoordinateReferenceSystem; CCRS: CompoundCoordinateReferenceSystem |
**wellKnownText** | **str** | The well-known text containing the CRS definition. Only populated for late-bound CRS (type&#x3D;LBCRS). | \[optional\]
**lateBoundCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the late-bound CRS being early-bound. Only populated for early-bound CRS (type&#x3D;EBCRS). | \[optional\]
**trfAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the bound cartographic transformation. Only populated for early-bound CRS (type&#x3D;EBCRS). | \[optional\]
**horizontalCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the horizontal CRS. Only populated for compound CRS (type&#x3D;CCRS). | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CrsDeprecationInfo V1 <a name="crsdeprecationinfo" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecationState** | **str** | State - one of {identical, corrected, unresolved} | \[optional\]
**remarks** | **str** | Further explanation of the deprecation. | \[optional\]
**superseded_by_crs** | [**CoordinateReferenceSystem**](#coordinatereferencesystem) | The coordinate reference system to be used instead - if any is recommended. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### EarlyBoundCoordinateReferenceSystem V1 <a name="earlyboundcoordinatereferencesystem" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aliasNames** | **list\[str\]** | An array of alternative names - used by search. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#areaofuse) | The intended area of use for this early-bound CRS. | \[optional\]
**axisUnits** | **list\[str\]** | The array of persistable unit references describing the axes of this CRS | \[optional\]
**baseCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | Used only for a projected CRS: the base geographic CRS AuthorityCode. | \[optional\]
**crsType** | **str** | The type of CRS, one of {Projected, Geographic2D, Vertical} | \[optional\]
**deprecationInfo** | [**CrsDeprecationInfo**](#crsdeprecationinfo) | Only if deprecated - additional information and potentially a recommended replacement CRS. | \[optional\]
**description** | **str** | A text further describing the early-bound CRS. | \[optional\]
**essence** | [**EarlyBoundCoordinateReferenceSystemEssence**](#earlyboundcoordinatereferencesystemessence) | The essence of this early-bound CRS | \[optional\]
**lastModified** | **str** | The last modification date of this item (YYYYMMDD). | \[optional\]
**numberOfAxes** | **int** | The number of axes (dimension) of this CRS. | \[optional\]
**source** | **str** | Description of the source of this item. | \[optional\]
**transformationReady** | **bool** | True if the CRS is either based on WGS 84 or associated with a cartographic transform to WGS 84; else false. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### EarlyBoundCoordinateReferenceSystemEssence V1 <a name="earlyboundcoordinatereferencesystemessence" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of this early-bound CRS. | \[optional\]
**engineVersion** | **str** | Spatial engine type and version, which issued the spatial definitions. | \[optional\]
**lateBoundCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the late-bound CRS being early-bound. | \[optional\]
**name** | **str** | The name of this early-bound CRS. | \[optional\]
**persistableReference** | **str** | The persistable reference of this early-bound CRS. | \[optional\]
**trfAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the bound cartographic transformation. | \[optional\]
**type** | **str** | The type code for this CRS. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### LateBoundCoordinateReferenceSystem V1 <a name="lateboundcoordinatereferencesystem" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aliasNames** | **list\[str\]** | Array of alternative names - used by search. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#areaofuse) | The intended area of use for the late-bound CRS. | \[optional\]
**axisUnits** | **list\[str\]** | The array of persistable unit references describing the axes of the CRS | \[optional\]
**baseCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | Used only for a projected CRS: the base geographic CRS AuthorityCode. | \[optional\]
**crsType** | **str** | The item type code. | \[optional\]
**deprecationInfo** | [**CrsDeprecationInfo**](#crsdeprecationinfo) | Only if deprecated - additional information and potentially a recommended replacement CRS. | \[optional\]
**description** | **str** | A text further describing the early-bound CRS. | \[optional\]
**lastModified** | **str** | The last modification date of this item (YYYYMMDD). | \[optional\]
**essence** | [**LateBoundCoordinateReferenceSystemEssence**](#lateboundcoordinatereferencesystemessence) | The essence of this late-bound CRS. | \[optional\]
**numberOfAxes** | **int** | The number of axes (dimension) of this CRS. | \[optional\]
**source** | **str** | Description of the source of this item. | \[optional\]
**transformationReady** | **bool** | True if the CRS is based on WGS 84; else false. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### LateBoundCoordinateReferenceSystemEssence V1 <a name="lateboundcoordinatereferencesystemessence" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the late-bound CRS. | \[optional\]
**engineVersion** | **str** | Spatial engine type and version, which issued the spatial definitions. | \[optional\]
**name** | **str** | Name of this late-bound CRS. | \[optional\]
**persistableReference** | **str** | Persistable reference string holding the full CRS definition. | \[optional\]
**type** | **str** | The type code for this CRS. | \[optional\]
**wellKnownText** | **str** | The well-known text containing the CRS definition. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### SingleCartographicTransform V1 <a name="singlecartographictransform" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aliasNames** | **list\[str\]** | Array of alternative names - used by search. | \[optional\]
**areaOfUse** | [**AreaOfUse**](#areaofuse) | The intended area of use for this single transform. | \[optional\]
**deprecationInfo** | [**TrfDeprecationInfo**](#trfdeprecationinfo) | Only if deprecated - additional information and potentially a recommended replacement transform. | \[optional\]
**description** | **str** | A text further describing this single transform. | \[optional\]
**essence** | [**SingleCartographicTransformEssence**](#singlecartographictransformessence) | The essence of this SingleCartographicTransform | \[optional\]
**fromCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the &#39;from&#39; coordinate reference system. | \[optional\]
**lastModified** | **str** | The last modification date of this item (YYYYMMDD). | \[optional\]
**source** | **str** | Description of the source of this item. | \[optional\]
**toCrsAuthorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of the &#39;to&#39; coordinate reference system. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### SingleCartographicTransformEssence V1 <a name="singlecartographictransformessence" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authorityCode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode of this single cartographic transform. | \[optional\]
**engineVersion** | **str** | Spatial engine type and version, which issued the spatial definitions. | \[optional\]
**name** | **str** | Name of this single cartographic transform | \[optional\]
**persistableReference** | **str** | The persistable reference string containing the full parameterization of the cartographic transform. | \[optional\]
**type** | **str** | The item type code | \[optional\]
**wellKnownText** | **str** | The well-known text representation for the cartographic transform. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### SphericalBoundingBox V1 <a name="sphericalboundingbox" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**latitudeLower** | **float** | The lower WGS 84 latitude limit of the search box. Value range: [-90,90] | \[optional\]
**latitudeUpper** | **float** | The upper WGS 84 latitude limit of the search box. Value range: [-90,90] | \[optional\]
**longitudeLeft** | **float** | The left WGS 84 longitude limit of the search box. Value range: [-180,180] | \[optional\]
**longitudeRight** | **float** | The right WGS 84 longitude limit of the search box. Value range: [-180,180] | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### TrfDeprecationInfo V1 <a name="trfdeprecationinfo" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecationState** | **str** | State - one of {identical, corrected, unresolved} | \[optional\]
**remarks** | **str** | Further explanation of the deprecation. | \[optional\]
**supersededByTrf** | [**CartographicTransform**](#cartographictransform) | The cartographic transform to be used instead - if any is recommended. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### AuthorityCode V1 <a name="authoritycode" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authority** | **str** | The authority defining the item. | \[optional\]
**code** | **str** | The authority code defining the item. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### AreaOfUse V1 <a name="areaofuse" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aliasNames** | **list\[str\]** | Array of alternative names, used by search. | \[optional\]
**deprecationInfo** | [**AreaOfUseDeprecationInfo**](#areaofusedeprecationinfo) | Only if deprecated - additional information and potentially a recommended replacement AreaOfUse. | \[optional\]
**description** | **str** | Text further describing the item. | \[optional\]
**essence** | [**AreaOfUseEssence**](#areaofuseessence) | The essence of the AreaOfUse. | \[optional\]
**lastModified** | **str** | The last modification date of this item (YYYYMMDD). | \[optional\]
**name** | **str** | The name of the AreaOfUse. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### AreaOfUseDeprecationInfo V1 <a name="areaofusedeprecationinfo" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecation_state** | **str** | State - one of {identical, corrected, unresolved} | \[optional\]
**remarks** | **str** | Further explanation of the deprecation. | \[optional\]
**supersededByAou** | [**AreaOfUse**](#areaofuse) | The area of use to be used instead - if any is recommended. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### AreaOfUseEssence V1 <a name="areaofuseessence" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authoritCoode** | [**AuthorityCode**](#authoritycode) | The AuthorityCode for this AreaOfUse. | \[optional\]
**boundingBox** | [**SphericalBoundingBox**](#sphericalboundingbox) | The bounding box (WGS 84) of the AreaOfUse | \[optional\]
**persistableReference** | **str** | The persistable reference string containing the full area of use description. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
### Response Types V1 <a name="response-types-v1"></a>
#### LateBoundCoordinateReferenceSystemResults V1 <a name="lateboundcoordinatereferencesystemresults" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinateReferenceSystems** | [**list\[LateBoundCoordinateReferenceSystem\]**](#lateboundcoordinatereferencesystem) | An array of LateBoundCoordinateReferenceSystem | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### EarlyBoundCoordinateReferenceSystemResults V1 <a name="earlyboundcoordinatereferencesystemresults" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinateReferenceSystems** | [**list\[EarlyBoundCoordinateReferenceSystem\]**](#earlyboundcoordinatereferencesystem) | An array of EarlyBoundCoordinateReferenceSystem | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CompoundCoordinateReferenceSystemResults V1 <a name="compoundcoordinatereferencesystemresults" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinateReferenceSystems** | [**list\[CompoundCoordinateReferenceSystem\]**](#compoundcoordinatereferencesystem) | An array of CompoundCoordinateReferenceSystem | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CoordinateReferenceSystemResults V1 <a name="coordinatereferencesystemresults" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinateReferenceSystems** | [**list\[CoordinateReferenceSystem\]**](#coordinatereferencesystem) | An array of (any sub-type of) CoordinateReferenceSystem | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### SingleCartographicTransformResults V1 <a name="singlecartographictransformresults" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cartographicTransforms** | [**list\[SingleCartographicTransform\]**](#singlecartographictransform) | An array of SingleCartographicTransforms | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CompoundCartographicTransformResults V1 <a name="compoundcartographictransformresults" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cartographicTransforms** | [**list\[CompoundCartographicTransform\]**](#compoundcartographictransform) | An array of CompoundCartographicTransforms | \[optional\]
**count** | **int** | Number of items returned in this response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Total number of items in the catalog. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)
#### CartographicTransformResults V1 <a name="cartographictransformresults" ></a>
##### Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cartographicTransforms** | [**list\[CartographicTransform\]**](#cartographictransform) | An array of (any sub-type of) CartographicTransforms | \[optional\]
**count** | **int** | Number of elements in the response. | \[optional\]
**offset** | **int** | Offset to the first catalog item in the response, as set in the request. | \[optional\]
**totalCount** | **int** | Number of elements in the catalog. | \[optional\]
[Back to Legacy API V1](#legacy-api-v1) [Back to API Data Structures (Version 1)](#response-data-structures-v1) - [Back to table of contents](#TOC)