Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
String getTimeSeriesHeaders(String clientId, String id, String taskId, Date startTime,
		Date timeZero, Date endTime, String[] parameterIds, String[] locationIds, String ensembleId, int ensembleMemberIndex);

  • clientId: File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
  • id: Reference to the ID of a TimeSeries element in the service configuration file.
Code Block

String getTimeSeries(String clientId, String id, String taskId, Date startTime,
		Date timeZero, Date endTime, String[] parameterIds, String[] locationIds, String ensembleId, int ensembleMemberIndex);

  • clientId: File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
  • id: Reference to the ID of a TimeSeries element in the service configuration file.
  • taskId: <id not required however can not be null>
  • startTime: Start date/time of run - Long.MAXVALUE if the configured default is to be used
  • timeZero: Forecast time zero.
  • endTime: End date/time of run - Long.MAXVALUE if the configured default is to be used
  • parameterIds: Subset of parmater IDs for which to retrieve timeseries.
  • locationIds: Subset of location IDs for which to retrieve timeseries.
  • ensembleId: Id of the ensemble, can be null.
  • ensembleMemberIndex Ensemble member index for this time series. (Only if configured)
  • returns: String content of a PiTimeseries XML file only containing header information.
Code Block

String getTimeSeries
Code Block

byte[] getTimeSeriesBytes(String clientId, String id, String taskId, Date startTime,
		Date timeZero, Date endTime,&nbsp; String[] parameterIds, String[] locationIds, String ensembleId, int ensembleMemberIndex);

  • clientId: File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
  • id: Reference to the ID of a TimeSerieselement TimeSeries element in the service configuration file.
  • taskId: <id not required however can not be null>
  • startTime: Start date/time of run - Long.MAXVALUE if the configured default is to be used
  • timeZero: Forecast time zero.
  • endTime: End date/time of run - Long.MAXVALUE if the configured default is to be used
  • parameterIds: Subset of parmater IDs for which to retrieve timeseries.
  • locationIds: Subset of location IDs for which to retrieve timeseries.
  • ensembleId: Id of the ensemble, can be null.
  • ensembleMemberIndex Ensemble member index for this time series. (Only if configured)
  • returns: String content of a PiTimeseries XML file.
Code Block

byte[] getTimeSeriesBytes(String clientId, String id, String taskId, Date startTime,
		Date timeZero, Date endTime,&nbsp;String[] parameterIds, String[] locationIds, String ensembleId, int ensembleMemberIndex);

  • clientId: File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
  • id: Reference to the ID of a TimeSeries element in the service configuration file.
  • taskId: <id not required however can not be null>
  • startTime: Start date/time of run - Long.MAXVALUE if the configured default is to be used
  • timeZero: Forecast time zero.
  • endTime: End date/time of run - Long.MAXVALUE if the configured default is to be used
  • parameterIds: Subset of parmater IDs for which to retrieve timeseries.
  • locationIds: Subset of location IDs for which to retrieve timeseries.
  • ensembleId: Id of the ensemble, can be null.
  • ensembleMemberIndex Ensemble member index for this time series. (Only if configured)
  • returns: Content of the binary file that can be exported together with the PITimeseries XML files.

Setting up PI Service Client

...