Method FindAnalyteOptions

Namespace

Everest.Service.ChemTypes

Assembly

Everest.Service.dll

FindAnalyteOptions(ComponentOptionSearchRequestContract)

Searches for chemicals to be used as analytes in a mixture based on the specified search criteria.

[OperationContract]
[SwaggerWcfTag("Chemicals", false)]
[SwaggerWcfPath(null, null, null, null, null, false, null, Summary = "Search for analyte selection options.", Description = "Searches for chemicals for use as analytes in a mixture")]
[WebInvoke(UriTemplate = "Overview/Analytes", Method = "POST", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
[SwaggerWcfResponse(StatusCode = HttpStatusCode.OK, Description = "Success")]
[SwaggerWcfResponse(StatusCode = HttpStatusCode.InternalServerError, Description = "An unexpected error occurred while processing the request.", Type = typeof(JsonErrorMessage))]
[SwaggerWcfResponse(StatusCode = HttpStatusCode.BadRequest, Description = "Fault exception", Type = typeof(JsonErrorMessage))]
AnalyteSelectionOptionsSearchResultContract FindAnalyteOptions(ComponentOptionSearchRequestContract searchRequest)

Parameters

searchRequest ComponentOptionSearchRequestContract

The search criteria for finding analyte selection options, encapsulated in a ComponentOptionSearchRequestContract object.

Returns

AnalyteSelectionOptionsSearchResultContract

A AnalyteSelectionOptionsSearchResultContract containing the search results for analyte options.

Remarks

This method is accessible via a POST request to the "Overview/Analytes" endpoint.

Exceptions

FaultException<TDetail>

Thrown when a fault occurs during the operation.