DataDoors
The following operations are supported. For a formal definition, please review the Service Description.
-
ApplicationParameters
Acquires available parameters for a specific DataDoors application. RETURNS - An array of Parameters with key-value pairs. An example of a Parameter is the value for the InstallerURL for DataDoors for ArcGIS to download a new version. -
ApplicationValidation
Obsolete - Always returns false. RETURNS - FALSE -
AuthenticateUser
Authenticates the user by submitting a login and password. RETURNS - A populated User including the the current shipping address. If an null User is returned then the authentication failed. -
AuthenticateUserToken
Authenticates the user by submitting a token. RETURNS - A populated User including the the current shipping address. If an null User is returned then the authentication failed. -
GetAgentMetadata
Get Agent Metadata RETURNS - Agent Metadata Object -
GetArchiveProducts
Acquires all the Products for a specified Archive with respect to the specified area of interest. RETURNS - An array of Product types and associated attributes. This only includes the Products for a given Archive and not the Product-Processes or Product-Footprints. Refer to GetProductProcesses and GetProductFootprints for this information. -
GetArchiveProductsAll
Acquires all the Products for a specified Archive. RETURNS - An array of Product types and associated attributes regarding the Product. This only includes the Products for a given Archive and not the Product-Processes or Product-Footprints. Refer to GetProductProcesses and GetProductFootprints for this information. -
GetCompany
Acquires information about the User organization and accessible Archives. This use of the word “Company” is legacy, in the modern DataDoors system these are actually Organizations. RETURNS - A Company with relavent information including an array of accessible Archives. -
GetCoordinateSystems
Acquires the coordinate systems and individual spatial references available in the DataDoors system. To acquire the logical coordinate systems with respect to a given area of interest refer to the GetCoordinateSystemsValid operation. RETURNS - An array of CoordSys types indicating if the coordinate system is projected such as geographic or UTM. Each CoordSys type contains an array of SpatialRefSys types listing the individual spatial references such as GCS_WGS_1984 or NAD_1927_UTM_Zone_13N. -
GetCoordinateSystemsValid
Acquires the logical coordinate systems and individual spatial references available in DataDoors with respect to a given area of interest. RETURNS - An array of CoordSys types indicating if the coordinate system is projected such as geographic or UTM. Each CoordSys type contains an array of SpatialRefSys types listing the individual spatial references such as GCS_WGS_1984 or NAD_1927_UTM_Zone_13N. -
GetEndUsers
Acquires the EndUsers for a specified organization. RETURNS - A Company type with a populated array of EndUser types. -
GetFootprintBrowse
Acquires the Browse image (JPEG format) for a specific Product Footprint. This is used to display temporal reduced resolution imagery.RETURNS - A Footprint type with the Browse type populated. The Browse is a binary base-64 JPEG format image. To view the Browse spatially impose the Browse on the bounding box of the Footprint Geometry. -
GetFootprintMetadata
Acquires the MetaData for a specific Product Footprint. RETURNS - A Footprint type with the MetaData type populated. -
GetJob
Allows the ability to get a specified Job from the DataDoors system. RETURNS - A submitted Job. -
GetLicenseText
Provides the client application with the terms and conditions of the supplied license RETURNS - A string -
GetLicenseUpgrade
Provides the client application with information on the current license and available upgrades for a given footprint and company RETURNS - License Info Array -
GetMedium
Acquires the supported Media types supported by DataDoors with respect to the organization. RETURNS - An array of valid Media types for the organization. The maxsize_mb attibute for FTP indicates the configured maximum size limit for the organization. -
GetPieces
Allows the ability for a client application to submit a request and generate applicable pieces for the request. RETURNS - Piece array -
GetProductCoverage
Acquires the product coverage for an area of interest and the product as it will be calculated on the server for pricing purposes. RETURNS - A Product with the CoverageArea, CoverageStatus and CoverageGeometry populated. CoverageArea is the area of the returning geometry in the requested units (UnitTypeUID). CoverageStatus values are either NONE, PARTIAL, or FULL defining the status of the coverage. CoverageGeometry is the intersecton of the WKT geometry of the AOI and the available product coverage. -
GetProductFootprints
Acquires Product Footprints with respect to a specific area of interest and temporal search constraint. RETURNS - A Product with an array of Footprint types. The Footprint only includes the associated attributes and Geometry. The Geometry represents the actual data area of the raster (not the outlying null or black areas). For other information regarding the Footprint refer to GetFootprintMetadata, GetFootprintLicense, and GetFootprintBrowse operations. -
GetProductFootprintsAll
Acquires all the Product Footprints with respect to a specific area of interest. RETURNS - A Product with an array of Footprint types. The Footprint only includes the associated attributes and Geometry. For other information regarding the Footprint refer to GetFootprintMetadata, GetFootprintLicense, and GetFootprintBrowse. -
GetProductFootprintsByCriteria
Acquires Product Footprints with respect to a set of filter criteria. RETURNS - A Product with an array of Footprint types. The Footprint only includes the associated attributes and Geometry. The Geometry represents the actual data area of the raster (not the outlying null or black areas). For other information regarding the Footprint refer to GetFootprintMetadata, GetFootprintLicense, and GetFootprintBrowse operations. -
GetProductPrice
Acquires the Price for a specific Product with respect to the quantity of the Product; resolution ratio; and the Organization for discount purposes. The resolution ratio is the user specified resolution divided by the Product source resolution. The source resolution can be acquired from the first value in appropriate Product valid resolutions (e.g valid_res_meters, valid_res_seconds, valid_res_feet). RETURNS - The price for the Product. This price does not include the processing price for the Product, shipping and handling, or the media costs. -
GetProductProcessFormats
Acquires the available Formats for a specific Product Process. To acquire the available processes for the Product refer to the GetProductProcesses operaton. RETURNS - A array of Format types with associated attributes defining specific parameters of the Format, as well as a ChanClass (channel class) type specifying the bits_per_sample and samples_per_pixel attributes. -
GetProductProcessPrice
Acquires the processing price for a specific Product with respects to the quantity of the product and the Organization for discount purposes. RETURNS - The price for processing the product. This price does not include the price for the Product, shipping and handling, or the media costs. -
GetProductProcesses
Acquires the available Processes for a specified Product. RETURNS - A Product type populated with an array of Process types with associated attributes defining the Process. -
GetProject
Provides the ability to request an existing Project with a specific UID. RETURNS - The specified Project. -
GetRequestCosts
Allows the ability for a client application to submit a request and generate applicable request costs for the request. RETURNS - RequestCost array -
GetSubscription
Acquires specific information about a specific subscription. RETURNS - A schema and dataset specifying a list of specific Products and specific parameters for processing. Also supported spatial references and media types for the subscription are returned. -
GetUnitTypes
Acquires the available UnitTypes in the DataDoors system. RETURNS - An array of UnitType types and associated attributes. For each UnitType this includes the conversion factor from 1 meter and if the UnitType measures area. -
SaveProject
Provides the ability to save a Project. If the Project requested to be saved does not have a Project.UID then the project is inserted, otherwise the Project is updated. RETURNS - The Project UID of the saved project. -
SubmitJob
Allows the ability to submit a Job into the DataDoors system for processing and delivery. RETURNS - Identifier for the submitted Job.