Commit b921070e authored by Sherman Yang's avatar Sherman Yang
Browse files

create top level docs folder and contents

parent 4e8f3f9c
Pipeline #89528 failed with stages
in 23 minutes and 18 seconds
# AnyCRSEssence
## 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]
**late_bound_crs** | [**LateBoundCRSEssence**](LateBoundCRSEssence.md) | Late-bound CRS, which is bound to a single (st) or compound (ct) transformation to WGS 84. | [optional]
**single_ct** | [**SingleCTEssence**](SingleCTEssence.md) | 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.md) | Compound transformation, which binds the late-bound CRS (lb) to WGS 84. If absent, a single transformation (st) must be present. | [optional]
**horz_late_bound_crs** | [**LateBoundCRSEssence**](LateBoundCRSEssence.md) | The horizontal CRS of a Compound CRS as late-bound CRS. If 'horzLateBoundCRS' is non-null, 'horzEarlyBoundCRS' must be null. | [optional]
**horz_early_bound_crs** | [**EarlyBoundCRSEssence**](EarlyBoundCRSEssence.md) | The horizontal CRS of a Compound CRS as early-bound CRS. If 'horzEarlyBoundCRS' is non-null, 'horzLateBoundCRS' must be null. | [optional]
**vert_late_bound_crs** | [**LateBoundCRSEssence**](LateBoundCRSEssence.md) | The vertical CRS of the Compound CRS as late-bound CRS. If 'vertLateBoundCRS' is non-null, 'vertEarlyBoundCRS' must be null. | [optional]
**vert_early_bound_crs** | [**EarlyBoundCRSEssence**](EarlyBoundCRSEssence.md) | The vertical CRS of the Compound CRS as early-bound CRS. If 'vertEarlyBoundCRS' is non-null, 'vertLateBoundCRS' must be null. | [optional]
**auth_code** | [**AuthCode**](AuthCode.md) | The authority code for this item. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# AnyCTEssence
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier, either 'ST' or 'CT'. |
**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.md) | The ordered list of cartographic transformations. | [optional]
**auth_code** | [**AuthCode**](AuthCode.md) | The authority code for this item. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# AreaOfUse
## 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]
**last_modified** | **str** | The LastModified of the AreaOfUse. | [optional]
**named_reference** | [**NamedReference**](NamedReference.md) | A structure containing the item Name and the persistable Reference string; populated if the request mode='persistable_reference'. | [optional]
**essence** | [**AreaOfUseEssence**](AreaOfUseEssence.md) | The Essence of the AreaOfUse. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# AreaOfUseDeprecationInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecation_state** | **str** | State - one of {identical, corrected, unresolved} | [optional]
**remarks** | **str** | Further explanation of the deprecation. | [optional]
**superseded_by_area** | [**AreaOfUse**](AreaOfUse.md) | The AreaOfUse to be used instead - if any is recommended. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# AreaOfUseEssence
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type identifier, fixed to 'AOU'. | [default to 'AOU']
**bound_box** | [**BoundBox**](BoundBox.md) | The bounding box in latitude and longitude WGS 84 based. |
**auth_code** | [**AuthCode**](AuthCode.md) | The authority code for this item. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# AreaOfUseRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistable_reference** | **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.md) | Area of use essence. Either the essence or persistableReference must be non-null. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# AreaOfUseResults
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**areas_of_use** | [**list[AreaOfUse]**](AreaOfUse.md) | 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]
**total_count** | **int** | Number of elements in the catalog. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# swagger_client.AreasOfUseApi
All URIs are relative to *https://ROOT_URLBASE_URL*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_all_areas_of_use**](AreasOfUseApi.md#get_all_areas_of_use) | **GET** /area | Get Areas of Use
[**get_one_area_of_use**](AreasOfUseApi.md#get_one_area_of_use) | **POST** /area | Get one Area of Use
[**search_area_of_use**](AreasOfUseApi.md#search_area_of_use) | **POST** /search/area | Search Areas of Use
# **get_all_areas_of_use**
> AreaOfUseResults get_all_areas_of_use(offset=offset, limit=limit, mode=mode, data_partition_id=data_partition_id)
Get Areas of Use
Get Area of Use records - returning named bounding box definitions in latitude and longitude.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure OAuth2 access token for authorization: google_id_token
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AreasOfUseApi()
offset = 56 # int | The offset of the first item in the list of all AreaOfUse. It is optional and is 0 by default. (optional)
limit = 56 # int | The maximum number of the AreaOfUse returned. It is optional and is 100 by default. (optional)
mode = 'persistable_reference' # str | The mode of return: 'persistable_reference' (default) string or 'essence' structure or both 'persistable_reference_essence'. (optional) (default to persistable_reference)
data_partition_id = 'data_partition_id_example' # str | (optional)
try:
# Get Areas of Use
api_response = api_instance.get_all_areas_of_use(offset=offset, limit=limit, mode=mode, data_partition_id=data_partition_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AreasOfUseApi->get_all_areas_of_use: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**offset** | **int**| The offset of the first item in the list of all AreaOfUse. It is optional and is 0 by default. | [optional]
**limit** | **int**| The maximum number of the AreaOfUse returned. It is optional and is 100 by default. | [optional]
**mode** | **str**| The mode of return: 'persistable_reference' (default) string or 'essence' structure or both 'persistable_reference_essence'. | [optional] [default to persistable_reference]
**data_partition_id** | **str**| | [optional]
### Return type
[**AreaOfUseResults**](AreaOfUseResults.md)
### Authorization
[Bearer](../README.md#Bearer), [google_id_token](../README.md#google_id_token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_one_area_of_use**
> AreaOfUse get_one_area_of_use(body=body, mode=mode, data_partition_id=data_partition_id)
Get one Area of Use
Get one Area of Use record by essence - returning a named bounding box definition in latitude and longitude.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure OAuth2 access token for authorization: google_id_token
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AreasOfUseApi()
body = swagger_client.AreaOfUseRequest() # AreaOfUseRequest | A unique description of an AreaOfUse, either as persistable reference string or essence JSON. (optional)
mode = 'persistable_reference' # str | The mode of return: 'persistable_reference' (default) string or 'essence' structure or both 'persistable_reference_essence'. (optional) (default to persistable_reference)
data_partition_id = 'data_partition_id_example' # str | (optional)
try:
# Get one Area of Use
api_response = api_instance.get_one_area_of_use(body=body, mode=mode, data_partition_id=data_partition_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AreasOfUseApi->get_one_area_of_use: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**AreaOfUseRequest**](AreaOfUseRequest.md)| A unique description of an AreaOfUse, either as persistable reference string or essence JSON. | [optional]
**mode** | **str**| The mode of return: 'persistable_reference' (default) string or 'essence' structure or both 'persistable_reference_essence'. | [optional] [default to persistable_reference]
**data_partition_id** | **str**| | [optional]
### Return type
[**AreaOfUse**](AreaOfUse.md)
### Authorization
[Bearer](../README.md#Bearer), [google_id_token](../README.md#google_id_token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **search_area_of_use**
> AreaOfUseResults search_area_of_use(body, longitude_left=longitude_left, latitude_lower=latitude_lower, longitude_right=longitude_right, latitude_upper=latitude_upper, offset=offset, limit=limit, mode=mode, data_partition_id=data_partition_id)
Search Areas of Use
Search Area of Use records by keywords and/or geographic area - returning named bounding box definitions in latitude and longitude. Geographical constraints are passed (optionally) as parameters via the query URL, search keywords are passed via the request body. Query syntax follows Lucene style, default operator for multiple expressions is AND. The following keywords are supported: 'name:', 'description:', 'authority:', 'code:', 'deprecationState:', 'remarks:' (deprecationState remarks), 'lastModified:'. Example 'name:*America*'.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure OAuth2 access token for authorization: google_id_token
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AreasOfUseApi()
body = swagger_client.SearchAreaOfUseRequest() # SearchAreaOfUseRequest | A Lucene style keyword query. One of the following keywords: 'name:', 'description:', 'authority:', 'code:', 'deprecationState:', 'remarks:' (deprecationState remarks), 'lastModified:'. Example 'name:*America*'.
longitude_left = 1.2 # float | The left WGS 84 longitude limit of the search box. Value range: [-180,180] (optional)
latitude_lower = 1.2 # float | The lower WGS 84 latitude limit of the search box. Value range: [-90,90] (optional)
longitude_right = 1.2 # float | The right WGS 84 longitude limit of the search box. Value range: [-180,180] (optional)
latitude_upper = 1.2 # float | The lower WGS 84 latitude limit of the search box. Value range: [-90,90] (optional)
offset = 56 # int | The offset of the first item in the list of all AreasOfUse. It is optional and is 0 by default. (optional)
limit = 56 # int | The maximum number of the AreasOfUse returned. It is optional and is 100 by default. (optional)
mode = 'persistable_reference' # str | The mode of return: 'persistable_reference' (default) string or 'essence' structure or both 'persistable_reference_essence'. (optional) (default to persistable_reference)
data_partition_id = 'data_partition_id_example' # str | (optional)
try:
# Search Areas of Use
api_response = api_instance.search_area_of_use(body, longitude_left=longitude_left, latitude_lower=latitude_lower, longitude_right=longitude_right, latitude_upper=latitude_upper, offset=offset, limit=limit, mode=mode, data_partition_id=data_partition_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AreasOfUseApi->search_area_of_use: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**SearchAreaOfUseRequest**](SearchAreaOfUseRequest.md)| A Lucene style keyword query. One of the following keywords: 'name:', 'description:', 'authority:', 'code:', 'deprecationState:', 'remarks:' (deprecationState remarks), 'lastModified:'. Example 'name:*America*'. |
**longitude_left** | **float**| The left WGS 84 longitude limit of the search box. Value range: [-180,180] | [optional]
**latitude_lower** | **float**| The lower WGS 84 latitude limit of the search box. Value range: [-90,90] | [optional]
**longitude_right** | **float**| The right WGS 84 longitude limit of the search box. Value range: [-180,180] | [optional]
**latitude_upper** | **float**| The lower WGS 84 latitude limit of the search box. Value range: [-90,90] | [optional]
**offset** | **int**| The offset of the first item in the list of all AreasOfUse. It is optional and is 0 by default. | [optional]
**limit** | **int**| The maximum number of the AreasOfUse returned. It is optional and is 100 by default. | [optional]
**mode** | **str**| The mode of return: 'persistable_reference' (default) string or 'essence' structure or both 'persistable_reference_essence'. | [optional] [default to persistable_reference]
**data_partition_id** | **str**| | [optional]
### Return type
[**AreaOfUseResults**](AreaOfUseResults.md)
### Authorization
[Bearer](../README.md#Bearer), [google_id_token](../README.md#google_id_token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# AuthCode
## 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 Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# BoundBox
## 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 Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# CRS
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**essence** | [**AnyCRSEssence**](AnyCRSEssence.md) | The CRS'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]
**base_crs_authority_code** | [**AuthCode**](AuthCode.md) | The base authority code of this CRS. | [optional]
**alias_names** | **list[str]** | Alias names for this CRS. | [optional]
**axis_units** | **list[str]** | Axis Unit Essences. | [optional]
**number_of_axes** | **int** | The NumberOfAxes of this CRS. | [optional]
**description** | **str** | The description of this CRS. | [optional]
**last_modified** | **str** | The LastModified of this CRS. | [optional]
**area_of_use** | [**AreaOfUse**](AreaOfUse.md) | The Area of Use for this CRS. | [optional]
**deprecation_info** | [**CRSDeprecationInfo**](CRSDeprecationInfo.md) | Only if deprecated - additional information and potentially a recommended replacement CRS. | [optional]
**named_reference** | [**NamedReference**](NamedReference.md) | A structure containing the item Name and the persistable Reference string; populated if the request mode='persistable_reference'. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# swagger_client.CRSCatalogApi
All URIs are relative to *https://ROOT_URLBASE_URL*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_catalog_attributes**](CRSCatalogApi.md#get_catalog_attributes) | **GET** /catalog/attributes | Get Catalog Name and Update Dates
[**get_catalog_summary**](CRSCatalogApi.md#get_catalog_summary) | **GET** /catalog | Get the Catalog summary (without lists)
# **get_catalog_attributes**
> CatalogAttributes get_catalog_attributes(data_partition_id=data_partition_id)
Get Catalog Name and Update Dates
Get the catalog name and last update date
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure OAuth2 access token for authorization: google_id_token
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.CRSCatalogApi()
data_partition_id = 'data_partition_id_example' # str | (optional)
try:
# Get Catalog Name and Update Dates
api_response = api_instance.get_catalog_attributes(data_partition_id=data_partition_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling CRSCatalogApi->get_catalog_attributes: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data_partition_id** | **str**| | [optional]
### Return type
[**CatalogAttributes**](CatalogAttributes.md)
### Authorization
[Bearer](../README.md#Bearer), [google_id_token](../README.md#google_id_token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_catalog_summary**
> Catalog get_catalog_summary(data_partition_id=data_partition_id)
Get the Catalog summary (without lists)
Get the catalog structure with populated number of items per list but empty lists ('lateBoundCRSes',...). It is expected that the lists are individually populated on demand via the specific methods ('CRSV2GetLateBoundCRSes',...).
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure OAuth2 access token for authorization: google_id_token
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.CRSCatalogApi()
data_partition_id = 'data_partition_id_example' # str | (optional)
try:
# Get the Catalog summary (without lists)
api_response = api_instance.get_catalog_summary(data_partition_id=data_partition_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling CRSCatalogApi->get_catalog_summary: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data_partition_id** | **str**| | [optional]
### Return type
[**Catalog**](Catalog.md)
### Authorization
[Bearer](../README.md#Bearer), [google_id_token](../README.md#google_id_token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# CRSDeprecationInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecation_state** | **str** | State - one of {identical, corrected, unresolved} | [optional]
**remarks** | **str** | Further explanation of the deprecation. | [optional]
**superseded_by_crs** | [**CRS**](CRS.md) | The coordinate reference system to be used instead - if any is recommended. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# CRSRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistable_reference** | **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.md) | The essence Json for the CRS. Either the essence or persistableReference must be non-null. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# CRSResults
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**crses** | [**list[CRS]**](CRS.md) | 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]
**total_count** | **int** | Number of elements in the catalog. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# CT
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **str** | The source of the cartographic transformation. | [optional]
**alias_names** | **list[str]** | Alias names for this cartographic transformation. | [optional]
**description** | **str** | The description of the cartographic transformation. | [optional]
**from_crs_authority_code** | [**AuthCode**](AuthCode.md) | The 'from CRS' authority code of this cartographic transformation. | [optional]
**to_crs_authority_code** | [**AuthCode**](AuthCode.md) | The 'to CRS' authority code of this cartographic transformation. | [optional]
**last_modified** | **str** | The LastModified of the cartographic transformation. | [optional]
**area_of_use** | [**AreaOfUse**](AreaOfUse.md) | The Area of Use for this cartographic transformation. | [optional]
**deprecation_info** | [**CTDeprecationInfo**](CTDeprecationInfo.md) | Only if deprecated - additional information and potentially a recommended replacement cartographic transformation. | [optional]
**named_reference** | [**NamedReference**](NamedReference.md) | A structure containing the item Name and the persistable Reference string; populated if the request mode='persistable_reference'. | [optional]
**essence** | [**AnyCTEssence**](AnyCTEssence.md) | The Essence of the cartographic transformation. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# CTDeprecationInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecation_state** | **str** | State - one of {identical, corrected, unresolved} | [optional]
**remarks** | **str** | Further explanation of the deprecation. | [optional]
**superseded_by_ct** | [**CT**](CT.md) | The cartographic transform to be used instead - if any is recommended. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# CTRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**persistable_reference** | **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.md) | The essence Json for the CT. Either the essence or persistableReference must be non-null. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# CTResults
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cts** | [**list[CT]**](CT.md) | 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]
**total_count** | **int** | Number of elements in the catalog. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
This diff is collapsed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment