ليب ڪليڪٽر - لوگونسخو 2.0 - نومبر 2021
Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر
استعمال ڪندڙ ھدايت

Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر

ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر

تعارف

ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس (API) ٽئين پارٽي جي ايپليڪيشنن کي اجازت ڏئي ٿي ته اهي LabCollector جي ڊيٽابيس (ماڊيولز) ۽ اضافو (ELN ۽ LSM) سان رابطو ڪن.
API هڪ نمائندگي واري رياست جي منتقلي (REST) ​​آرڪيٽيڪچر تي ٻڌل آهي جيڪا وسيلن تائين رسائي جي اجازت ڏئي ٿي يونيفارم ريسورس شناخت ڪندڙ (URI) ۽ انهن تي عمل.
نوٽ: جون 2017 کان وٺي API v1 بند ڪيو ويو ۽ سڀئي نوان ارتقا API v2 ۾ آهن.

LABCOLLECTOR API

2-1. API سيٽ اپ
سڀ کان پهريان، توهان کي پنهنجي درخواست جو اعلان ڪرڻو پوندو توهان جي LabCollector سافٽ ويئر ۾. ايپليڪيشن ڊڪليئريشن سيٽ اپ فارم تائين رسائي حاصل ڪرڻ لاءِ، سپر ايڊمنسٽريٽر جي حقن سان LabCollector ۾ لاگ ان ٿيو ۽ ايڊمن> سيٽ اپ پيج تي وڃو. پوء چونڊيو Web سروس API لنڪ. ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - API سيٽ اپتوهان هاڻي تي آهيو Web خدمت API ايپليڪيشنون مينيجمينٽ صفحو. هڪ نئين درخواست جو اعلان ڪرڻ لاء، صرف هن فارم کي مڪمل ڪريو: ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - API سيٽ اپ 1

  • نالو: توهان جي درخواست جو نالو.
  • هن ايپليڪيشن سان ڳنڍيل ماڊل: ماڊل چونڊيو جنهن ۾ ايپليڪيشن رسائي ڪري سگهي ٿي.
  • ڊفالٽ آپريٽر: رابطو چونڊيو جيڪو ڊفالٽ آپريٽر هوندو جيڪڏهن توهان هر درخواست ۾ هن معلومات کي شامل ڪرڻ نٿا چاهيو.
  • IP پابندي: سيڪيورٽي اختيار توهان کي IP پتي جي هڪ فهرست جو اعلان ڪرڻ جي اجازت ڏئي ٿو، جيڪا توهان کي API تي درخواستون انجام ڏيڻ جي اجازت ڏني ويندي.

ايپليڪيشن لسٽ ڏيکاري ٿي سڀني ايپليڪيشنن کي توهان جي LabCollector لاءِ ۽ توهان ڪري سگهو ٿا، ڪنهن به وقت، انهن جي دائري کي تبديل ڪريو.
توهان وٽ ٽوڪن تائين رسائي پڻ آهي جيڪا API جي درخواستن دوران توهان جي ايپليڪيشن کي سڃاڻڻ لاءِ ضروري آهي. ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - API سيٽ اپ 2

نوٽ: ھن خصوصيت کي استعمال ڪرڻ لاءِ، توھان کي چالو ڪرڻو پوندو Curl توهان جي PHP ترجيحن تي. لينڪس ۾، PHP-C انسٽال ڪريوurl پيڪيج.
ونڊوز تي ۽ اسان جي خودڪار انسٽالر سان، ايڊٽ ڪريو PHP.ini ۽ غير تبصرو ايڪسٽينشن Curl (extension=php_curl.dll).
2-2. درخواستون
ٽئين پارٽي جي ايپليڪيشنن ۽ LabCollector جي وچ ۾ گفتگو web service API HTTP 1.1 پروٽوڪول تي ٻڌل آهي.
2-2-1. API جو طريقو
توھان موڪلي سگھو ٿا HTTP يا HTTPS درخواستون web هڪ وسيلن تي عمل ڪرڻ جي طريقي سان خدمت.

  • هڪ وسيلو پڙهڻ لاء GET طريقو
  • پوسٽ جو طريقو نئون وسيلو ٺاهڻ لاء
  • هڪ وسيلن کي تبديل ڪرڻ لاء PUT طريقو
  • DELETE طريقو هڪ وسيلن کي ختم ڪرڻ لاء

2-2-2. مٿو
API کي هڪ درخواست ڪجهه مخصوص HTTP/HTTPS هيڊرن جي ضرورت آهي:

  • قبول هيڊر توهان جي درخواست، ٽيڪسٽ/XML، يا ايپليڪيشن/JSON جي گهربل جوابي شڪل کي بيان ڪري ٿو.
  • X-LC-APP-Auth هيڊر اهو آهي جتي توهان پنهنجو ايپليڪيشن ٽوڪن لڳايو جيڪو توهان جي درخواست کي API کي اختيار ڏيڻ لاءِ ضروري آهي.
  • X-LC-APP-Charset هيڊر توهان جي ايپليڪيشن جي ڪردار انڪوڊنگ کي بيان ڪري ٿو. اهو API کي اجازت ڏئي ٿو جواب واپس موڪلڻ لاءِ مناسب انڪوڊنگ سان ۽ توهان جي پوسٽ ۽ PUT درخواستن کي درست طريقي سان تبديل ڪرڻ لاءِ LabCollector جي ڪردار انڪوڊنگ (ISO 8859-1).

2-2-3. اوزار
توھان ڪوشش ڪري سگھوٿا ڊيٽا واپس آڻڻ يا API ڏانھن ڊيٽا موڪلڻ لاءِ ڪجھ سافٽ ويئر ايپ سان پوسٽ مين (https://www.getpostman.com/).

يونيفارم ريسورس آئيڊينٽيفائر (URI)

2-3-1. ميٿ حاصل ڪريوd
جنرل
هر LabCollector ماڊل ڊيٽا جي سڃاڻپ هڪ منفرد URI ذريعي ڪئي وئي آهي (ماڊيول جي URI جي مڪمل فهرست لاءِ ضميمو ڏسو):
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE] هي درخواست ماڊل ۾ سڀني ڊيٽا جي فهرست ڏانهن جواب ڏئي ٿي.
توھان ڪري سگھوٿا ماڊل ڊيٽا ۾ ڳولھا ڪندي پنھنجي URI ۾ پيٽرول شامل ڪندي. توھان ھڪڙو پيٽرولر پاس ڪري سگھو ٿا ھڪڙي لفظ سان ملندڙ فيلڊ جي قيمت سان، جھڙوڪ:[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]؟name=[KEYWORD]مثال طور
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=First%20Record
هي درخواست رڪارڊ واپس ڏئي ٿي جتي انهن جي نالي جي قيمت شامل آهي "پهريون رڪارڊ" لفظ.
اهي ڪجهه ڪسٽم پيٽرولر آهن جيڪي API استعمال ڪري ٿو ڳولا ۽ فلٽرنگ عملن کي انجام ڏيڻ لاءِ.
ڪسٽم پيرا ميٽرز

  • رڪارڊ_id پيٽرولر ڊيٽا کي ان جي ID ذريعي بيان ڪرڻ لاءِ:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?record_id=[RECORD_ID] مثال طور [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?record_id=1,19
اها درخواست ID 1 ۽ ID 19 سان رڪارڊ واپس ڪري ٿي. توهان ڪاما سان الڳ ڪري هڪ کان وڌيڪ ID جي وضاحت ڪري سگهو ٿا.
  • by_keywords پيٽرول هڪ لفظي ڳولا انجام ڏئي ٿو:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=[KEYWORD] مثال طور [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=cell
هي درخواست سڀني رڪارڊ جي سڀني شعبن ۾ ڳولا انجام ڏئي ٿو ۽ ملندڙ سيلن کي واپس ڪري ٿو. توھان انھن کي ڪاما سان الڳ ڪري گھڻن لفظن جي وضاحت ڪري سگھو ٿا.
  • by_keywords پيٽرول هڪ لفظي ڳولا انجام ڏئي ٿو:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=[KEYWORD] مثال طور [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=cell
هي درخواست سڀني رڪارڊ جي سڀني شعبن ۾ ڳولها انجام ڏئي ٿو ۽ هڪ ملندڙ سيل واپس ڪري ٿو. توھان انھن کي ڪاما سان الڳ ڪري گھڻن لفظن جي وضاحت ڪري سگھو ٿا.
  • فيلڊ پيرا ميٽرز، جيڪڏھن توھان حاصل ڪرڻ چاھيو ٿا صرف ڪجھ فيلڊ ويلز API جي جواب ۾:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?fields=[FIELD1]، [FIELD2] مثال طور [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?fields=count,name
هي درخواست ماڊل مان سڀئي رڪارڊ واپس ڪري ٿو پر صرف ڳڻپ ۽ نالي جي شعبن سان. توھان انھن کي ڪاما سان الڳ ڪري گھڻن شعبن جي وضاحت ڪري سگھو ٿا.
درخواست قبول ڪري ٿي هاڻي ڪاما سان الڳ ڪيل ڪيترن ئي قدرن لاءِ، قسم جي ”منتخب“ جي ڪسٽم فيلڊز لاءِليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس
  • search_on پيٽرول توهان کي ڊيٽا ڳولڻ جي اجازت ڏئي ٿو. ۽ توھان ان کي استعمال ڪري سگھوٿا تاريخ جي حد تائين ڳولڻ لاءِ جيئن ھيٺ ڏنل:
[PATH_TO_LABCOLLECTOR]/webخدمت/v2/[ماڊول] ۽
search_on=date_field&from=XXXXXX&to=ZZZZZZ
جيڪڏهن توهان صرف FROM استعمال ڪريو ٿا، نتيجو سڀني تاريخن کي FROM جي تاريخ کان وڏيون ڏيندو. جيڪڏهن توهان صرف استعمال ڪندا آهيو، اهو هن تاريخ تائين سڀ قيمت واپس آڻيندو. ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 1
  • sort_by پيٽرول توهان کي توهان جي ڳولا کي ترتيب ڏيڻ جي اجازت ڏئي ٿو:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?sort_by=[FIELD1]_DESC
مثال طور [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?sort_by=name_DESC
هي درخواست سڀني رڪارڊن کي واپس ڏئي ٿو جيڪو ترتيب ڏنل ترتيب ۾ نالو فيلڊ تي. توھان انھن کي ڪاما سان الڳ ڪري گھڻن ترتيبن جي وضاحت ڪري سگھو ٿا ۽ ھر فيلڊ لاءِ مقرر ڪيل آرڊر Ascendant _ASC” يا Descendant “_DESC” سان.

  • حد_ تائين پيٽرول توهان کي نتيجن جي تعداد کي محدود ڪرڻ جي اجازت ڏئي ٿو:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?limit_to=0,10
اها درخواست 10 ريڪارڊ واپس ڪري ٿي جيڪا انڊيڪس 0 کان شروع ٿيندي. جيڪڏهن توهان انڊيڪس جي وضاحت نه ڪندا، ته صرف ڏيکاريل نتيجن جو تعداد واپس ڪيو ويندو.
API هيڊر جي جواب ۾ ٻه ڪسٽم فيلڊز پڻ ڏئي ٿو، "X-LC-QUERY-RESULT" جنهن ۾ جسم جي جواب ۾ موٽايل نتيجن جو تعداد ۽ "X-LC-QUERY- TOTAL" شامل آهي توهان جي ڳولا سان ملندڙ رڪارڊن جو ڪل.
هر رڪارڊ پڻ هڪ منفرد URI آهي:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]/[DATA_ID] هي درخواست هڪ منفرد رڪارڊ جو جواب ڏئي ٿو. [DATA_ID] انهي رڪارڊ جي منفرد ID سان ملائڻ گهرجي جنهن کي توهان ٻيهر حاصل ڪرڻ چاهيو ٿا.
ذخيرو
توهان وٽ پڻ آهي ٽيوب سارٽر فلٽرنگ افعال هر شئي لاءِ اسٽوريج سان ڳنڍيل:
[PATH_TO_LABCOLLECTOR]/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 تي اسٽوريج جي معلومات واپس ڪري ٿي جهڙوڪ ٽيوب سارٽر. توھان انھن کي ڪاما سان الڳ ڪري گھڻن IDs جي وضاحت ڪري سگھو ٿا. ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 2

[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_i d=[BOX_ID]&record_name=[RECORD_NAME] مثال طور [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_i d=206&record_name=ST-260
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&recor d_name=[RECORD_NAME] مثال طور [PATH_TO_LABCOLLECTOR]/webservice/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]/webservice/index.PHP?v=2&action=tube_sorter&box_n ame=test-rack_06
هي درخواست باڪس ٽيسٽ-rack_06 تي فلٽرنگ انجام ڏئي ٿي. توھان انھن کي ڪاما سان الڳ ڪري گھڻن باڪس جا نالا بيان ڪري سگھو ٿا.
ٻيا ڳولها پيٽرولر to action=tube_sorter ٿي سگھي ٿو:
  • location_id
  • جڳھ جو نالو
  • facility_id
  • facility_name
    اهو پڻ خالي خانو واپس ڏيندو.
  • اسٽوريج_ سيڪنڊ پيٽرولر کي ثانوي اسٽوريج بابت معلومات حاصل ڪرڻ جي اجازت ڏئي ٿي.
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]&data_id=[DATA_ID] & fields=storage_sec ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 3

پراڊڪٽ لاٽ

  • ايڪشن حاصل ڪرڻ لاٽ کي حاصل ڪرڻ جي اجازت ڏئي ٿو لوٽ ۽ ريگينٽ معلومات
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot&lo t_id=1/LT
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot&ch em_id=2
اختياري پيٽرول آهن lot_id (فارميٽ 1 يا 1/LT ۾) ۽ chem_id. جيڪڏهن اهو پيٽرولر حاصل نٿو ڪري، ته اهو سڀ فعال لاٽ ٻيهر حاصل ڪري ٿو.
ترڪيب
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe s
[PATH_TO_LABCOLLECTOR]/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_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe لاگ
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe رپورٽ&log_id=[record_id] مثال طور [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Report&log_id=1218
IDs examples پر انهن ڪالن ۾ لازمي آهن.
حاصل ڪريو ترڪيبون ھيٺ ڏنل معلومات کي پرنٽ ڪري ٿو: id، نالو، وضاحت، زمرو ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 4

ترڪيبون حاصل ڪريو ان recipe_id لاءِ ھيٺ ڏنل معلومات پرنٽ ڪري ٿو: id، نالو، بيان، ڪيٽيگري، ۽ پوءِ اجزاء ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 5getRecipeLogs هيٺ ڏنل معلومات کي پرنٽ ڪري ٿو: id، نالو، وضاحت، زمرو ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 6getRecipeReport ان log_id لاءِ رپورٽ PDF کي پرنٽ ڪري ٿو base64 فارميٽ تحت جنهن کي PDF ۾ ڊيڪوڊ ڪري سگهجي ٿو. ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 7

2-3-2. پوسٽ جو طريقو
ھڪڙو نئون وسيلو ٺاھڻ لاء، صرف پوسٽ طريقي سان ھڪڙي درخواست موڪليو مطلوب ماڊل URI ڏانھن:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE] توهان جي پيرا ميٽر ڪيز کي فيلڊ جي نالي سان ملائڻو پوندو.
انفراديت جي شعبن جي چيڪ ڪريو جيڪي شامل ڪيا ويا آھن، جڏھن نوان رڪارڊ ٺاھيو (پوسٽ) يا تازه ڪاري (PUT)
جيڪڏهن هڪ فيلڊ جي منفرديت لاءِ ساڳئي قدر سان هڪ مختلف رڪارڊ موجود آهي، API عمل مڪمل نه ڪندو ۽ ڪوڊ 409 (تصادم) واپس ڪندو، ۽ متن: فيلڊ 'XXX' لاءِ قدر منفرد هجڻ گهرجي. قدر 'YYY' اڳ ۾ ئي موجود آهي جدول 'ZZZ' ۾. (اسڪرين شاٽ ڏسو) ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 8

نوٽ: پروجيڪٽ_ڪوڊ فيلڊ POST ۽ PUT ۾ استعمال ڪري سگھجي ٿو ۽ اھو متن جي توقع رکي ٿو (نھي id). توھان ھاڻي ٺاھي سگھو ٿا ھڪڙو نئون پروجيڪٽ ڪوڊ جيڪڏھن اھو موجود نه آھي ۽ جيڪڏھن آپريٽر وٽ ڪافي اجازتون آھن (ايڊمنسٽريٽر يا سپر ايڊمنسٽريٽر).

  • عمل addBox توهان کي هڪ باڪس ٺاهڻ جي اجازت ڏئي ٿو
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action= addBox
  • گهربل پيٽرولر:
    o نالو
    o قسم (هڪ صحيح قسم جو هجڻ لازمي آهي: باڪس، باڪس_نوگرڊ، پليٽ، مائڪرو پليٽ، دورو ڪريو، بيگ، شيلف حصو)
    o سامان (id يا نالو جي حمايت ڪري ٿو ۽ LabCollector اسٽوريج ۾ موجود هجڻ گهرجي).
    o سائيز (انحصار دٻي جي قسم تي: گهمڻ لاءِ عددي هجڻ گهرجي، ۽ فارميٽ (A:1.H:8) هڪ دٻي، هڪ پليٽ، ۽ هڪ مائڪرو پليٽ لاءِ)
  • اختياري پيراگراف:
    o وضاحت
    o ريڪ
    o سنڀاليندڙ

2-3-3. PUT طريقو
هڪ وسيلن کي تبديل ڪرڻ لاء، صرف PUT طريقي سان گهربل رڪارڊ URI ڏانهن درخواست موڪليو:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]/[DATA_ID] توهان جي پيرا ميٽر ڪيز کي فيلڊ جي نالي سان ملائڻو پوندو جنهن کي توهان تبديل ڪرڻ چاهيو ٿا.
ھيٺين عملن لاءِ، نوٽ ڪريو ته PUT درخواستن لاءِ، پيٽرول لازمي طور تي جسم تي ھجن (نه URL).
جي URL آهي [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2
هيڊر آهن: X-LC-APP-Auth، قبول ڪريو.

  • حجم ختم ڪريو
    - پيٽرولر:
    o حجم ختم ڪريو (لازمي)
    o بارڪوڊ، منفرد_ڪوڊ، يا aliquot_barcode (انهن مان هڪ هجڻ لازمي آهي)
    o مقدار (لازمي)
    - جواب: ٺيڪ
  • اسٽوريج کي هٽايو
    - پيٽرولر:
    o ريموٽ اسٽوريج (لازمي)
    o بارڪوڊ، منفرد_ڪوڊ، يا aliquot_barcode (انهن مان هڪ هجڻ لازمي آهي)
    - جواب: ٺيڪ
  • شامل ڪريو رجسٽري ڪتاب
    - URL:
    [PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&module=[m odule] - پيٽرولر:
    o شامل ڪريو رجسٽري بڪ (لازمي)
    o record_id (لازمي)
    o تاريخ (لازمي، فارميٽ yy yy/mm/dd يا yyyy-mm-dd)
    o تبصرا (لازمي)
    o آپريٽر (اختياري، جيڪڏهن اهو نه موڪليندو آهي API ڊفالٽ آپريٽر استعمال ڪيو ويندو)
    o عمل (اختياري، LC ۾ بيان ڪيل هڪ صحيح 'اسٽوريج ايڪشن ٽائپ' هجڻ گهرجي
    > منتظم > ترجيحات > عمل ۽ عمل جو قسم)
    - جواب: ٺيڪ
  • ثانوي اسٽوريج شامل ڪريو
    - پيٽرولر:
    o ثانوي اسٽوريج شامل ڪريو (لازمي)
    o بار ڪوڊ (لازمي)
    o box_id (لازمي)
    o باڪس_تفصيل (لازمي صرف ان دٻي لاءِ جنهن ۾ گرڊ ورهائيندڙ، ٽيوب ٽري، ۽ مائڪرو پليٽ هجي. جيڪڏهن باڪس گرڊ کان سواءِ هجي، بيگ، وزٽ بي يا شيلف جو حصو، اهو ضروري ناهي)
    o منفرد_ڪوڊ (اختياري)
    o حجم (اختياري)
    o تبصرا (اختياري)
    o ڪيپ_رنگ (اختياري)

نوٽ: هڪ غلطي پيغام واپس آيو آهي جيڪڏهن لازمي پيٽرولر موجود نه آهن؛ جيڪڏهن بارڪوڊ موجود نه آهي؛ جيڪڏهن منفرد_ڪوڊ موجود آهي، پر اهو منفرد ناهي؛ ۽، جيڪڏهن رنگ موجود آهي پر اهو موجود ناهي.
جيڪڏهن پيراميٽر box_details حاصل نه ڪيو ويو آهي ۽ باڪس جي قسم کي پوزيشن جي ضرورت آهي (گرڊ، ٽيوب ٽري، يا مائڪروپليٽ سان باڪس)، هڪ غلطي پيغام واپس آيو آهي. ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - ڊوائيس 9ليب ڪليڪٽر Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر - device10نوٽ: پروجيڪٽ_ڪوڊ فيلڊ POST ۽ PUT ۾ استعمال ڪري سگھجي ٿو ۽ اھو متن جي توقع رکي ٿو (نھي id). توھان ھاڻي ٺاھي سگھو ٿا ھڪڙو نئون پروجيڪٽ ڪوڊ جيڪڏھن اھو موجود نه آھي ۽ جيڪڏھن آپريٽر وٽ ڪافي اجازتون آھن (ايڊمنسٽريٽر يا سپر ايڊمنسٽريٽر).
2-3-4. DELETE طريقو
وسيلن کي ختم ڪرڻ لاء، صرف هڪ درخواست موڪليو DELETE طريقي سان مطلوب رڪارڊ URI ڏانهن:
[PATH_TO_LABCOLLECTOR]/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، barcode، aliquot_barcode
ماڊل ”XXX“ موجود ناهي!' 400 خراب درخواست پيرا ميٽر جي قيمت 'ماڊيول' GB ڪليڪٽر ماڊل نه آهي
ماڊل “XXX” هن ڊيٽا کي حصيداري نٿو ڪري!' 403 منع ٿيل پيرا ميٽر جي قيمت 'ماڊل' تي چڪاس نه ڪئي وئي آهي
LabCollector> منتظم> سيٽ اپ> Web خدمت
'درخواست جو فارميٽ قبول نه ڪيو ويو آهي!' 415 غير معاون ميڊيا قسم پيراميٽر قبول استعمال ڪيو ويو آهي، پر قدر قبول ٿيل قدرن مان نه آهي: ايپليڪيشن/XML يا ايپليڪيشن/JSON
(خالي) 406 قابل قبول نه آهي طريقو ھيٺين مان ھڪڙو ھجڻ گھرجي: GET، POST، PUT، DELETE
'ڪابه ڊيٽا نه ملي.' 404 نه مليو هن درخواست جي پيرا ميٽرن سان ڪو به ڊيٽا نه مليو
'ٺيڪ.' 200 ٺيڪ رڪارڊ ڪاميابي سان اپڊيٽ ڪيو ويو
'تڪرار.' 409 تڪرار رڪارڊ اپڊيٽ نه ٿي سگهيو آهي ڇاڪاڻ ته اتي آهي
ڊيٽا ۾ تڪرار
هن ماڊيول لاءِ ڪو به آرگنزم جو قدر ناهي 404 نه مليو صرف ماڊلز “strains”، “samples" ۽ microarrays"
هڪ عضوي قدر آهي - توهان هڪ غلط چونڊيو آهي
ماڊل
هن ماڊيول لاءِ ڪي ڪيٽيگريز قدر نه آهن 404 نه مليو صرف ماڊل 'ڊاڪس' ۾ ڪيٽيگريون آهن - توهان چونڊيو آهي
هڪ غلط ماڊل
Webخدمت کي صارف جي تصديق جي ضرورت آهي 401 غير مجاز بيڪار
توهان جي IP تائين رسائي جي اجازت ناهي Web خدمت 401 غير مجاز ڪلائنٽ IP هن لاءِ مجاز IPs جي فهرست ۾ نه آهي
Webخدمتون (LC> منتظم> سيٽ اپ> Web خدمت)
توهان جي درخواست دوران غلطي، هيٺ ڏنل معلومات لازمي آهي هڪ نئون ٺاهڻ لاءِ
رڪارڊ: X، Y، Z'
400 خراب درخواست نئين ڊيٽا پوسٽ ڪرڻ جي ڪوشش بغير لازمي شعبن جي X، Y،
Z
توهان جي درخواست دوران هڪ غلطي ٿي وئي آهي، هيٺ ڏنل معلومات لازمي آهي حجم کي هٽائڻ لاء: unique_code or barcode or aliquot_barcode, quantity, quantity 400 خراب درخواست بغير بغير حجم کي ختم ڪرڻ جي ڪوشش ڪريو
parameters: unique_code يا barcode يا aliquot_barcode،
مقدار
توهان جي درخواست دوران هڪ غلطي ٿي وئي آهي، هيٺ ڏنل معلومات لازمي آهي
اسٽوريج هٽايو: unique_codeor barcode or
aliquot_barcode، مقدار '
400 خراب درخواست بغير لازمي اسٽوريج کي ختم ڪرڻ جي ڪوشش ڪريو
parameter: unique_code يا barcode يا aliquot_barcode
" 200 ٺيڪ درخواست ڪيل ڊيٽا ڪاميابي سان واپس ڪئي وئي

ليبارٽري WEB SERVICE API - ANNEX

API جو URI سسٽم هڪ سادي ۽ صاف استعمال ڪري ٿو URL. هيٺ ڏنل جدول ۾ ڏنل URI استعمال ڪرڻ لاءِ Apache کان ٻيهر لکڻ واري انجڻ کي فعال ڪرڻ جي پڪ ڪريو. جيڪڏهن LabCollector سرور rewrite engine کي سپورٽ نٿو ڪري ته مهرباني ڪري مڪمل استعمال ڪريو URL توهان جي درخواست لاءِ نمونو (ثانوي URL هر قطار جي).

UM ماڊل وصف
webخدمت/v2/strains webservice/index.PHP?v=2&module=strai ns پوسٽ حاصل ڪريو strains & Cells سڀني رڪارڊن جي فهرست
webخدمت/v2/strains/(DATA JD] webservice/index.PHP?v=2&module=strai ns&data jd.[DATA _ID] پوٽ حاصل ڪريو strains & Cells منفرد رڪارڊ
webservice/v2/strains/custom fields webservice/index.php?v=2&module=strai ns&getModuleCustomFields=1 حاصل ڪريو strains & Cells ڪسٽم فيلڊ جي فهرست
webخدمت/v2/strains/organisms webservice/index.PHP?v=2&module=strai ns&getModuleOrganisms=1 حاصل ڪريو strains ۽ سيلز جاندار جي فهرست
webخدمت/v2/plasmids webservice/index.php?v=2&module=plas mids پوسٽ حاصل ڪريو پلازمڊ سڀني رڪارڊن جي فهرست
webخدمت/v2/plasmids/IDATAjD] webservice/index.php?v=2&module=plasmids&data _id=IDATA _ID] حاصل ڪريو پوٽو پلازمڊ منفرد رڪارڊ
webخدمت/v2/plasmids/ڪسٽم فيلڊز webservice/index.PHP?v=2&module=plas mids&getModuleCustomFields=1 حاصل ڪريو Plasmids جا ميدان ڪسٽم جي فهرست
webخدمت/v2/primers webservice/index.PHP?v=2&module=pri mers پوسٽ حاصل ڪريو پرائمر سڀني رڪارڊن جي فهرست
webservice/v2/primers/[DATA JD] webservice/index.PHP?v=2&module=pri Mers&data _idaDATA _ID] حاصل ڪريو پرائمر منفرد رڪارڊ
webخدمت/v2/primers/ڪسٽم فيلڊز حاصل ڪريو پرائمر ڪسٽم فيلڊ جي فهرست
webservice/index.PHP?v=2&module=pri mers&getModuleCustomFields=1
webخدمت/v2/ڪيميا webservice/index.PHP?v=2&module=che micals پوسٽ حاصل ڪريو ريجنٽس ۽ سامان سڀني رڪارڊن جي فهرست
webservice/v2/chemicals/IDATA _ID] webservice/index.PHP?v=2&module=che micals&data_idADATA _ID] پوٽ حاصل ڪريو ريجنٽس ۽ سامان منفرد رڪارڊ
webخدمت/v2/ڪيميا/ڪسٽم فيلڊز webservice/index.PHP?v=2&module=che micals&getModuleCustomFields=1 حاصل ڪريو ريجنٽ ۽ سامان جا شعبا ڪسٽم جي فهرست
webخدمت/v2/samples webservice/index.PHP?v=2&module=sam pies پوسٽ حاصل ڪريو Samples سڀني رڪارڊن جي فهرست
webخدمت/v2/samples/IDATA_ID) web service/index.PHP?v=2&module=sam ples&data_id=[DATA _ID] پوٽ حاصل ڪريو Samples منفرد رڪارڊ
webخدمت/v2/sampليس / ڪسٽم فيلڊ webservice/index.PHP?v=2&module=sam ples&getModuleCustomFields=1 حاصل ڪريو Samples ڪسٽم فيلڊ جي فهرست
webخدمت/v2/samples/organisms webservice/index.php?v=2&module=sam ples&getModuleOrganisms=1 حاصل ڪريو Samples جاندارن جي فهرست
webخدمت/v2/samples/قسم webservice/index.PHP?v=2&module=sam ples&getModuleTypes=1 حاصل ڪريو Samples ايس جي فهرستampقسمون
webخدمت/v2/انٽي باڊيز webservice/index.PHP?v=2&module=anti Bodies پوسٽ حاصل ڪريو اينٽي باڊيز سڀني رڪارڊن جي فهرست
webservice/v2/antibodies/(DATA _iDi webservice/index.PHP?v=2&module=anti bodies&data_id=IDATA _ID] پوٽ حاصل ڪريو اينٽي باڊيز منفرد رڪارڊ
webخدمت/v2/انٽي باڊيز/ڪسٽم فيلڊز webservice/index.PHP?v=2&module=anti bodies&getModuleCustomFields=1 حاصل ڪريو اينٽي باڊيز جا ميدان ڪسٽم جي فهرست
webخدمت/v2/sequences webservice/index.PHP?v=2&module=seq uences پوسٽ حاصل ڪريو تسلسل سڀني رڪارڊن جي فهرست
webخدمت/v2/sequences/(DATA _iDI webservice/index.PHP?v=2&module=seq uences&data _icHCIATA JD] حاصل ڪريو
پوٽو
تسلسل منفرد رڪارڊ
webservice/v2/sequences/custom fields webservice/index.PHP?v=2&module=seq uences&getModuleCustomFields=1 حاصل ڪريو سلسلو جا شعبا ڪسٽم جي فهرست
webخدمت/v2/جانور webservice/index.PHP?v=2&module=ani mats پوسٽ حاصل ڪريو جانور سڀني رڪارڊن جي فهرست
webخدمت/v2/جانور/(DATA JD] webservice/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 پوسٽ حاصل ڪريو سامان سڀني رڪارڊن جي فهرست
webservice/v2/equipments/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 حاصل ڪريو سامان جا شعبا ڪسٽم جي فهرست
webservice/v2/structures webservice/index.PHP?v=2&module=stru علاج پوسٽ حاصل ڪريو ڪيميائي ساخت سڀني رڪارڊن جي فهرست
webخدمت/v2/structures/(DATA_ID] webservice/index.PHP?v=2&module=stru ctures&data jd=(DATA JD] پوٽ حاصل ڪريو ڪيميائي ساخت منفرد رڪارڊ
webservice/v2/structures/custom fields webservice/index.PHP?v=2&module=stru cturesketModuleCustomFields=1 حاصل ڪريو ڪيميائي ساخت ڪسٽم فيلڊ جي فهرست
webservice/v2/docs webservice/index.PHP?v=2&module=docs پوسٽ حاصل ڪريو دستاويز سڀني رڪارڊن جي فهرست
webخدمت/v2/docs/(DATA JD] webservice/index.PHP?v=2&module=docs &data _idaDATA _ID] پوٽ حاصل ڪريو دستاويز منفرد رڪارڊ
webservice/v2/docs/custom fields webservice/index.php?v=2&module=docs &getModuleCustomFields=1 حاصل ڪريو دستاويز ڪسٽم فيلڊ جي فهرست
webservice/v2/docs/categories webservice/index.PHP?v=2&module=docs &getModuleCategories=1 حاصل ڪريو دستاويز جا زمرا جي فهرست
webخدمت/v2/book webservice/index.PHP?v=2&module=abo ٺيڪ پوسٽ حاصل ڪريو ايڊريس بک سڀني رڪارڊن جي فهرست
webخدمت/v2/book/(DATA _ID] webservice/index.php?v=2&module=abo OK&data_idADATA _ID] پوٽ حاصل ڪريو ايڊريس بک منفرد رڪارڊ
webخدمت/v2/book/ Custom fields webservice/index.PHP?v=2&module=abo OK&getModuleCustomFields=1 حاصل ڪريو ايڊريس بک ڪسٽم فيلڊ جي فهرست
webخدمت/v2/book/ زمرو webservice/index.PHP?v=2&module=abo ok&getModuleCategories=1 حاصل ڪريو ايڊريس بڪ زمرا جي فهرست
webservice/v2/microarrays webservice/index.PHP?v=2&module=micr arrays پوسٽ حاصل ڪريو مائڪرو ايري سڀني رڪارڊن جي فهرست
webخدمت/v2/microarrays/(DATA_ID] webservice/index.PHP?v=2&module=micr oarrays&data_id=[DATA _ID] حاصل ڪريو پوٽو مائڪرو ايري منفرد رڪارڊ
webخدمت/v2/microarrays/ڪسٽم فيلڊز webservice/index.PHP?v=2&module=micr oarrays&getModuleCustomFields=1 حاصل ڪريو مائڪرو ايري ڪسٽم فيلڊ جي فهرست
webservice/v2/microarrays/organisms webservice/index.PHP?v=2&module=micr oarrays&getModuleOrganisms=1 حاصل ڪريو Microarrays organisms جي فهرست
webخدمت/v2/(CUSTOM_MODULE_NAM El
webservice/index.PHP?v=2&module=ECU STOM_MODULE_NAMEI
پوسٽ حاصل ڪريو ڪسٽم ماڊيول سڀني رڪارڊن جي فهرست
webخدمت/v2/(CUSTOM_MODULE_NAM EMIDATA _ID] webservice/index.PHP?v=2&module=[CU STOM_MODULE_NAME] &data_id=[DATA _ID] پوٽ حاصل ڪريو ڪسٽم ماڊيول منفرد رڪارڊ
webخدمت/v2/(CUSTOM_MODULE_NAM Elicustomfields webservice/index.PHP?v=2&module=[CU STOM_MODULE_NAME184getModuleCust omFields=1 حاصل ڪريو ڪسٽم ماڊيول ڪسٽم فيلڊ جي فهرست

ليب ڪليڪٽر - لوگو 1

http://www.labcollector.comsales@agilebio.com
AgileBio USA
5473 ڪيرني ولا روڊ سوٽ 255
سان ڊيوگو، CA 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 سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر [pdf] استعمال ڪندڙ ھدايت
Web سروس ايپليڪيشن پروگرامنگ انٽرفيس، سافٽ ويئر، Web سروس ايپليڪيشن پروگرامنگ انٽرفيس سافٽ ويئر

حوالو

تبصرو ڇڏي ڏيو

توهان جو اي ميل پتو شايع نه ڪيو ويندو. گهربل فيلڊ نشان لڳل آهن *