GET api/v1/search/products/lidvids/metadata/{lidvid}/{outputFormat}

This API method will return product meta data of a PDS product based on a PDS4 lidvid (PDS4 product lid + product version id) or lid search

Request Information

URI Parameters

NameDescriptionTypeAdditional information
lidvid

PDS4 product lidvid (PDS4 product lid + product version id) or a PDS4 product lid (the most recent product version will be returned)

string

Default value is

outputFormat

[Optional field] Specify the desired format json or xml

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of ODEProductMetadata
NameDescriptionTypeAdditional information
odeProductId

An internal ODE product ID

integer

None.

pds3ProductId

A PDS3 product id, or for PDS4 products, the last piece of a Product LID

string

String length: inclusive between 0 and 200

pdS4ProductLid

A PDS4 product lid. It is an empty string for PDS3 products.

string

String length: inclusive between 0 and 200

productVersionId

A PDS product version id.

string

String length: inclusive between 0 and 20

mission

The mission abreviation

string

String length: inclusive between 0 and 200

instrument

The instrument abreviation

string

String length: inclusive between 0 and 200

productType

The product type name string

string

String length: inclusive between 0 and 200

productTypeAbr

The product type abreviation. It may be an internal ODE abreviation in some cases.

string

String length: inclusive between 0 and 200

detailUrl

The direct URL to the product detail page in ODE

string

String length: inclusive between 0 and 2000

observationStartUtc

The PDS product observation start time

string

String length: inclusive between 0 and 200

observationEndUtc

The PDS product observation end time

string

String length: inclusive between 0 and 200

Response Formats

application/json, text/json

Sample:
[
  {
    "odeProductId": 1,
    "pds3ProductId": "sample string 2",
    "pdS4ProductLid": "sample string 3",
    "productVersionId": "sample string 4",
    "mission": "sample string 5",
    "instrument": "sample string 6",
    "productType": "sample string 7",
    "productTypeAbr": "sample string 8",
    "detailUrl": "sample string 9",
    "observationStartUtc": "sample string 10",
    "observationEndUtc": "sample string 11"
  },
  {
    "odeProductId": 1,
    "pds3ProductId": "sample string 2",
    "pdS4ProductLid": "sample string 3",
    "productVersionId": "sample string 4",
    "mission": "sample string 5",
    "instrument": "sample string 6",
    "productType": "sample string 7",
    "productTypeAbr": "sample string 8",
    "detailUrl": "sample string 9",
    "observationStartUtc": "sample string 10",
    "observationEndUtc": "sample string 11"
  }
]

application/xml, text/xml

Sample:
<ArrayOfODEProductMetadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPITest.Models">
  <ODEProductMetadata>
    <detailUrl>sample string 9</detailUrl>
    <instrument>sample string 6</instrument>
    <mission>sample string 5</mission>
    <observationEndUtc>sample string 11</observationEndUtc>
    <observationStartUtc>sample string 10</observationStartUtc>
    <odeProductId>1</odeProductId>
    <pdS4ProductLid>sample string 3</pdS4ProductLid>
    <pds3ProductId>sample string 2</pds3ProductId>
    <productType>sample string 7</productType>
    <productTypeAbr>sample string 8</productTypeAbr>
    <productVersionId>sample string 4</productVersionId>
  </ODEProductMetadata>
  <ODEProductMetadata>
    <detailUrl>sample string 9</detailUrl>
    <instrument>sample string 6</instrument>
    <mission>sample string 5</mission>
    <observationEndUtc>sample string 11</observationEndUtc>
    <observationStartUtc>sample string 10</observationStartUtc>
    <odeProductId>1</odeProductId>
    <pdS4ProductLid>sample string 3</pdS4ProductLid>
    <pds3ProductId>sample string 2</pds3ProductId>
    <productType>sample string 7</productType>
    <productTypeAbr>sample string 8</productTypeAbr>
    <productVersionId>sample string 4</productVersionId>
  </ODEProductMetadata>
</ArrayOfODEProductMetadata>