ClientConnect API

Introduction

ClientConnect API provides ClientConnect web application and other external systems ability to view Element LIMS data like project, work order, and sample results.

Analyses

API	Description
GET api/Analyses/GetAnalysis/{Id}	No documentation available.
GET api/Analyses/GetAnalyses?MatrixKey={MatrixKey}&ProjectKey={ProjectKey}	No documentation available.
GET api/Analyses/{Id}	No documentation available.
GET api/Analyses?MatrixKey={MatrixKey}&ProjectKey={ProjectKey}	No documentation available.

Clients

API	Description
GET api/Clients/GetClient/{Id}	Gets Client by client ID
GET api/Clients/GetClients?ViewType={ViewType}	No documentation available.
GET api/Clients/{Id}	Gets Client by client ID
GET api/Clients?ViewType={ViewType}	No documentation available.

Contacts

API	Description
GET api/Contacts/GetContacts?Email={Email}	Gets Contact by Email Address
GET api/Contacts?Email={Email}	Gets Contact by Email Address

Containers

API	Description
GET api/Containers/GetContainer/{Id}	No documentation available.
GET api/Containers/GetContainers	No documentation available.
GET api/Containers/{Id}	No documentation available.
GET api/Containers	No documentation available.

CustomFieldDefinitions

API	Description
GET api/CustomFieldDefinitions/GetCustomFieldDefinitions	No documentation available.
GET api/CustomFieldDefinitions/GetCustomFieldDefinitions?CustomFieldTypeID={CustomFieldTypeID}	No documentation available.
GET api/CustomFieldDefinitions	No documentation available.
GET api/CustomFieldDefinitions?CustomFieldTypeID={CustomFieldTypeID}	No documentation available.

Documents

API	Description
GET api/Documents/GetDocuments?ContactKey={ContactKey}&FileGroup={FileGroup}&FromDate={FromDate}&ToDate={ToDate}&ClientID={ClientID}&ProjectKey={ProjectKey}	returns documents
GET api/Documents/GetDocuments?DocumentID={DocumentID}	returns document
GET api/Documents?ContactKey={ContactKey}&FileGroup={FileGroup}&FromDate={FromDate}&ToDate={ToDate}&ClientID={ClientID}&ProjectKey={ProjectKey}	returns documents
GET api/Documents?DocumentID={DocumentID}	returns document

DocumentsCount

API	Description
GET api/DocumentsCount/GetDocumentsCounts?ContactKey={ContactKey}&FromDate={FromDate}&ToDate={ToDate}&FileGroup={FileGroup}&ClientID={ClientID}&ProjectKey={ProjectKey}	Returns count of documents
GET api/DocumentsCount?ContactKey={ContactKey}&FromDate={FromDate}&ToDate={ToDate}&FileGroup={FileGroup}&ClientID={ClientID}&ProjectKey={ProjectKey}	Returns count of documents

Facilities

API	Description
GET api/Facilities/GetFacility/{Id}	No documentation available.
GET api/Facilities/GetFacilities	No documentation available.
GET api/Facilities/{Id}	No documentation available.
GET api/Facilities	No documentation available.

Matrices

API	Description
GET api/Matrices/GetMatrix/{Id}	No documentation available.
GET api/Matrices/GetMatrices	No documentation available.
GET api/Matrices/{Id}	No documentation available.
GET api/Matrices	No documentation available.

Options

API	Description
GET api/Options/GetOption	Returns ClientConnect options
GET api/Options	Returns ClientConnect options

Projects

API	Description
GET api/Projects/GetProject/{Id}	Gets Project by project Key
GET api/Projects/GetProjects?ClientID={ClientID}&ViewType={ViewType}	No documentation available.
GET api/Projects/{Id}	Gets Project by project Key
GET api/Projects?ClientID={ClientID}&ViewType={ViewType}	No documentation available.

ProjectSamples

API	Description
GET api/ProjectSamples/GetProject?ClientID={ClientID}&ProjectKey={ProjectKey}	No documentation available.
GET api/ProjectSamples/GetProject?ProjectSampleID={ProjectSampleID}	No documentation available.
GET api/ProjectSamples?ClientID={ClientID}&ProjectKey={ProjectKey}	No documentation available.
GET api/ProjectSamples?ProjectSampleID={ProjectSampleID}	No documentation available.

ProjectSampleSchedules

API	Description
GET api/ProjectSampleSchedules/GetProjectSampleSchedules?FromDate={FromDate}&ToDate={ToDate}&ClientID={ClientID}&ProjectKey={ProjectKey}&RouteID={RouteID}	No documentation available.
GET api/ProjectSampleSchedules/GetProjectSampleSchedules?ScheduleDate={ScheduleDate}&ClientID={ClientID}&ProjectKey={ProjectKey}&RouteID={RouteID}	No documentation available.
GET api/ProjectSampleSchedules?FromDate={FromDate}&ToDate={ToDate}&ClientID={ClientID}&ProjectKey={ProjectKey}&RouteID={RouteID}	No documentation available.
GET api/ProjectSampleSchedules?ScheduleDate={ScheduleDate}&ClientID={ClientID}&ProjectKey={ProjectKey}&RouteID={RouteID}	No documentation available.

SampleAnalyses

API	Description
GET api/SampleAnalyses/GetSampleAnalyses?WorkOrder={WorkOrder}&Sample={Sample}	Returns sample results
GET api/SampleAnalyses?WorkOrder={WorkOrder}&Sample={Sample}	Returns sample results

Samples

API	Description
GET api/Samples/GetSamples?DateOption={DateOption}&FromDate={FromDate}&ToDate={ToDate}	No documentation available.
GET api/Samples?DateOption={DateOption}&FromDate={FromDate}&ToDate={ToDate}	No documentation available.

SampleSubmissions

API	Description
GET api/SampleSubmissions/GetSampleSubmissions/{Id}	No documentation available.
GET api/SampleSubmissions/GetSampleSubmissions?FromDate={FromDate}&ToDate={ToDate}&UserKey={UserKey}&ClientID={ClientID}&ProjectKey={ProjectKey}	No documentation available.
POST api/SampleSubmissions/PostSampleSubmission	No documentation available.
PUT api/SampleSubmissions/PutSampleSubmission	No documentation available.
DELETE api/SampleSubmissions/DeleteSampleSubmissions/{Id}	No documentation available.
PATCH api/SampleSubmissions/PatchSampleSubmission/{Id}	No documentation available.
POST api/SampleSubmissions/Copy/{id}?ClientID={ClientID}&ProjectKey={ProjectKey}	No documentation available.
GET api/SampleSubmissions/{Id}	No documentation available.
GET api/SampleSubmissions?FromDate={FromDate}&ToDate={ToDate}&UserKey={UserKey}&ClientID={ClientID}&ProjectKey={ProjectKey}	No documentation available.
POST api/SampleSubmissions	No documentation available.
PUT api/SampleSubmissions	No documentation available.
DELETE api/SampleSubmissions/{Id}	No documentation available.
PATCH api/SampleSubmissions/{Id}	No documentation available.
POST api/SampleSubmissions/{id}?ClientID={ClientID}&ProjectKey={ProjectKey}	No documentation available.

SampleTypes

API	Description
GET api/SampleTypes/GetSampleType/{Id}	No documentation available.
GET api/SampleTypes/GetSampleTypes	No documentation available.
GET api/SampleTypes/{Id}	No documentation available.
GET api/SampleTypes	No documentation available.

Shippers

API	Description
GET api/Shippers/GetShipper/{Id}	No documentation available.
GET api/Shippers/GetShippers	No documentation available.
GET api/Shippers/{Id}	No documentation available.
GET api/Shippers	No documentation available.

TimeZones

API	Description
GET api/TimeZones/GetTimeZone/{Id}	No documentation available.
GET api/TimeZones/GetTimeZones	No documentation available.
GET api/TimeZones/{Id}	No documentation available.
GET api/TimeZones	No documentation available.

Translations

API	Description
GET api/Translations/GetTranslations?LanguageCode={LanguageCode}&StringClass={StringClass}	No documentation available.
PUT api/Translations/PutTranslations?LanguageCode={LanguageCode}&StringClass={StringClass}&DefaultString={DefaultString}	No documentation available.
GET api/Translations?LanguageCode={LanguageCode}&StringClass={StringClass}	No documentation available.
PUT api/Translations?LanguageCode={LanguageCode}&StringClass={StringClass}&DefaultString={DefaultString}	No documentation available.

Version

API	Description
GET api/Version/GetVersion	No documentation available.
GET api/Version	No documentation available.

WorkOrders

API	Description
GET api/WorkOrders/GetWorkOrders?DateOption={DateOption}&FromDate={FromDate}&ToDate={ToDate}	No documentation available.
GET api/WorkOrders?DateOption={DateOption}&FromDate={FromDate}&ToDate={ToDate}	No documentation available.

WorkOrdersCount

API	Description
GET api/WorkOrdersCount/GetWorkOrderCounts?DateOption={DateOption}&FromDate={FromDate}&ToDate={ToDate}	No documentation available.
GET api/WorkOrdersCount?DateOption={DateOption}&FromDate={FromDate}&ToDate={ToDate}	No documentation available.