Test the LSM API

1. Available methods in LSM web service

Note: URL works with http and https

• Method: GET
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Optional parameters: datefrom, dateto, jobid, sampleid, assayid, status (by default only jobs in progress are returned, use status=all to view all the jobs)

• Method: GET
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2&getEquipmentList=1
• Optional parameters: id

• Method: GET
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2&getAssayList=1
• Optional parameters: id

• Method: GET
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2&getCategoryList=1
• Optional parameters: id

• Method: GET
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2&getSampleTypeList=1
• Optional parameters: id

• Method: GET
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2&getParameterList=1
• Optional parameters: id, level (level=J returns job parameters, level=S returns sample parameters, level=A returns test parameters)

• Method: GET
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2&getRequesterList=1
• Optional parameters: id

• Method: POST
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Required parameter: create

Example of create:

<requesters>
<requester code='R01' name='Requester from API' taxNumber='12346789'>
<billing address='One street' city='City' state='State' country='US' zip='99999' phone='555123123' fax='555123123' contactFirstName='Jane' contactLastName='Doe' contactEmail='[email protected]' ></billing> 
<shipping address='One street' city='City' state='State' country='US' zip='99999' phone='555123123' fax='555123123' contactFirstName='Jane' contactLastName='Doe' contactEmail='[email protected]' ></shipping> 
</requester>
</requesters>

• Method: POST
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Required parameter: create

Example of create:

<jobs> 
<job number='XP-001' requester='1'> 
<parameter id='1' value='text'></parameter>
<sample name='sample01' type='1' comment='notes'>
<assay id='1'></assay> 
<assay id='2'></assay> 
</sample> 
</job> 
</jobs>

• Method: POST
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Required parameter: result

Example of result:

<assays>
<assay uniqueid="1223"><result><parameter id="34" unit="mg" value="123"/><parameter id="35" unit="ml" value="456"/>
</result>
</assay>
</assays>

• Method: GET
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2&getInvoiceList=1
• Optional parameter: id, datefrom, dateto, status, format (CSV | IIF)

• Method: PUT
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Required parameters: upload, file, uniqueid (identifier of job-sample-assay)
• Optional parameter: supports parameter id or parameter name
• Response: OK 200

• Method: PUT
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Required parameters: sampleid (identifier of sample), module (module name or short name), recordid (identifier of record in module)
• Response: OK 200

• Method: PUT
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Required parameters: sampleid (identifier of sample), shipmentstatus (Use 0 for Submitted, 1 for In transit, 2 for Received, 3 for Returned)
• Response: OK 200

      1.15. Update sample

• Method: PUT
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Parameters REQUIRED: sampleid (identifier of sample) or samplename
• Parameters OPTIONAL: shipmentstatus    name     type    batch
  * Note: sampleid supports multiple ids separated by a comma.
  ** Note: shipmentstatus supports the following numbers or labels: 0|Submitted, 1|In transit, 2|Received, 3|Returned

      1.16. Start a batch

• Method: PUT
• URL: http://[my_labcollector_url]/extra_modules/lsm/webservice/index.php?v=2
• Parameters REQUIRED:   batch (batch name)      startedby (user id valid in LSM (or 1 for super admin)
• Parameters OPTIONAL:   startedon

2. Authentication

One HEADER parameter is mandatory:

• Key: X-LC-APP-Auth
• Value: The token you can view/generate in LabCollector > Admin > Others > Setup > Web services API

3. Tool

You can try to retrieve data from or send data to the API with software apps such as Postman. See KB-Testing LabCollector REST API.

4. Screenshots

Related topics:

• Check our LSM API usage manual.
• Read our KB on how to start with LSM.
• Read our KB on How to restart a job in LSM.