เวอร์ชัน 2.0 – พฤศจิกายน 2021
Web บริการ แอปพลิเคชัน การเขียนโปรแกรม ซอฟต์แวร์อินเทอร์เฟซ
คู่มือการใช้งาน
Web บริการ แอปพลิเคชัน การเขียนโปรแกรม ซอฟต์แวร์อินเทอร์เฟซ
การแนะนำ
นักสะสมแล็บ Web Service Application Programming Interface (API) อนุญาตให้แอปพลิเคชันของบริษัทอื่นโต้ตอบกับฐานข้อมูลของ LabCollector (โมดูล) และส่วนเสริม (ELN และ LSM)
API อิงตามสถาปัตยกรรม Representational State Transfer (REST) ที่อนุญาตให้เข้าถึงทรัพยากรผ่าน Uniform Resource Identifier (URI) และดำเนินการกับทรัพยากรเหล่านั้น
บันทึก: ตั้งแต่มิถุนายน 2017 API v1 ถูกยกเลิกและวิวัฒนาการใหม่ทั้งหมดอยู่ใน API v2
แล็บคอลเลคเตอร์ API
2-1. การตั้งค่า API
ก่อนอื่น คุณต้องประกาศแอปพลิเคชันของคุณในซอฟต์แวร์ LabCollector ในการเข้าถึงแบบฟอร์มการตั้งค่าการประกาศแอปพลิเคชัน ให้เข้าสู่ระบบ LabCollector ด้วยสิทธิ์ผู้ดูแลระบบขั้นสูง และไปที่หน้าผู้ดูแลระบบ > การตั้งค่า จากนั้นเลือก Web ลิงก์บริการ API 
ตอนนี้คุณอยู่ที่ Web หน้าการจัดการแอปพลิเคชัน Service API ในการประกาศใบสมัครใหม่ เพียงกรอกแบบฟอร์มนี้: 
- ชื่อ: ชื่อแอปพลิเคชันของคุณ
- โมดูลที่เชื่อมต่อกับแอปพลิเคชันนี้: เลือกโมดูลที่แอปพลิเคชันสามารถเข้าถึงได้
- ตัวดำเนินการเริ่มต้น: เลือกผู้ติดต่อที่จะเป็นโอเปอเรเตอร์เริ่มต้น หากคุณไม่ต้องการแทรกข้อมูลนี้ในแต่ละคำขอ
- การจำกัด IP: ตัวเลือกความปลอดภัยช่วยให้คุณประกาศรายการที่อยู่ IP ซึ่งจะอนุญาตให้คุณดำเนินการตามคำขอบน API
รายการแอปพลิเคชันจะแสดงแอปพลิเคชันทั้งหมดสำหรับ LabCollector ของคุณ และคุณสามารถปรับเปลี่ยนขอบเขตได้ตลอดเวลา
คุณยังมีสิทธิ์เข้าถึงโทเค็นซึ่งจำเป็นสำหรับระบุแอปพลิเคชันของคุณระหว่างที่ส่งคำขอไปยัง API 
บันทึก: หากต้องการใช้คุณสมบัตินี้ คุณต้องเปิดใช้งาน Curl ในการตั้งค่า PHP ของคุณ ใน Linux ให้ติดตั้ง PHP-Curl บรรจุุภัณฑ์.
บน windows และด้วยโปรแกรมติดตั้งอัตโนมัติของเรา ให้แก้ไข PHP.ini และส่วนขยายที่ไม่แสดงข้อคิดเห็นสำหรับ Curl (นามสกุล=php_curl.dll)
2-2. คำขอ
กล่องโต้ตอบระหว่างแอปพลิเคชันของบริษัทอื่นและ LabCollector web บริการ API ขึ้นอยู่กับโปรโตคอล HTTP 1.1
2-2-1. วิธี API
คุณสามารถส่งคำขอ HTTP หรือ HTTPS ไปที่ web บริการด้วยวิธีการดำเนินการกับทรัพยากร
- GET วิธีอ่านทรัพยากร
- วิธี POST เพื่อสร้างทรัพยากรใหม่
- วิธี PUT เพื่อแก้ไขทรัพยากร
- วิธี DELETE เพื่อลบทรัพยากร
2-2-2. ส่วนหัว
คำขอไปยัง API ต้องการส่วนหัว HTTP/HTTPS เฉพาะบางรายการ:
- ส่วนหัว Accept จะกำหนดรูปแบบการตอบสนองที่ต้องการสำหรับคำขอของคุณ ข้อความ/XML หรือแอปพลิเคชัน/JSON
- ส่วนหัว X-LC-APP-Auth คือที่ที่คุณใส่โทเค็นของแอปพลิเคชันซึ่งจำเป็นต่อการอนุมัติคำขอของคุณไปยัง API
- ส่วนหัว X-LC-APP-Charset กำหนดการเข้ารหัสอักขระของแอปพลิเคชันของคุณ อนุญาตให้ API ส่งการตอบสนองกลับด้วยการเข้ารหัสที่เหมาะสม และแปลงคำขอ POST และ PUT ของคุณให้เป็นการเข้ารหัสอักขระของ LabCollector (ISO 8859-1) ได้อย่างถูกต้อง
2-2-3. เครื่องมือ
คุณสามารถลองดึงข้อมูลจากหรือส่งข้อมูลไปยัง API ด้วยแอพซอฟต์แวร์บางตัวเป็นบุรุษไปรษณีย์ (https://www.getpostman.com/).
ตัวระบุทรัพยากรสากล (URI)
2-3-1. รับเมธอd
ทั่วไป
ข้อมูลโมดูล LabCollector แต่ละรายการจะถูกระบุโดย URI ที่ไม่ซ้ำกัน (ดูภาคผนวกสำหรับรายการ URI ทั้งหมดของโมดูล):
[PATH_TO_LABOLLECTOR]/webservice/v2/[MODULE] คำขอนี้ตอบกลับรายการข้อมูลทั้งหมดในโมดูล
คุณสามารถค้นหาข้อมูลโมดูลโดยเพิ่มพารามิเตอร์ลงใน URI ของคุณ คุณสามารถส่งพารามิเตอร์ด้วยคำหลักที่ตรงกับค่าของฟิลด์ เช่น:[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=[KEYWORD]เช่น
[PATH_TO_LABOLLECTOR]/webservice/v2/[MODULE]?name=%20บันทึกแรก
คำขอนี้ส่งคืนระเบียนที่ค่าชื่อมีคีย์เวิร์ด "ระเบียนแรก"
เป็นพารามิเตอร์ที่กำหนดเองบางตัวที่ API ใช้เพื่อดำเนินการค้นหาและกรองข้อมูล
พารามิเตอร์ที่กำหนดเอง
- พารามิเตอร์ record_id เพื่อระบุข้อมูลตาม ID:
คำขอนี้ส่งคืนระเบียนที่มี ID 1 และ ID 19 คุณสามารถระบุ ID หลายรายการได้โดยคั่นด้วยเครื่องหมายจุลภาค
- พารามิเตอร์ by_keywords ดำเนินการค้นหาคีย์เวิร์ด:
คำขอนี้ทำการค้นหาในฟิลด์ทั้งหมดของเรคคอร์ดทั้งหมดและส่งคืนเซลล์ที่ตรงกัน คุณสามารถระบุคำหลักหลายคำโดยคั่นด้วยเครื่องหมายจุลภาค
- พารามิเตอร์ by_keywords ดำเนินการค้นหาคีย์เวิร์ด:
คำขอนี้ทำการค้นหาในฟิลด์ทั้งหมดของเรคคอร์ดทั้งหมดและส่งคืนเซลล์ที่ตรงกัน คุณสามารถระบุคำหลักหลายคำโดยคั่นด้วยเครื่องหมายจุลภาค
- พารามิเตอร์ของฟิลด์ หากคุณต้องการดึงเฉพาะค่าฟิลด์บางส่วนในการตอบกลับ API:
คำขอนี้ส่งคืนระเบียนทั้งหมดจากโมดูล แต่มีเพียงช่องนับและชื่อ คุณสามารถระบุหลายช่องได้โดยคั่นด้วยเครื่องหมายจุลภาค
คำขอยอมรับค่าหลายค่าโดยคั่นด้วยเครื่องหมายจุลภาคสำหรับฟิลด์ที่กำหนดเองประเภท "select"
- พารามิเตอร์ search_on ช่วยให้คุณค้นหาข้อมูลได้ และคุณสามารถใช้เพื่อค้นหาตามช่วงวันที่ดังต่อไปนี้:
search_on=date_field&from=XXXXXX&to=ZZZZZZ
หากคุณใช้เฉพาะ FROM ผลลัพธ์จะให้วันที่ทั้งหมดมากกว่าวันที่ FROM ถ้าคุณใช้แค่เหมือนกัน มันจะคืนค่าทั้งหมดจนถึงวันที่นี้
- พารามิเตอร์ sort_by ช่วยให้คุณสามารถจัดเรียงการค้นหาของคุณ:
[PATH_TO_LABOLLECTOR]/webบริการ/v2/[MODULE]?sort_by=[FIELD1]_DESC
เช่น [PATH_TO_LABOLLECTOR]/webบริการ/v2/[MODULE]?sort_by=name_DESC
คำขอนี้ส่งคืนระเบียนทั้งหมดที่เรียงลำดับจากมากไปหาน้อยในฟิลด์ชื่อ คุณสามารถระบุ sort_by ได้หลายรายการโดยคั่นด้วยเครื่องหมายจุลภาคและลำดับที่ระบุ _ASC” หรือลำดับรอง “_DESC” สำหรับแต่ละฟิลด์
- พารามิเตอร์ limit_to อนุญาตให้คุณจำกัดจำนวนผลลัพธ์:
[PATH_TO_LABOLLECTOR]/webบริการ/v2/[MODULE]?limit_to=0,10
คำขอนี้ส่งคืนระเบียน 10 รายการโดยเริ่มต้นที่ดัชนี 0 หากคุณไม่ระบุดัชนี ระบบจะส่งกลับเฉพาะจำนวนผลลัพธ์ที่ระบุเท่านั้น
API ยังส่งคืนฟิลด์ที่กำหนดเองสองฟิลด์ในการตอบกลับส่วนหัว "X-LC-QUERY-RESULT" ที่มีจำนวนผลลัพธ์ที่ส่งคืนในการตอบกลับเนื้อหาและ "X-LC-QUERY- TOTAL" ที่มีระเบียนทั้งหมดที่ตรงกับการค้นหาของคุณ
แต่ละเร็กคอร์ดยังมี URI ที่ไม่ซ้ำกัน:
[PATH_TO_LABOLLECTOR]/webservice/v2/[MODULE]/[DATA_ID] คำขอนี้ตอบกลับบันทึกที่ไม่ซ้ำ [DATA_ID] ต้องตรงกับ ID เฉพาะของบันทึกที่คุณต้องการดึงข้อมูล
พื้นที่จัดเก็บ
คุณยังมีฟังก์ชันการกรอง Tube Sorter สำหรับทุกรายการที่เชื่อมโยงกับที่เก็บข้อมูล:
[PATH_TO_LABOLLECTOR]/webservice/index.php?v=2&action=tube_sorter&box_i d=[BOX_ID] เช่น [PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&action=tube_sorter&box_i d=34
คำขอนี้ส่งคืนข้อมูลการจัดเก็บบนกล่อง ID 34 เช่นตัวเรียงลำดับหลอด คุณสามารถระบุ ID ได้หลาย ID โดยคั่นด้วยเครื่องหมายจุลภาค 
[PATH_TO_LABOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&recor d_name=[RECORD_NAME] เช่น [PATH_TO_LABCOLLECTOR]/webบริการ/index.PHP?v=2&action=tube_sorter&recor d_name=ST-260
คำขอเหล่านี้ดำเนินการกรองระเบียนชื่อ ST-260 คุณสามารถระบุชื่อระเบียนได้หลายชื่อโดยคั่นด้วยเครื่องหมายจุลภาค คุณยังสามารถระบุ ID ของกล่องได้ที่นี่ 206[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_n ame=[BOX_NAME] เช่น [PATH_TO_LABCOLLECTOR]/webบริการ/index.PHP?v=2&action=tube_sorter&box_n ame=test-rack_06
คำขอนี้ดำเนินการกรองบนกล่อง test-rack_06 คุณสามารถระบุชื่อกล่องหลายช่องได้โดยคั่นด้วยเครื่องหมายจุลภาค
พารามิเตอร์การค้นหาอื่น ๆ เพื่อ action=tube_sorter สามารถ:
- Location_id
- ชื่อสถานที่
- สิ่งอำนวยความสะดวก_id
- ชื่อสถานที่
มันจะส่งคืนกล่องเปล่าเช่นกัน - พารามิเตอร์ storage_sec อนุญาตให้ดึงข้อมูลเกี่ยวกับหน่วยเก็บข้อมูลสำรอง
ล็อตสินค้า
- การดำเนินการรับล็อตช่วยให้สามารถดึงข้อมูลล็อตและรีเอเจนต์ได้
[PATH_TO_LABOLLECTOR]/webservice/index.PHP?v=2&action=getLot&lo t_id=1/LT
[PATH_TO_LABOLLECTOR]/webservice/index.PHP?v=2&action=getLot&ch em_id=2
พารามิเตอร์ทางเลือกคือ lot_id (ในรูปแบบ 1 หรือ 1/LT) และ chem_id หากไม่ได้รับพารามิเตอร์ ก็จะดึงล็อตที่ใช้งานอยู่ทั้งหมด
สูตรอาหาร
[PATH_TO_LABOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe s
[PATH_TO_LABOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe &recipe_id=[record_id] เช่น [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe &recipe_id=509
[PATH_TO_LABOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Logs
[PATH_TO_LABOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Report&log_id=[record_id] เช่น [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Report&log_id=1218
รหัสคือexampแต่บังคับในการเรียกเหล่านี้
รับสูตรพิมพ์ข้อมูลต่อไปนี้: id, ชื่อ, คำอธิบาย, หมวดหมู่
รับสูตรพิมพ์ข้อมูลต่อไปนี้สำหรับ formula_id นั้น: id, ชื่อ, คำอธิบาย, หมวดหมู่แล้วส่วนประกอบ 
getRecipeLogs พิมพ์ข้อมูลต่อไปนี้: id, ชื่อ, คำอธิบาย, category 
getRecipeReport พิมพ์รายงาน PDF สำหรับ log_id นั้นภายใต้รูปแบบ base64 ที่สามารถถอดรหัสเป็น PDF 
2-3-2. วิธีโพสต์
ในการสร้างทรัพยากรใหม่ เพียงส่งคำขอด้วยวิธี POST ไปยังโมดูล URI ที่ต้องการ:
[PATH_TO_LABOLLECTOR]/webservice/v2/[MODULE] คีย์พารามิเตอร์ของคุณจะต้องตรงกับชื่อของฟิลด์
ตรวจสอบฟิลด์ไม่ซ้ำกันที่เพิ่มเข้ามา เมื่อสร้างเรกคอร์ดใหม่ (POST) หรืออัพเดต (PUT)
หากมีระเบียนอื่นที่มีค่าเดียวกันสำหรับช่อง Uniqueness API จะไม่ดำเนินการให้เสร็จสิ้น และจะส่งคืนรหัส 409 (ความขัดแย้ง) และข้อความ: ค่าสำหรับช่อง 'XXX' จะต้องไม่ซ้ำกัน ค่า 'YYY' มีอยู่แล้วในตาราง 'ZZZ' (ดูภาพหน้าจอ) 
บันทึก: ฟิลด์ project_code สามารถใช้ใน POST และ PUT และต้องการข้อความ (ไม่ใช่ id) ขณะนี้ คุณสามารถสร้างรหัสโครงการใหม่ได้หากไม่มีอยู่และหากตัวดำเนินการมีสิทธิ์เพียงพอ (ผู้ดูแลระบบหรือผู้ดูแลระบบระดับสูง)
- การกระทำ addBox ช่วยให้คุณสร้างกล่อง
- พารามิเตอร์ที่จำเป็น:
o ชื่อ
ประเภท o (ต้องเป็นประเภทที่ถูกต้อง: box, box_nogrid, plate, microplate, visit be, bag, shelf part)
o อุปกรณ์ (รองรับ ID หรือชื่อและต้องมีอยู่ในที่เก็บข้อมูล LabCollector)
o ขนาด (ขึ้นอยู่กับชนิดของกล่อง: ควรเป็นตัวเลขสำหรับการเยี่ยมชม และรูปแบบ (A:1.H:8) สำหรับกล่อง เพลท และไมโครเพลท) - พารามิเตอร์เสริม:
o คำอธิบาย
o ชั้นวาง
o ผู้รักษาประตู
2-3-3. วิธีการวาง
หากต้องการแก้ไขทรัพยากร เพียงส่งคำขอด้วยวิธี PUT ไปยัง URI ของระเบียนที่ต้องการ:
[PATH_TO_LABOLLECTOR]/webservice/v2/[MODULE]/[DATA_ID] คีย์พารามิเตอร์ของคุณจะต้องตรงกับชื่อของฟิลด์ที่คุณต้องการแก้ไข
สำหรับการดำเนินการต่อไปนี้ โปรดทราบว่าสำหรับคำขอ PUT พารามิเตอร์ต้องอยู่ในเนื้อหา (ไม่ใช่ใน URL).
การ URL คือ [PATH_TO_LABOLLECTOR]/webบริการ/index.PHP?v=2
ส่วนหัวคือ: X-LC-APP-Auth, ยอมรับ
- ลบโวลุ่ม
– พารามิเตอร์:
o removeVolume (บังคับ)
o บาร์โค้ด, unique_code หรือ aliquot_barcode (ต้องมีอย่างใดอย่างหนึ่ง)
o ปริมาณ (บังคับ)
– ตอบกลับ: ตกลง
- ลบที่เก็บข้อมูล
– พารามิเตอร์:
o ที่เก็บข้อมูลระยะไกล (จำเป็น)
o บาร์โค้ด, unique_code หรือ aliquot_barcode (ต้องมีอย่างใดอย่างหนึ่ง)
– ตอบกลับ: ตกลง
- เพิ่มสมุดทะเบียน
- URL:
[PATH_TO_LABOLLECTOR]/webservice/index.php?v=2&module=[m odule] – พารามิเตอร์:
o addRegistryBook (บังคับ)
o record_id (บังคับ)
o วันที่ (บังคับ รูปแบบ ปปปป/ดด/วว หรือปปปป-ดด-วว)
o ความคิดเห็น (บังคับ)
o โอเปอเรเตอร์ (ตัวเลือก ถ้าไม่ส่ง API ตัวดำเนินการเริ่มต้นจะถูกใช้)
o การดำเนินการ (ไม่บังคับ ต้องเป็น 'ประเภทการดำเนินการที่เก็บข้อมูล' ที่ถูกต้องซึ่งกำหนดไว้ใน LC
>ผู้ดูแลระบบ >ค่ากำหนด > ประเภทกระบวนการและการดำเนินการ)
– ตอบกลับ: ตกลง
- เพิ่มที่เก็บข้อมูลรอง
– พารามิเตอร์:
o เพิ่มที่เก็บข้อมูลสำรอง (จำเป็น)
o บาร์โค้ด (บังคับ)
o box_id (บังคับ)
o box_details (บังคับสำหรับกล่องที่มีตะแกรงแบ่งช่อง ถาดใส่หลอด และไมโครเพลทเท่านั้น หากกล่องนั้นไม่มีตะแกรง ถุง ชิ้นส่วนสำหรับเยี่ยมชมหรือชั้นวาง ก็ไม่จำเป็น)
o unique_code (ไม่บังคับ)
o ปริมาณ (ไม่จำเป็น)
o ความคิดเห็น (ไม่บังคับ)
o cap_color (ไม่จำเป็น)
บันทึก: ข้อความแสดงข้อผิดพลาดจะถูกส่งกลับหากไม่มีพารามิเตอร์บังคับ หากไม่มีบาร์โค้ด หากมีunique_codeแต่ไม่ซ้ำกัน และถ้ามีสีแต่ไม่มี
หากไม่ได้รับพารามิเตอร์ box_details และประเภทของกล่องต้องการตำแหน่ง (กล่องที่มีกริด ถาดใส่หลอด หรือไมโครเพลท) ข้อความแสดงข้อผิดพลาดจะถูกส่งกลับ 
บันทึก: ฟิลด์ project_code สามารถใช้ใน POST และ PUT และต้องการข้อความ (ไม่ใช่ id) ขณะนี้ คุณสามารถสร้างรหัสโครงการใหม่ได้หากไม่มีอยู่และหากตัวดำเนินการมีสิทธิ์เพียงพอ (ผู้ดูแลระบบหรือผู้ดูแลระบบระดับสูง)
2-3-4. วิธีลบ
หากต้องการลบทรัพยากร เพียงส่งคำขอด้วยวิธี DELETE ไปยัง URI ของระเบียนที่ต้องการ:
[PATH_TO_LABOLLECTOR]/webบริการ/v2/[MODULE]/[DATA_ID]
ข้อความแสดงข้อผิดพลาดของ API
| ข้อความ | รหัสตอบกลับ | คำอธิบาย |
| ต้องมีการตรวจสอบสิทธิ์แอปพลิเคชันเพื่อเข้าถึง Web บริการ' | 401 ไม่ได้รับอนุญาต | คำขอไม่มีพารามิเตอร์ส่วนหัว X- LC-APP-Auth หรือไม่มีค่าที่ถูกต้อง |
| 'xxx การกระทำที่ไม่ถูกต้อง' | 400 คำขอไม่ถูกต้อง | การทำงานของพารามิเตอร์มีค่าแตกต่างจาก 'tube_sorter' หรือ 'NetBackup' |
| ไม่มีพารามิเตอร์การค้นหา! | 400 คำขอไม่ถูกต้อง | คำขอมีพารามิเตอร์ Action=tube_sorter แต่ไม่มีพารามิเตอร์ต่อไปนี้อย่างน้อยหนึ่งตัว: box_id, box_name, record_name, unique_code, บาร์โค้ด, aliquot_barcode |
| ไม่มีโมดูล “XXX”!' | 400 คำขอไม่ถูกต้อง | ค่าของพารามิเตอร์ 'โมดูล' ไม่ใช่โมดูลตัวรวบรวม GB |
| โมดูล “XXX” ไม่เปิดเผยข้อมูลนี้!' | 403 ต้องห้าม | ค่าของพารามิเตอร์ 'โมดูล' ไม่ได้ถูกตรวจสอบบน LabCollector > ผู้ดูแลระบบ > ตั้งค่า > Web บริการ |
| 'รูปแบบคำขอไม่ได้รับการยอมรับ!' | 415 ประเภทสื่อที่ไม่รองรับ | ใช้พารามิเตอร์ Accept แต่ค่านี้ไม่ใช่ค่าที่ยอมรับ: application/XML หรือ application/JSON |
| (ว่างเปล่า) | 406 ไม่เป็นที่ยอมรับ | วิธีการต้องเป็นหนึ่งในวิธีต่อไปนี้: GET, POST, PUT, DELETE |
| 'ไม่พบข้อมูล.' | 404 ไม่พบ | ไม่พบข้อมูลกับพารามิเตอร์ของคำขอนี้ |
| 'ตกลง.' | 200 ตกลง | อัพเดทบันทึกเรียบร้อยแล้ว |
| 'ขัดแย้ง.' | 409 ความขัดแย้ง | ไม่สามารถอัปเดตบันทึกได้เนื่องจากมี ความขัดแย้งในข้อมูล |
| ไม่มีค่าสิ่งมีชีวิตสำหรับโมดูลนี้ | 404 ไม่พบ | เฉพาะโมดูล "สายพันธุ์", "samples” และไมโครอาร์เรย์” มีค่าสิ่งมีชีวิต – คุณเลือกที่ไม่ถูกต้อง โมดูล |
| ไม่มีค่าหมวดหมู่สำหรับโมดูลนี้ | 404 ไม่พบ | เฉพาะโมดูล 'เอกสาร' เท่านั้นที่มีหมวดหมู่ – คุณเลือกแล้ว โมดูลที่ไม่ถูกต้อง |
| Webบริการต้องมีการตรวจสอบผู้ใช้ | 401 ไม่ได้รับอนุญาต | ไม่สนับสนุนอีกต่อไป |
| IP ของคุณไม่ได้รับอนุญาตให้เข้าถึงสิ่งนี้ Web บริการ' | 401 ไม่ได้รับอนุญาต | IP ไคลเอ็นต์ไม่อยู่ในรายการ IP ที่ได้รับอนุญาตสำหรับสิ่งนี้ Webบริการ (LC > ผู้ดูแลระบบ > ตั้งค่า > Web บริการ) |
| เกิดข้อผิดพลาดระหว่างคำขอของคุณ ข้อมูลต่อไปนี้จำเป็นต้องสร้างใหม่ บันทึก: X, Y, Z ' |
400 คำขอไม่ถูกต้อง | พยายามโพสต์ข้อมูลใหม่โดยไม่มีฟิลด์บังคับ X, Y, Z |
| เกิดข้อผิดพลาดระหว่างคำขอของคุณ ข้อมูลต่อไปนี้จำเป็นต้องลบโวลุ่ม: unique_code หรือบาร์โค้ดหรือ aliquot_barcode ปริมาณ ปริมาณ | 400 คำขอไม่ถูกต้อง | พยายามลบโวลุ่มโดยไม่ต้องบังคับ พารามิเตอร์: unique_code หรือบาร์โค้ดหรือ aliquot_barcode ปริมาณ |
| เกิดข้อผิดพลาดระหว่างการร้องขอของคุณ ข้อมูลต่อไปนี้เป็นข้อบังคับเพื่อ ลบที่เก็บข้อมูล: บาร์โค้ด unique_codeor หรือ aliquot_barcode ปริมาณ ' |
400 คำขอไม่ถูกต้อง | พยายามลบที่เก็บข้อมูลโดยไม่จำเป็น พารามิเตอร์: unique_code หรือบาร์โค้ดหรือ aliquot_barcode |
| - | 200 ตกลง | ข้อมูลที่ร้องขอถูกส่งกลับเรียบร้อยแล้ว |
แล็บคอลเลคเตอร์ WEB เซอร์วิส API – ภาคผนวก
ระบบ URI ของ API ใช้ระบบที่เรียบง่ายและสะอาด URL. อย่าลืมเปิดใช้งานเอ็นจิ้นการเขียนซ้ำจาก Apache เพื่อใช้ URI ที่อ้างอิงในตารางต่อไปนี้ หากเซิร์ฟเวอร์ LabCollector ไม่รองรับเอ็นจิ้นการเขียนซ้ำ โปรดใช้ตัวเต็ม URL รูปแบบสำหรับคำขอของคุณ (รอง URL ของแต่ละสาย)
| UM | โมดูล | คำอธิบาย | |
| webบริการ/v2/สายพันธุ์ webบริการ/index.PHP?v=2&module=strai ns | รับโพสต์ | สายพันธุ์และเซลล์ | รายการบันทึกทั้งหมด |
| webบริการ/v2/สายพันธุ์/(DATA JD] webบริการ/index.PHP?v=2&module=strai ns&data jd.[DATA _ID] | รับวาง | สายพันธุ์และเซลล์ | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/สายพันธุ์/ฟิลด์ที่กำหนดเอง webservice/index.php?v=2&module=strai ns&getModuleCustomFields=1 | รับ | สายพันธุ์และเซลล์ | รายการฟิลด์ที่กำหนดเอง |
| webบริการ/v2/สายพันธุ์/สิ่งมีชีวิต webบริการ/index.PHP?v=2&module=strai ns&getModuleOrganisms=1 | รับ | สิ่งมีชีวิตสายพันธุ์และเซลล์ | รายชื่อของ |
| webบริการ/v2/พลาสมิด webservice/index.php?v=2&module=plas mids | รับโพสต์ | พลาสมิด | รายการบันทึกทั้งหมด |
| webบริการ/v2/พลาสมิด/IDATAjD] webservice/index.php?v=2&module=plasmids&data _id=IDATA _ID] | รับ ใส่ | พลาสมิด | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/พลาสมิด/ฟิลด์ที่กำหนดเอง webบริการ/index.PHP?v=2&module=plas mids&getModuleCustomFields=1 | รับ | ทุ่งพลาสมิด | รายการกำหนดเอง |
| webบริการ/v2/ไพรเมอร์ webservice/index.PHP?v=2&module=pri mers | รับโพสต์ | ไพรเมอร์ | รายการบันทึกทั้งหมด |
| webบริการ/v2/ไพรเมอร์/[DATA JD] webservice/index.PHP?v=2&module=pri mers&data _idADATA _ID] | วาง GET | ไพรเมอร์ | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/ไพรเมอร์/ฟิลด์กำหนดเอง | รับ | ไพรเมอร์ | รายการฟิลด์ที่กำหนดเอง |
| webบริการ/index.PHP?v=2&module=pri mers&getModuleCustomFields=1 | |||
| webบริการ/v2/เคมีภัณฑ์ webservice/index.PHP?v=2&module=che micals | รับโพสต์ | รีเอเจนต์และวัสดุสิ้นเปลือง | รายการบันทึกทั้งหมด |
| webบริการ/v2/เคมีภัณฑ์/IDATA _ID] webบริการ/index.PHP?v=2&module=che micals&data_idADATA _ID] | รับวาง | รีเอเจนต์และวัสดุสิ้นเปลือง | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/เคมีภัณฑ์/ฟิลด์กำหนดเอง webบริการ/index.PHP?v=2&module=che micals&getModuleCustomFields=1 | รับ | เขตข้อมูลรีเอเจนต์และวัสดุสิ้นเปลือง | รายการกำหนดเอง |
| webบริการ/v2/sampเลส webservice/index.PHP?v=2&module=sam pies | รับโพสต์ | Sampเลส | รายการบันทึกทั้งหมด |
| webบริการ/v2/sampไฟล์/IDATA_ID) web บริการ/index.PHP?v=2&module=sam ples&data_id=[DATA _ID] | รับวาง | Sampเลส | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/sampไฟล์/ฟิลด์กำหนดเอง webบริการ/index.PHP?v=2&module=sam ples&getModuleCustomFields=1 | รับ | Sampเลส | รายการฟิลด์ที่กำหนดเอง |
| webบริการ/v2/sampเลส/สิ่งมีชีวิต webบริการ/index.php?v=2&module=sam ples&getModuleOrganisms=1 | รับ | Sampเลส | รายชื่อสิ่งมีชีวิต |
| webบริการ/v2/sampไฟล์/ประเภท webบริการ/index.PHP?v=2&module=sam ples&getModuleTypes=1 | รับ | Sampเลส | รายการของ sampประเภทไฟล์ |
| webบริการ/v2/แอนติบอดี webservice/index.PHP?v=2&module=antibody | รับโพสต์ | แอนติบอดี | รายการบันทึกทั้งหมด |
| webบริการ/v2/แอนติบอดี/(DATA _iDi webservice/index.PHP?v=2&module=antibody&data_id=IDATA _ID] | รับวาง | แอนติบอดี | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/แอนติบอดี/ฟิลด์ที่กำหนดเอง webservice/index.PHP?v=2&module=antibody&getModuleCustomFields=1 | รับ | เขตข้อมูลแอนติบอดี | รายการกำหนดเอง |
| webบริการ/v2/ลำดับ webservice/index.PHP?v=2&module=seq uences | รับโพสต์ | ลำดับ | รายการบันทึกทั้งหมด |
| webบริการ/v2/ลำดับ/(DATA _iDI webservice/index.PHP?v=2&module=seq uences&data _icHCIATA JD] | รับ ใส่ |
ลำดับ | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/ลำดับ/ฟิลด์ที่กำหนดเอง webบริการ/index.PHP?v=2&module=seq uences&getModuleCustomFields=1 | รับ | ฟิลด์ลำดับ | รายการกำหนดเอง |
| webบริการ/v2/สัตว์ webservice/index.PHP?v=2&module=ani mats | รับโพสต์ | สัตว์ | รายการบันทึกทั้งหมด |
| webบริการ/v2/สัตว์/(DATA JD] webบริการ/index.PHP?v=2&module=ani mals&data _ick[DATA JD] | รับ ใส่ | สัตว์ | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/สัตว์/ฟิลด์กำหนดเอง webservice/index.PHP?v=2&module=ani malsketModuleCustomFields=1 | รับ | สัตว์ | รายการฟิลด์ที่กำหนดเอง |
| webบริการ/v2/อุปกรณ์ webservice/index.php?v=2&module=equi pments | รับโพสต์ | อุปกรณ์ | รายการบันทึกทั้งหมด |
| webบริการ/v2/อุปกรณ์/PATA _el Webservice/index.php?v=2&module=equi pments&data _idADATA _ID] | รับวาง | อุปกรณ์ | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/อุปกรณ์/ฟิลด์ที่กำหนดเอง webservice/index.PHP?v=2&module=equi pments&getModuleCustomFields=1 | รับ | อุปกรณ์สนาม | รายการกำหนดเอง |
| webบริการ/v2/โครงสร้าง webservice/index.PHP?v=2&module=stru cures | รับโพสต์ | โครงสร้างทางเคมี | รายการบันทึกทั้งหมด |
| webบริการ/v2/โครงสร้าง/(DATA_ID] webบริการ/index.PHP?v=2&module=stru ctures&data jd=(DATA JD] | รับวาง | โครงสร้างทางเคมี | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/โครงสร้าง/ฟิลด์ที่กำหนดเอง webบริการ/index.PHP?v=2&module=stru cturesketModuleCustomFields=1 | รับ | โครงสร้างทางเคมี | รายการฟิลด์ที่กำหนดเอง |
| webบริการ/v2/docs webบริการ/index.PHP?v=2&module=docs | รับโพสต์ | เอกสาร | รายการบันทึกทั้งหมด |
| webบริการ/v2/docs/(DATA JD] webservice/index.PHP?v=2&module=docs &data _idADATA _ID] | รับวาง | เอกสาร | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/เอกสาร/ฟิลด์ที่กำหนดเอง webservice/index.php?v=2&module=docs &getModuleCustomFields=1 | รับ | เอกสาร | รายการฟิลด์ที่กำหนดเอง |
| webบริการ/v2/เอกสาร/หมวดหมู่ webservice/index.PHP?v=2&module=docs &getModuleCategories=1 | รับ | หมวดหมู่เอกสาร | รายชื่อของ |
| webบริการ/v2/หนังสือ webservice/index.PHP?v=2&module=abo ok | รับโพสต์ | สมุดที่อยู่ | รายการบันทึกทั้งหมด |
| webบริการ/v2/หนังสือ/(DATA _ID] webservice/index.php?v=2&module=abo ok&data_idADATA _ID] | รับวาง | สมุดที่อยู่ | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/หนังสือ/ช่องกำหนดเอง webบริการ/index.PHP?v=2&module=abo ok&getModuleCustomFields=1 | รับ | สมุดที่อยู่ | รายการฟิลด์ที่กำหนดเอง |
| webบริการ/v2/หนังสือ/หมวดหมู่ webบริการ/index.PHP?v=2&module=abo ok&getModuleCategories=1 | รับ | หมวดหมู่สมุดที่อยู่ | รายชื่อของ |
| webบริการ/v2/microarrays webservice/index.PHP?v=2&module=micr arrays | รับโพสต์ | ไมโครอาร์เรย์ | รายการบันทึกทั้งหมด |
| webบริการ/v2/microarrays/(DATA_ID] webบริการ/index.PHP?v=2&module=micr oarrays&data_id=[DATA _ID] | รับ ใส่ | ไมโครอาร์เรย์ | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/microarrays/ฟิลด์ที่กำหนดเอง webบริการ/index.PHP?v=2&module=micr oarrays&getModuleCustomFields=1 | รับ | ไมโครอาร์เรย์ | รายการฟิลด์ที่กำหนดเอง |
| webบริการ/v2/microarrays/สิ่งมีชีวิต webบริการ/index.PHP?v=2&module=micr oarrays&getModuleOrganisms=1 | รับ | สิ่งมีชีวิตไมโครเรย์ | รายชื่อของ |
| webบริการ/v2/(CUSTOM_MODULE_NAM El webservice/index.PHP?v=2&module=ECU STOM_MODULE_NAMEI |
รับโพสต์ | โมดูลที่กำหนดเอง | รายการบันทึกทั้งหมด |
| webบริการ/v2/(CUSTOM_MODULE_NAM EMIDATA _ID] webบริการ/index.PHP?v=2&module=[CU STOM_MODULE_NAME] &data_id=[DATA _ID] | รับวาง | โมดูลที่กำหนดเอง | บันทึกที่ไม่ซ้ำ |
| webบริการ/v2/(CUSTOM_MODULE_NAM Elicustomfields webบริการ/index.PHP?v=2&module=[CU STOM_MODULE_NAME184getModuleCust omFields=1 | รับ | โมดูลที่กำหนดเอง | รายการฟิลด์ที่กำหนดเอง |
http://www.labcollector.comsales@agilebio.com
AgileBio สหรัฐอเมริกา
5473 เคียร์นี่ วิลล่า โร้ด สวีท 255
ซานดิเอโก, แคลิฟอร์เนีย 92123
สหรัฐอเมริกา
โทร: 347 368 1315
แฟกซ์ : (800) 453 9128
http://www.agilebio.com
สำนักงานใหญ่ AgileBio
75 ถนน เดอ ลูร์เมล
75015 ปารีส
ฝรั่งเศส
โทร : 01 41 79 15 85
แฟกซ์ : 01 72 70 40 22
เอกสาร / แหล่งข้อมูล
 |
แล็บคอลเลคเตอร์ Web บริการ แอปพลิเคชัน การเขียนโปรแกรม ซอฟต์แวร์อินเทอร์เฟซ [พีดีเอฟ] คู่มือการใช้งาน Web บริการ Application Programming Interface, ซอฟต์แวร์, Web บริการ แอปพลิเคชัน การเขียนโปรแกรม ซอฟต์แวร์อินเทอร์เฟซ |
