GET api/Samples/GetSamples?DateOption={DateOption}&FromDate={FromDate}&ToDate={ToDate}

Request Information

URI Parameters

Name	Type	Additional information
DateOption	DateOptionEnum	Required
FromDate	date	Required
ToDate	date	Required

Body Parameters

SampleFilterOption

Name	Description	Type	Additional information
FilterKeys	List of Project Keys or Client IDs	Collection of string	None.
FilterType	Type of Filter Keys. 1 = Client IDs and 2 = Project Keys	KeyFilterEnum	None.
StatusType	Status types 0 = None, 1 = Pending , 2 = In Progress, 3 = Completed , 98 = Custom , 99 = Cancelled	StatusFilterEnum	None.
WorkOrder	Work Order number	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FilterKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "FilterType": 0,
  "StatusType": 0,
  "WorkOrder": "sample string 1"
}

application/xml, text/xml

Sample:

<SampleFilterOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Promium.ClientConnectAPI">
  <FilterKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FilterKeys>
  <FilterType>None</FilterType>
  <StatusType>None</StatusType>
  <WorkOrder>sample string 1</WorkOrder>
</SampleFilterOption>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WrkSample

Name	Description	Type	Additional information
Wrk		string	None.
Sample		string	None.
SampleType		string	None.
SampleName		string	None.
SampleAlias		string	None.
SampleRegID		string	None.
MatrixName		string	None.
ClientMatrixName		string	None.
SampleReceived		date	None.
Sampled		date	None.
SpecialInfos	List of custom fields	Collection of SpecialInfo	None.
Analyses	List of Analyses	Collection of WrkSampleAnalysis	None.
Documents	List of documents	Collection of DocumentMetadata	None.

Response Formats

application/json, text/json

Sample:

Sample not available.