સંસ્કરણ 2.0 – નવેમ્બર 2021
Web સર્વિસ એપ્લિકેશન પ્રોગ્રામિંગ ઈન્ટરફેસ સોફ્ટવેર
વપરાશકર્તા માર્ગદર્શિકા
Web સર્વિસ એપ્લિકેશન પ્રોગ્રામિંગ ઈન્ટરફેસ સોફ્ટવેર
પરિચય
લેબ કલેક્ટર Web સર્વિસ એપ્લિકેશન પ્રોગ્રામિંગ ઈન્ટરફેસ (API) તૃતીય-પક્ષ એપ્લિકેશનોને લેબકોલેક્ટરના ડેટાબેઝ (મોડ્યુલ્સ) અને એડ-ઓન્સ (ELN અને LSM) સાથે ક્રિયાપ્રતિક્રિયા કરવાની મંજૂરી આપે છે.
API એ રિપ્રેઝન્ટેશનલ સ્ટેટ ટ્રાન્સફર (REST) આર્કિટેક્ચર પર આધારિત છે જે યુનિફોર્મ રિસોર્સ આઇડેન્ટિફાયર (URI) અને તેના પરની ક્રિયાઓ દ્વારા સંસાધનોને ઍક્સેસ કરવાની મંજૂરી આપે છે.
નોંધ: જૂન 2017 થી API v1 બંધ કરવામાં આવ્યું હતું અને તમામ નવા ઉત્ક્રાંતિ API v2 માં છે.
LABCOLLECTOR API
2-1. API સેટઅપ
સૌ પ્રથમ, તમારે તમારા LabCollector સોફ્ટવેરમાં તમારી અરજી જાહેર કરવી પડશે. એપ્લિકેશન ઘોષણા સેટઅપ ફોર્મને ઍક્સેસ કરવા માટે, સુપર-એડમિનિસ્ટ્રેટર અધિકારો સાથે લેબકોલેક્ટરમાં લૉગ ઇન કરો અને એડમિન > સેટઅપ પૃષ્ઠ પર જાઓ. પછી પસંદ કરો Web સેવા API લિંક. 
તમે હવે આ પર છો Web સર્વિસ API એપ્લિકેશન મેનેજમેન્ટ પેજ. નવી અરજી જાહેર કરવા માટે, ફક્ત આ ફોર્મ ભરો: 
- નામ: તમારી અરજીનું નામ.
- આ એપ્લિકેશન સાથે જોડાયેલા મોડ્યુલો: મોડ્યુલ પસંદ કરો જેમાં એપ્લિકેશન ઍક્સેસ કરી શકે.
- ડિફૉલ્ટ ઑપરેટર: સંપર્ક પસંદ કરો કે જે ડિફોલ્ટ ઓપરેટર હશે જો તમે દરેક વિનંતીમાં આ માહિતી દાખલ કરવા માંગતા નથી.
- IP પ્રતિબંધ: સુરક્ષા વિકલ્પ તમને IP સરનામાઓની સૂચિ જાહેર કરવાની મંજૂરી આપે છે, જે તમને API પર વિનંતીઓ કરવા માટે પરવાનગી આપશે.
એપ્લિકેશન સૂચિ તમારા લેબકોલેક્ટર માટેની તમામ એપ્લિકેશનો દર્શાવે છે અને તમે કોઈપણ સમયે, તેમના કાર્યક્ષેત્રમાં ફેરફાર કરી શકો છો.
તમારી પાસે ટોકનનો ઍક્સેસ પણ છે જે API ને વિનંતીઓ દરમિયાન તમારી એપ્લિકેશનને ઓળખવા માટે જરૂરી છે. 
નોંધ: આ સુવિધાનો ઉપયોગ કરવા માટે, તમારે C સક્રિય કરવાની જરૂર છેurl તમારી PHP પસંદગીઓ પર. Linux માં, PHP-C ઇન્સ્ટોલ કરોurl પેકેજ
વિન્ડોઝ પર અને અમારા સ્વચાલિત ઇન્સ્ટોલર સાથે, PHP.ini ને સંપાદિત કરો અને C માટે અનકોમેન્ટ એક્સટેન્શન્સurl (એક્સ્ટેંશન=php_curl.dll).
2-2. વિનંતીઓ
તૃતીય-પક્ષ એપ્લિકેશનો અને લેબકોલેક્ટર વચ્ચેનો સંવાદ web સર્વિસ API HTTP 1.1 પ્રોટોકોલ પર આધારિત છે.
2-2-1. API પદ્ધતિ
તમે HTTP અથવા HTTPS વિનંતીઓ મોકલી શકો છો web સંસાધન પર કાર્ય કરવાની પદ્ધતિ સાથે સેવા.
- સંસાધન વાંચવા માટેની GET પદ્ધતિ
- નવું સંસાધન બનાવવા માટે POST પદ્ધતિ
- સંસાધનને સંશોધિત કરવા માટે PUT પદ્ધતિ
- સંસાધનને કાઢી નાખવા માટે DELETE પદ્ધતિ
2-2-2. હેડરો
API ને વિનંતી કરવા માટે અમુક ચોક્કસ HTTP/HTTPS હેડરની જરૂર છે:
- સ્વીકારો હેડર તમારી વિનંતી, ટેક્સ્ટ/XML અથવા એપ્લિકેશન/JSONના ઇચ્છિત પ્રતિસાદ ફોર્મેટને વ્યાખ્યાયિત કરે છે.
- X-LC-APP-Auth હેડર એ છે જ્યાં તમે તમારી એપ્લિકેશન ટોકન મૂકો છો જે API ને તમારી વિનંતીને અધિકૃત કરવા માટે જરૂરી છે.
- X-LC-APP-Charset હેડર તમારી એપ્લિકેશનના અક્ષર એન્કોડિંગને વ્યાખ્યાયિત કરે છે. તે API ને યોગ્ય એન્કોડિંગ સાથે પ્રતિસાદ પરત મોકલવા અને તમારી POST અને PUT વિનંતીઓને લેબકોલેક્ટરના કેરેક્ટર એન્કોડિંગ (ISO 8859-1)માં યોગ્ય રીતે કન્વર્ટ કરવાની મંજૂરી આપે છે.
2-2-3. સાધન
તમે પોસ્ટમેન (https://www.getpostman.com/).
યુનિફોર્મ રિસોર્સ આઇડેન્ટિફાયર (URI)
2-3-1. મેથો મેળવોd
જનરલ
દરેક લેબકોલેક્ટર મોડ્યુલ ડેટાને અનન્ય 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 પરિમાણ:
આ વિનંતી ID 1 અને ID 19 સાથેના રેકોર્ડ પરત કરે છે. તમે બહુવિધ ID ને અલ્પવિરામ વડે અલગ કરીને સ્પષ્ટ કરી શકો છો.
- by_keywords પરિમાણ કીવર્ડ શોધ કરે છે:
આ વિનંતી તમામ રેકોર્ડના તમામ ક્ષેત્રોમાં શોધ કરે છે અને મેળ ખાતા કોષો પરત કરે છે. તમે બહુવિધ કીવર્ડ્સને અલ્પવિરામથી અલગ કરીને સ્પષ્ટ કરી શકો છો.
- by_keywords પરિમાણ કીવર્ડ શોધ કરે છે:
આ વિનંતિ તમામ રેકોર્ડ્સના તમામ ક્ષેત્રોમાં શોધ કરે છે અને મેળ ખાતા સેલ પરત કરે છે. તમે બહુવિધ કીવર્ડ્સને અલ્પવિરામથી અલગ કરીને સ્પષ્ટ કરી શકો છો.
- ફીલ્ડ પેરામીટર્સ, જો તમે API પ્રતિસાદમાં માત્ર અમુક ફીલ્ડ વેલ્યુ પુનઃપ્રાપ્ત કરવા માંગો છો:
આ વિનંતી મોડ્યુલમાંથી તમામ રેકોર્ડ પરત કરે છે પરંતુ માત્ર ગણતરી અને નામ ફીલ્ડ સાથે. તમે બહુવિધ ફીલ્ડ્સને અલ્પવિરામથી અલગ કરીને સ્પષ્ટ કરી શકો છો.
વિનંતી હવે "પસંદ કરો" પ્રકારના કસ્ટમ ફીલ્ડ્સ માટે અલ્પવિરામ દ્વારા અલગ કરાયેલા બહુવિધ મૂલ્યો સ્વીકારે છે.
- search_on પેરામીટર તમને ડેટા શોધવાની પરવાનગી આપે છે. અને તમે તેનો ઉપયોગ નીચે પ્રમાણે તારીખ શ્રેણી દ્વારા શોધવા માટે કરી શકો છો:
search_on=date_field&from=XXXXXX&to=ZZZZZZ
જો તમે માત્ર FROM નો ઉપયોગ કરો છો, તો પરિણામ બધી તારીખો FROM તારીખ કરતાં મોટી આપશે. જો તમે માત્ર ઉપયોગ કરો છો, તો તે આ તારીખ સુધી તમામ મૂલ્ય પરત કરશે.
- sort_by પરિમાણ તમને તમારી શોધને સૉર્ટ કરવાની મંજૂરી આપે છે:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?sort_by=[FIELD1]_DESC
દા.ત. [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?sort_by=name_DESC
આ વિનંતી નામ ફીલ્ડ પર ઉતરતા ક્રમમાં સૉર્ટ કરેલા તમામ રેકોર્ડ પરત કરે છે. તમે દરેક ફીલ્ડ માટે અલ્પવિરામ અને નિર્દિષ્ટ ઓર્ડર એસેન્ડન્ટ _ASC" અથવા વંશજ "_DESC" વડે અલગ કરીને બહુવિધ સોર્ટ_નો ઉલ્લેખ કરી શકો છો.
- limit_to પરિમાણ તમને પરિણામોની સંખ્યા મર્યાદિત કરવાની મંજૂરી આપે છે:
[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] આ વિનંતી એક અનન્ય રેકોર્ડનો જવાબ આપે છે. તમે પુનઃપ્રાપ્ત કરવા માંગો છો તે રેકોર્ડના અનન્ય ID સાથે [DATA_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 પર ટ્યુબ સોર્ટરની જેમ સ્ટોરેજ માહિતી પરત કરે છે. તમે બહુવિધ ID ને અલ્પવિરામ વડે અલગ કરીને સ્પષ્ટ કરી શકો છો. 
[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
આ વિનંતી બોક્સ test-rack_06 પર ફિલ્ટરિંગ કરે છે. તમે બહુવિધ બોક્સ નામોને અલ્પવિરામથી અલગ કરીને સ્પષ્ટ કરી શકો છો.
ક્રિયા=tube_sorter માટે અન્ય શોધ પરિમાણો આ હોઈ શકે છે:
- location_id
- સ્થાન_નામ
- facility_id
- સુવિધા_નામ
તે ખાલી બોક્સ પણ પરત કરશે. - સ્ટોરેજ_સેક પેરામીટર ગૌણ સ્ટોરેજ વિશે માહિતી પુનઃપ્રાપ્ત કરવાની મંજૂરી આપે છે.
ઉત્પાદન ઘણો
- એક્શન ગેટ લોટ લોટ અને રીએજન્ટ માહિતી પુનઃપ્રાપ્ત કરવાની મંજૂરી આપે છે
[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=getરેસીપી લોગ્સ
[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
ID ભૂતપૂર્વ છેampપરંતુ આ કૉલ્સમાં ફરજિયાત છે.
મેળવો વાનગીઓ નીચેની માહિતી છાપે છે: આઈડી, નામ, વર્ણન, શ્રેણી
રેસીપી મેળવો તે રેસીપી_આઈડી માટે નીચેની માહિતી છાપે છે: આઈડી, નામ, વર્ણન, શ્રેણી અને પછી ઘટકો 
getRecipeLogs નીચેની માહિતી છાપે છે: id, નામ, વર્ણન, શ્રેણી 
getRecipeReport તે log_id માટેના અહેવાલ PDFને base64 ફોર્મેટ હેઠળ પ્રિન્ટ કરે છે જેને PDF માં ડીકોડ કરી શકાય છે. 
2-3-2. પોસ્ટ પદ્ધતિ
નવું સંસાધન બનાવવા માટે, ફક્ત ઇચ્છિત મોડ્યુલ URI પર POST પદ્ધતિ સાથે વિનંતી મોકલો:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE] તમારી પેરામીટર કી ફીલ્ડના નામ સાથે મેળ ખાતી હોવી જોઈએ.
નવા રેકોર્ડ્સ (POST) અથવા અપડેટ (PUT) બનાવતી વખતે ઉમેરવામાં આવેલ વિશિષ્ટતા ક્ષેત્રો માટે તપાસો
જો ફીલ્ડ વિશિષ્ટતા માટે સમાન મૂલ્ય સાથે અલગ રેકોર્ડ અસ્તિત્વમાં છે, તો API ક્રિયા પૂર્ણ કરશે નહીં અને કોડ 409 (વિરોધ) પરત કરશે, અને ટેક્સ્ટ: ફીલ્ડ 'XXX' માટેનું મૂલ્ય અનન્ય હોવું આવશ્યક છે. મૂલ્ય 'YYY' પહેલેથી જ કોષ્ટક 'ZZZ' માં અસ્તિત્વમાં છે. (સ્ક્રીનશોટ જુઓ) 
નોંધ: પ્રોજેક્ટ_કોડ ફીલ્ડનો ઉપયોગ POST અને PUT માં થઈ શકે છે અને તે ટેક્સ્ટની અપેક્ષા રાખે છે (id નહીં). તમે હવે નવો પ્રોજેક્ટ કોડ બનાવી શકો છો જો તે અસ્તિત્વમાં ન હોય અને જો ઑપરેટર પાસે પૂરતી પરવાનગીઓ હોય (એડમિનિસ્ટ્રેટર અથવા સુપર-એડમિનિસ્ટ્રેટર).
- ઍક્શન ઍડબૉક્સ તમને બૉક્સ બનાવવાની મંજૂરી આપે છે
- જરૂરી પરિમાણો:
o નામ
o પ્રકાર (માન્ય પ્રકાર હોવો જોઈએ: બોક્સ, બોક્સ_નોગ્રીડ, પ્લેટ, માઇક્રોપ્લેટ, મુલાકાત લો, બેગ, શેલ્ફનો ભાગ)
o સાધનો (આઈડી અથવા નામને સપોર્ટ કરે છે અને લેબકોલેક્ટર સ્ટોરેજમાં અસ્તિત્વમાં હોવું જોઈએ).
o કદ (બોક્સના પ્રકાર પર આધાર રાખે છે: મુલાકાત માટે સંખ્યાત્મક હોવું જોઈએ, અને ફોર્મેટ (A:1.H:8) બોક્સ, પ્લેટ અને માઇક્રોપ્લેટ માટે) - વૈકલ્પિક પરિમાણો:
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, Accept.
- વોલ્યુમ દૂર કરો
- પરિમાણો:
o વોલ્યુમ દૂર કરો (ફરજિયાત)
o બારકોડ, અનન્ય_કોડ અથવા અલીકોટ_બારકોડ (તેમાંથી એક હાજર હોવો આવશ્યક છે)
o જથ્થો (ફરજિયાત)
- જવાબ: ઠીક છે
- સ્ટોરેજ દૂર કરો
- પરિમાણો:
o રીમોટ સ્ટોરેજ (ફરજિયાત)
o બારકોડ, અનન્ય_કોડ અથવા અલીકોટ_બારકોડ (તેમાંથી એક હાજર હોવો આવશ્યક છે)
- જવાબ: ઠીક છે
- રજિસ્ટ્રી બુક ઉમેરો
– URL:
[PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&module=[m odule] - પરિમાણો:
o રજિસ્ટ્રીબુક ઉમેરો (ફરજિયાત)
રેકોર્ડ_આઈડી (ફરજિયાત)
o તારીખ (ફરજિયાત, ફોર્મેટ yy yy/mm/dd અથવા yyyy-mm-dd)
o ટિપ્પણીઓ (ફરજિયાત)
ઓ ઓપરેટર (વૈકલ્પિક, જો તે API મોકલતું નથી તો ડિફોલ્ટ ઓપરેટરનો ઉપયોગ કરવામાં આવશે)
o ક્રિયા (વૈકલ્પિક, LC માં વ્યાખ્યાયિત માન્ય 'સ્ટોરેજ એક્શન પ્રકાર' હોવો જોઈએ
>એડમિન >પસંદગીઓ > પ્રક્રિયા અને ક્રિયાઓનો પ્રકાર)
- જવાબ: ઠીક છે
- ગૌણ સંગ્રહ ઉમેરો
- પરિમાણો:
o ગૌણ સંગ્રહ ઉમેરો (ફરજિયાત)
o બારકોડ (ફરજિયાત)
o box_id (ફરજિયાત)
o બોક્સ_વિગતો (ફક્ત ગ્રીડ વિભાજક, ટ્યુબ ટ્રે અને માઇક્રોપ્લેટવાળા બોક્સ માટે ફરજિયાત છે. જો બોક્સ ગ્રીડ, બેગ, મુલાકાત અથવા શેલ્ફના ભાગ વિનાનું હોય, તો તેની જરૂર નથી)
o અનન્ય_કોડ (વૈકલ્પિક)
o વોલ્યુમ (વૈકલ્પિક)
o ટિપ્પણીઓ (વૈકલ્પિક)
કેપ_રંગ (વૈકલ્પિક)
નોંધ: જો ફરજિયાત પરિમાણો હાજર ન હોય તો ભૂલ સંદેશ પાછો આવે છે; જો બારકોડ અસ્તિત્વમાં નથી; જો અનન્ય_કોડ હાજર છે, પરંતુ તે અનન્ય નથી; અને, જો રંગ હાજર છે પરંતુ તે અસ્તિત્વમાં નથી.
જો પેરામીટર બોક્સ_વિગતો પ્રાપ્ત ન થાય અને બોક્સના પ્રકારને પોઝિશનની જરૂર હોય (ગ્રીડ, ટ્યુબ ટ્રે અથવા માઇક્રોપ્લેટ સાથેનું બોક્સ), તો એક ભૂલ સંદેશ પરત કરવામાં આવે છે. 
નોંધ: પ્રોજેક્ટ_કોડ ફીલ્ડનો ઉપયોગ POST અને PUT માં થઈ શકે છે અને તે ટેક્સ્ટની અપેક્ષા રાખે છે (id નહીં). તમે હવે નવો પ્રોજેક્ટ કોડ બનાવી શકો છો જો તે અસ્તિત્વમાં ન હોય અને જો ઑપરેટર પાસે પૂરતી પરવાનગીઓ હોય (એડમિનિસ્ટ્રેટર અથવા સુપર-એડમિનિસ્ટ્રેટર).
2-3-4. DELETE પદ્ધતિ
સંસાધનને કાઢી નાખવા માટે, ફક્ત ઇચ્છિત રેકોર્ડ URI પર DELETE પદ્ધતિ સાથે વિનંતી મોકલો:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]/[DATA_ID]
API ભૂલ સંદેશાઓ
| સંદેશ | પ્રતિભાવ કોડ | વર્ણન |
| ઍક્સેસ કરવા માટે એપ્લિકેશન પ્રમાણીકરણની જરૂર છે Web સેવા' | 401 અનધિકૃત | વિનંતીમાં કાં તો હેડર પેરામીટર X- LC-APP-Auth નથી અથવા માન્ય મૂલ્ય નથી |
| 'અમાન્ય ક્રિયા xxx' | 400 ખરાબ વિનંતી | પરિમાણ ક્રિયાનું મૂલ્ય 'ટ્યુબ_સોર્ટર' કરતા અલગ છે અથવા 'નેટબેકઅપ' |
| શોધ પરિમાણો ખૂટે છે! | 400 ખરાબ વિનંતી | વિનંતીમાં Action=tube_sorter પેરામીટર છે પરંતુ તે નીચેના પરિમાણોમાંથી ઓછામાં ઓછું એક ખૂટે છે: box_id, box_name, record_name, unique_code, barcode, aliquot_barcode |
| મોડ્યુલ “XXX” અસ્તિત્વમાં નથી!' | 400 ખરાબ વિનંતી | પેરામીટર 'મોડ્યૂલ'નું મૂલ્ય GB કલેક્ટર મોડ્યુલ નથી |
| મોડ્યુલ “XXX” આ ડેટા શેર કરતું નથી!' | 403 પ્રતિબંધિત | પેરામીટર 'મોડ્યૂલ' ની કિંમત ચકાસાયેલ નથી લેબ કલેક્ટર > એડમિન > સેટઅપ > Web સેવા |
| 'વિનંતીનું ફોર્મેટ સ્વીકારાયું નથી!' | 415 અસમર્થિત મીડિયા પ્રકાર | એક્સેપ્ટ પેરામીટરનો ઉપયોગ થાય છે, પરંતુ મૂલ્ય સ્વીકૃત મૂલ્યોમાંથી એક નથી: એપ્લિકેશન/XML અથવા એપ્લિકેશન/JSON |
| (ખાલી) | 406 સ્વીકાર્ય નથી | પદ્ધતિ નીચેનામાંથી એક હોવી જોઈએ: GET, POST, PUT, DELETE |
| 'કોઈ ડેટા મળ્યો નથી.' | 404 મળ્યો નથી | આ વિનંતીના પરિમાણો સાથે કોઈ ડેટા મળ્યો નથી |
| 'ઠીક.' | 200 બરાબર | રેકોર્ડ સફળતાપૂર્વક અપડેટ થયો |
| 'સંઘર્ષ.' | 409 સંઘર્ષ | રેકોર્ડ અપડેટ કરી શકાયો નથી કારણ કે ત્યાં છે ડેટામાં સંઘર્ષ |
| આ મોડ્યુલ માટે કોઈ સજીવ મૂલ્ય નથી | 404 મળ્યો નથી | ફક્ત મોડ્યુલો "તાણ", "ઓampલેસ" અને માઇક્રોએરે" સજીવ મૂલ્ય છે - તમે ખોટું પસંદ કર્યું છે મોડ્યુલ |
| આ મોડ્યુલ માટે કોઈ શ્રેણી મૂલ્ય નથી | 404 મળ્યો નથી | માત્ર મોડ્યુલ 'દસ્તાવેજ'માં શ્રેણીઓ છે – તમે પસંદ કરેલ છે એક ખોટું મોડ્યુલ |
| Webસેવાને વપરાશકર્તા પ્રમાણીકરણની જરૂર છે | 401 અનધિકૃત | નાપસંદ |
| તમારા IP ને આ ઍક્સેસ કરવાની મંજૂરી નથી Web સેવા' | 401 અનધિકૃત | ક્લાયંટ IP આ માટે અધિકૃત IP ની સૂચિમાં નથી Webસેવાઓ (LC > એડમિન > સેટઅપ > Web સેવા) |
| તમારી વિનંતી દરમિયાન ભૂલ, નવી બનાવવા માટે નીચેની માહિતી ફરજિયાત છે રેકોર્ડ: X, Y, Z' |
400 ખરાબ વિનંતી | ફરજિયાત ક્ષેત્રો X, Y, વિના નવો ડેટા પોસ્ટ કરવાનો પ્રયાસ Z |
| તમારી વિનંતી દરમિયાન એક ભૂલ આવી છે, વોલ્યુમ દૂર કરવા માટે નીચેની માહિતી ફરજિયાત છે: અનન્ય_કોડ અથવા બારકોડ અથવા અલીકોટ_બારકોડ, જથ્થો, જથ્થો | 400 ખરાબ વિનંતી | ફરજિયાત વગર વોલ્યુમ દૂર કરવાનો પ્રયાસ પરિમાણો: અનન્ય_કોડ અથવા બારકોડ અથવા અલીકોટ_બારકોડ, જથ્થો |
| તમારી વિનંતી દરમિયાન એક ભૂલ આવી છે, નીચેની માહિતી ફરજિયાત છે સ્ટોરેજ દૂર કરો: અનન્ય_કોડ અથવા બારકોડ અથવા aliquot_barcode, જથ્થો ' |
400 ખરાબ વિનંતી | ફરજિયાત વગર સંગ્રહને દૂર કરવાનો પ્રયાસ કરો પરિમાણ: અનન્ય_કોડ અથવા બારકોડ અથવા અલીકોટ_બારકોડ |
| " | 200 બરાબર | વિનંતી કરેલ ડેટા સફળતાપૂર્વક પરત કરવામાં આવ્યો હતો |
લેબકોલેક્ટર WEB SERVICE API - ANNEX
API ની URI સિસ્ટમ સરળ અને સ્વચ્છનો ઉપયોગ કરે છે URL. નીચેના કોષ્ટકમાં સંદર્ભિત URI નો ઉપયોગ કરવા માટે Apache માંથી પુનઃલેખન એન્જિનને સક્ષમ કરવાની ખાતરી કરો. જો લેબકોલેક્ટર સર્વર ફરીથી લખવાના એન્જિનને સપોર્ટ કરતું નથી, તો કૃપા કરીને સંપૂર્ણ ઉપયોગ કરો URL તમારી વિનંતી માટે પેટર્ન (ગૌણ URL દરેક લીટીની).
| UM | મોડ્યુલ | વર્ણન | |
| webservice/v2/strains webservice/index.PHP?v=2&module=strai ns | પોસ્ટ મેળવો | તાણ અને કોષો | તમામ રેકોર્ડની યાદી |
| webservice/v2/strains/(DATA JD] webservice/index.PHP?v=2&module=strai ns&data jd.[DATA _ID] | મૂકો | તાણ અને કોષો | અનોખો રેકોર્ડ |
| webસેવા/v2/સ્ટ્રેન્સ/કસ્ટમ ક્ષેત્રો webservice/index.php?v=2&module=strai ns&getModuleCustomFields=1 | મેળવો | તાણ અને કોષો | કસ્ટમ ફીલ્ડ્સની સૂચિ |
| webservice/v2/strains/organisms webservice/index.PHP?v=2&module=strai ns&getModuleOrganisms=1 | મેળવો | તાણ અને કોષો સજીવો | ની યાદી |
| webસેવા/v2/પ્લાઝમિડ્સ webservice/index.php?v=2&module=plas mids | પોસ્ટ મેળવો | પ્લાઝમિડ્સ | તમામ રેકોર્ડની યાદી |
| webservice/v2/plasmids/IDATAjD] webservice/index.php?v=2&module=plasmids&data _id=IDATA _ID] | મેળવો મૂકો | પ્લાઝમિડ્સ | અનોખો રેકોર્ડ |
| webસેવા/v2/પ્લાઝમિડ્સ/કસ્ટમ ફીલ્ડ્સ webservice/index.PHP?v=2&module=plas mids&getModuleCustomFields=1 | મેળવો | પ્લાઝમિડ્સ ક્ષેત્રો | કસ્ટમની સૂચિ |
| webservice/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] | GET મૂકો | પ્રાઇમર્સ | અનોખો રેકોર્ડ |
| webservice/v2/primers/કસ્ટમ ફીલ્ડ | મેળવો | પ્રાઇમર્સ | કસ્ટમ ફીલ્ડ્સની સૂચિ |
| webservice/index.PHP?v=2&module=pri mers&getModuleCustomFields=1 | |||
| webservice/v2/chemicals 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/sampલેસ webservice/index.PHP?v=2&module=sam pies | પોસ્ટ મેળવો | Sampલેસ | તમામ રેકોર્ડની યાદી |
| webસેવા/v2/samples/IDATA_ID) web service/index.PHP?v=2&module=sam ples&data_id=[DATA _ID] | મૂકો | Sampલેસ | અનોખો રેકોર્ડ |
| webસેવા/v2/sampલેસ/કસ્ટમ ક્ષેત્રો webservice/index.PHP?v=2&module=sam ples&getModuleCustomFields=1 | મેળવો | Sampલેસ | કસ્ટમ ફીલ્ડ્સની સૂચિ |
| webસેવા/v2/sampલેસ/સજીવો webservice/index.php?v=2&module=sam ples&getModuleOrganisms=1 | મેળવો | Sampલેસ | સજીવોની યાદી |
| webસેવા/v2/sampલેસ/પ્રકાર webservice/index.PHP?v=2&module=sam ples&getModuleTypes=1 | મેળવો | Sampલેસ | ની યાદી એસampલે પ્રકારો |
| webservice/v2/એન્ટીબોડીઝ webservice/index.PHP?v=2&module=એન્ટી બોડીઝ | પોસ્ટ મેળવો | એન્ટિબોડીઝ | તમામ રેકોર્ડની યાદી |
| webservice/v2/antibodies/(DATA _iDi webservice/index.PHP?v=2&module=anti bodies&data_id=IDATA _ID] | મૂકો | એન્ટિબોડીઝ | અનોખો રેકોર્ડ |
| webservice/v2/એન્ટિબોડીઝ/કસ્ટમ ફીલ્ડ્સ webservice/index.PHP?v=2&module=anti bodies&getModuleCustomFields=1 | મેળવો | એન્ટિબોડીઝ ક્ષેત્રો | કસ્ટમની સૂચિ |
| webservice/v2/sequences webservice/index.PHP?v=2&module=seq uences | પોસ્ટ મેળવો | સિક્વન્સ | તમામ રેકોર્ડની યાદી |
| webservice/v2/sequences/(DATA _iDI webservice/index.PHP?v=2&module=seq uences&data _icHCIATA JD] | મેળવો મૂકો |
સિક્વન્સ | અનોખો રેકોર્ડ |
| webસેવા/v2/સિક્વન્સ/કસ્ટમ ફીલ્ડ webservice/index.PHP?v=2&module=seq uences&getModuleCustomFields=1 | મેળવો | સિક્વન્સ ફીલ્ડ્સ | કસ્ટમની સૂચિ |
| webસેવા/v2/પ્રાણીઓ webservice/index.PHP?v=2&module=ani mats | પોસ્ટ મેળવો | પ્રાણીઓ | તમામ રેકોર્ડની યાદી |
| webservice/v2/animals/(DATA JD] webservice/index.PHP?v=2&module=ani mals&data _ick[DATA JD] | મેળવો મૂકો | પ્રાણીઓ | અનોખો રેકોર્ડ |
| webservice/v2/animals/કસ્ટમ ફીલ્ડ 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 ઉપચાર | પોસ્ટ મેળવો | રાસાયણિક માળખાં | તમામ રેકોર્ડની યાદી |
| webservice/v2/structures/(DATA_ID] webservice/index.PHP?v=2&module=stru ctures&data jd=(DATA JD] | મૂકો | રાસાયણિક માળખાં | અનોખો રેકોર્ડ |
| webસર્વિસ/v2/સ્ટ્રક્ચર્સ/કસ્ટમ ફીલ્ડ webservice/index.PHP?v=2&module=stru cturesketModuleCustomFields=1 | મેળવો | રાસાયણિક માળખાં | કસ્ટમ ફીલ્ડ્સની સૂચિ |
| webservice/v2/docs webservice/index.PHP?v=2&module=docs | પોસ્ટ મેળવો | દસ્તાવેજો | તમામ રેકોર્ડની યાદી |
| webservice/v2/docs/(DATA JD] webservice/index.PHP?v=2&module=docs &data _idADATA _ID] | મૂકો | દસ્તાવેજો | અનોખો રેકોર્ડ |
| webservice/v2/docs/કસ્ટમ ફીલ્ડ્સ webservice/index.php?v=2&module=docs &getModuleCustomFields=1 | મેળવો | દસ્તાવેજો | કસ્ટમ ફીલ્ડ્સની સૂચિ |
| webservice/v2/docs/categories webservice/index.PHP?v=2&module=docs &getModuleCategories=1 | મેળવો | દસ્તાવેજોની શ્રેણીઓ | ની યાદી |
| webservice/v2/book webservice/index.PHP?v=2&module=abo બરાબર | પોસ્ટ મેળવો | એડ્રેસ બુક | તમામ રેકોર્ડની યાદી |
| webસેવા/v2/book/(ડેટા _ID] webservice/index.php?v=2&module=abo OK&data_idADATA _ID] | મૂકો | એડ્રેસ બુક | અનોખો રેકોર્ડ |
| webservice/v2/book/કસ્ટમ ફીલ્ડ્સ webservice/index.PHP?v=2&module=abo ok&getModuleCustomFields=1 | મેળવો | એડ્રેસ બુક | કસ્ટમ ફીલ્ડ્સની સૂચિ |
| webservice/v2/book/categories webservice/index.PHP?v=2&module=abo ok&getModuleCategories=1 | મેળવો | એડ્રેસ બુક કેટેગરીઝ | ની યાદી |
| webservice/v2/microarrays webservice/index.PHP?v=2&module=micr એરે | પોસ્ટ મેળવો | માઇક્રોએરે | તમામ રેકોર્ડની યાદી |
| webservice/v2/microarrays/(DATA_ID] webservice/index.PHP?v=2&module=micr oarrays&data_id=[DATA _ID] | મેળવો મૂકો | માઇક્રોએરે | અનોખો રેકોર્ડ |
| webservice/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 | મેળવો | માઇક્રોએરે સજીવો | ની યાદી |
| webservice/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] | મૂકો | કસ્ટમ મોડ્યુલ | અનોખો રેકોર્ડ |
| webservice/v2/(CUSTOM_MODULE_NAM Elicustomfields webservice/index.PHP?v=2&module=[CU STOM_MODULE_NAME184getModuleCust omFields=1 | મેળવો | કસ્ટમ મોડ્યુલ | કસ્ટમ ફીલ્ડ્સની સૂચિ |
http://www.labcollector.comsales@agilebio.com
AgileBio યુએસએ
5473 Kearny વિલા રોડ સ્યુટ 255
સાન ડિએગો, CA 92123
યુએસએ
ટેલિફોન: 347 368 1315
ફેક્સ: (800) 453 9128
http://www.agilebio.com
AgileBio હેડક્વાર્ટર
75 rue de Lourmel
75015 પેરિસ
ફ્રાન્સ
ટેલિફોન: 01 41 79 15 85
ફેક્સ: 01 72 70 40 22
દસ્તાવેજો / સંસાધનો
 |
લેબ કલેક્ટર Web સર્વિસ એપ્લિકેશન પ્રોગ્રામિંગ ઈન્ટરફેસ સોફ્ટવેર [પીડીએફ] વપરાશકર્તા માર્ગદર્શિકા Web સર્વિસ એપ્લિકેશન પ્રોગ્રામિંગ ઈન્ટરફેસ, સોફ્ટવેર, Web સર્વિસ એપ્લિકેશન પ્રોગ્રામિંગ ઈન્ટરફેસ સોફ્ટવેર |
