GET api/v1/search/products/searchTools/{target}/{componentType}/{mission}/{instrument}/{prodType}/{productIdentifier}/{minLat}/{maxLat}/{westernLon}/{easternLon}/{wkt}/{featureType}/{feature}/{sol}/{outputFormat}

This API method returns a list of website search forms or search results at the PDS Geosciences Node for provided criteria.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
target

select the target ODE version: mars, mercury, moon, or venus

string

Required

componentType

[Optional field] The search interface component types (form, resultList, resultmap)

string

Default value is

mission

[Optional field] Currently mission abreviation: MRO, LRO, MGS, Grail, etc

string

Default value is

instrument

[Optional field] The instrument abreviation: CRISM, HIRISE, CTX, SHARAD

string

Default value is

prodType

[Optional field] PDS3 product type: EDR, RDR, etc

string

Default value is

productIdentifier

[Optional field] PDS3 product id or PDS4 LID, a * for wildcard is accepted at the beginning or end of the string

string

Default value is

minLat

[Optional field] Max latitude as a decimal

decimal number

Default value is -999

maxLat

[Optional field] Min latitude as a decimal

decimal number

Default value is -999

westernLon

[Optional field] Westernmost longitude (0-360) as a decimal

decimal number

Default value is -999

easternLon

[Optional field] Easternmost longitude (0-360) as a decimal

decimal number

Default value is -999

wkt

[Optional field] Location as WKT format - not currently implemented

string

Default value is

featureType

[Optional field] Feature type - chaos, crater, etc

string

Default value is

feature

[Optional field] Feature name

string

Default value is

sol

[Optional field] Mission Sol for landed missions

integer

Default value is -999

outputFormat

[Optional field] To override the requestor's accepted format, json or xml can be submitted

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of search_tool_url
NameDescriptionTypeAdditional information
appName

The application name

string

String length: inclusive between 0 and 50

componentType

The application component type (form, result_list, result_map)

string

String length: inclusive between 0 and 50

description

The description

string

String length: inclusive between 0 and 1000

url

The direct URL to a file

string

String length: inclusive between 0 and 3000

Response Formats

application/json, text/json

Sample:
[
  {
    "appName": "sample string 1",
    "componentType": "sample string 2",
    "description": "sample string 3",
    "url": "sample string 4"
  },
  {
    "appName": "sample string 1",
    "componentType": "sample string 2",
    "description": "sample string 3",
    "url": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfsearch_tool_url xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPITest.Models">
  <search_tool_url>
    <appName>sample string 1</appName>
    <componentType>sample string 2</componentType>
    <description>sample string 3</description>
    <url>sample string 4</url>
  </search_tool_url>
  <search_tool_url>
    <appName>sample string 1</appName>
    <componentType>sample string 2</componentType>
    <description>sample string 3</description>
    <url>sample string 4</url>
  </search_tool_url>
</ArrayOfsearch_tool_url>