Complete CDAS R1.7.42 Web Services API

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

./

spdfcdaswsexample.pro


This program is an example to demonstrate calling the Coordinated Data Analysis System's REST Web Services from an Exelis Visual Information Solutions (VIS) Interactive Data Language (IDL) program. It demonstrates the following:

  • Getting the available dataviews.
  • Getting the available mission groups.
  • Getting the available instrument types.
  • Getting the available datasets for ACE.
  • Getting the variables for the AC_H0_MFI dataset.
  • Getting and displaying a portion of an ASCII listing of AC_H0_MFI data.
  • Getting a CDF file of AC_H0_MFI data and displaying some of the file's attributes.
  • Getting and displaying a graph of AC_H0_MFI data.
  • Some basic HTTP error handling.

Author information

Author

B. Harris

Copyright

Copyright (c) 2010-2021 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

Routines

Routines from spdfcdaswsexample.pro

getCdfFile, fileDescription

This procedure demonstrates how to obtain a local copy of a remote CDF file and display some CDF information about the file's contents.

getTextFile, fileDescription [, sslVerifyPeer=int]

This procedure demonstrates how to obtain a local copy of a remote text file and display a portion of its contents.

getFile, fileDescription [, sslVerifyPeer=int]

This procedure demonstrates how to check the MIME-type of an SpdfFileDescription and, if it is of type "image/png", to get a local copy and display the image.

getResultFile, fileDescription [, sslVerifyPeer=int]

This procedure demonstrates how to examine an SpdfFileDescription and then display it based upon it MIME-type.

getDataResults, results [, sslVerifyPeer=int]

This procedure demonstrates how to examine the result of a data request.

SpdfCdasWsExample [, endpoint=string] [, sslVerifyPeer=int]

This procedure is an example to demonstrate calling the CDAS REST Web Services from an IDL program.

Routine details

top source getCdfFile

getCdfFile, fileDescription

This procedure demonstrates how to obtain a local copy of a remote CDF file and display some CDF information about the file's contents.

Parameters

fileDescription in type=SpdfFileDescription

description of a remote CDF file.

top source getTextFile

getTextFile, fileDescription [, sslVerifyPeer=int]

This procedure demonstrates how to obtain a local copy of a remote text file and display a portion of its contents.

Parameters

fileDescription in type=SpdfFileDescription

description of a remote CDF file.

Keywords

sslVerifyPeer in optional type=int default=SpdfGetDefaultSslVerifyPeer()

Specifies whether the authenticity of the peer's SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.

top source getFile

getFile, fileDescription [, sslVerifyPeer=int]

This procedure demonstrates how to check the MIME-type of an SpdfFileDescription and, if it is of type "image/png", to get a local copy and display the image.

Parameters

fileDescription in type=SpdfFileDescription

description of a remote file

Keywords

sslVerifyPeer in optional type=int default=SpdfGetDefaultSslVerifyPeer()

Specifies whether the authenticity of the peer's SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.

top source getResultFile

getResultFile, fileDescription [, sslVerifyPeer=int]

This procedure demonstrates how to examine an SpdfFileDescription and then display it based upon it MIME-type.

Parameters

fileDescription in type=SpdfFileDescription

description of a remote file.

Keywords

sslVerifyPeer in optional type=int default=SpdfGetDefaultSslVerifyPeer()

Specifies whether the authenticity of the peer's SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.

top source getDataResults

getDataResults, results [, sslVerifyPeer=int]

This procedure demonstrates how to examine the result of a data request.

Parameters

results in type=SpdfCdasDataResult

results of a data request.

Keywords

sslVerifyPeer in optional type=int default=SpdfGetDefaultSslVerifyPeer()

Specifies whether the authenticity of the peer's SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.

top source SpdfCdasWsExample

SpdfCdasWsExample [, endpoint=string] [, sslVerifyPeer=int]

This procedure is an example to demonstrate calling the CDAS REST Web Services from an IDL program. It demonstrates the following:

  • Getting the available dataviews.
  • Getting the available mission groups.
  • Getting the available instrument types.
  • Getting the available datasets for ACE.
  • Getting the variables for the AC_H0_MFI dataset.
  • Getting and displaying a portion of an ASCII listing of AC_H0_MFI data.
  • Getting a CDF file of AC_H0_MFI data and displaying some of the file's attributes.
  • Getting and displaying a graph of AC_H0_MFI data.
  • Some basic HTTP error handling.

Keywords

endpoint in optional type=string default=SpdfCdas->getDefaultEndpoint()

URL of CDAS web service.

sslVerifyPeer in optional type=int default=spdfGetDefaultSslVerifyPeer()

Specifies whether the authenticity of the peer's SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.

File attributes

Modification date: Fri Oct 28 07:13:21 2022
Lines: 194


CDAS Feedback.