Frequently Asked Questions

API error messages
Note: Since June 2017 API v1 was discontinued and all new evolutions are in API v2.

Message Response code Description
'Requires application authentication to access the Web Service' 401
Unauthorized
The request either does not have the header parameter X-LC-APP-Auth or does not have a valid value
'Invalid Action xxx’ 400
Bad Request
Parameter action has a different value to ‘tube_sorter’ or ‘getBackup’
Missing Search Parameters! 400
Bad Request
The request contains the parameter Action=tube_sorter but it is missing at least one of the following parameters: box_id, box_name, record_name, unique_code, barcode, aliquot_barcode
'Module “XXX" does not exist!' 400
Bad Request
The value of the parameter ‘module’ is not a LabCollector module
'Module "XXX" does not share this data!' 403
Forbidden
The value of the parameter ‘module’ is not checked on LC > Admin > Setup > Web service
‘The format of the request is not accepted!'
415
Unsupported
Media Type
The parameter Accept is used, but value is not one of the accepted values: application/xml or application/json
(Empty)
406
Not Acceptable
Method must be one of the following: GET, POST, PUT, DELETE
'No data found.'
404
Not Found
No data found with this request’s parameters
'OK.'
200
OK
Record updated successfully
'Conflict.' 409
Conflict
Record could not be updated because there is a conflict in data
'No organisms value for this module' 404
Not Found
Only the modules "strains", "samples" and "microarrays" have an organism value – you have chosen an incorrect module
'No categories value for this module' 404
Not Found
Only the module ‘docs’ has categories – you have chosen an incorrect module
'Webservice requires user authentication' 401
Unauthorized
Deprecated
'Your IP is not allowed to access this Web Service' 401
Unauthorized
The client IP is not in the list of authorized IPs for this webservice (LC > Admin > Setup > Web service)
'Error during your request, the following information is mandatory to create a new record: X, Y, Z '
400
Bad Request
Attempt to post new data without mandatory fields X, Y, Z
'An error has occurred during your request, the following information is mandatory to remove volume: unique_code or barcode or aliquot_barcode, quantity, quantity' 400
Bad Request
Attempt to remove volume without mandatory parameters: unique_code or barcode or aliquot_barcode, quantity
'An error has occurred during your request, the following information is mandatory to remove storage: unique_code or barcode or aliquot_barcode, quantity ' 400
Bad Request
Attempt to remove storage without mandatory parameter: unique_code or barcode or aliquot_barcode
''
200
OK
Data requested was returned successfully


 Last updated Tue, Oct 29 2019 3:15pm