API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) պահեստները։
URI |
https://api.armsoft.am/trade/v1/directories/storages |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Պահեստների օբյեկտի դաշտերը
Ստորև ներկայացված է օբյեկտի դաշտերի նկարագրությունը.
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
code |
String(5) |
*Required |
Պահեստի կոդը։ Արժեք չտալու դեպքում համակարգի կողմից ավտոմատ գեներացվում է հաջորդական կոդ։ |
name |
String(50) |
*Required |
Պահեստի անվանումը։ |
stockkeeper |
String(50) |
Optional |
Պահեստապետ։ Ուղարկվում է աշխատակցի կոդը։ |
address |
String(255) |
Optional |
Պահեստի հասցե։ |
retail |
Boolean |
Optional |
Մանրածախ պահեստի հայտանիշ։ |
isClosed |
Boolean |
*Required |
True արժեքի դեպքում տվյալ պահեստը ընտրման ցուցակներում չի առաջարկվի: Փաստաթղթերի գրանցումը փակված հայտանիշով տեղեկատուների դեպքում թույլատրվում է: Արժեք չտալու դեպքում համակարգը ավտոմատ վերագրում է false արժեքը։ |
Օրինակ 1. Պահեստներ տեղեկատուում նոր տողի ավելացում
|
Օրինակ 2. Պահեստներ տեղեկատուի ցուցակի ստացում
|
Օրինակ 3. Նշված կոդով Պահեստի տեղեկատուի տվյալների ստացում
GET |
|
Օրինակ 4. Նշված կոդով պահեստի տեղեկատուի տվյալների խմբագրում
|
Օրինակ 5. Նշված կոդով պահեստի տեղեկատուի հեռացում
|