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
|
Մանրածախ պահեստի հայտանիշ։
|
Օրինակ 1. Պահեստներ տեղեկատուում նոր տողի ավելացում
POST
|
Request
curl -X POST \
'https://api.armsoft.am/trade/v1/directories/storages' \
-H 'accept: text/plain' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: hJk:|^&99։՛(=0#biWc:'\
-H 'Content-Type: application/json' \
-d '
{
"code": "04",
"name": "Համակարգիչների հավաքման բաժին",
"stockkeeper": "Պողոսյան Հարութ",
"address": "",
"retail": false
}'
Response body (201 Created)
{
"code": "04",
"name": "Համակարգիչների հավաքման բաժին",
"stockkeeper": "Պողոսյան Հարութ",
"address": "",
"retail": false
}
|
|
Օրինակ 2. Պահեստներ տեղեկատուի ցուցակի ստացում
GET
|
Request
curl -X GET \
'https://api.armsoft.am/trade/v1/directories/storages' \
-H ': */*' \
-H '-Language: hy-AM' \
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' \
Response body (200 OK)
[
{
"code": "02",
"name": "Համակարգիչների հավաքման բաժին",
"stockkeeper": "Պողոսյան Հարութ",
"address": "",
"retail": false
},
{
"code": "03",
"name": "ՙԴԱԼՄԱ՚ տոնավաճառ",
"stockkeeper": "Ղարիբյան Լևոն",
"address": "",
"retail": true
},
{
"code": "00",
"name": "Կենտրոնական պահեստ",
"stockkeeper": "Կարապետյան Սերգեյ",
"address": "",
"retail": false
},
{
"code": "01",
"name": "Առևտրի սրահ",
"stockkeeper": "Սարդսյան Արմեն",
"address": "",
"retail": true
}
]
|
|
Օրինակ 3. Նշված կոդով Պահեստի տեղեկատուի տվյալների ստացում
GET
|
Request
curl -X GET \
'https://api.armsoft.am/trade/v1/directories/storages/02' \
-H 'accept: */*' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' \
Response body (200 OK)
{
"code": "02",
"name": "Համակարգիչների հավաքման բաժին",
"stockkeeper": "Պողոսյան Հարութ",
"address": "",
"retail": false
}
|
|
Օրինակ 4. Նշված կոդով պահեստի տեղեկատուի տվյալների խմբագրում
PUT
|
Request
curl -X PUT \
'https://api.armsoft.am/trade/v1/directories/storages/04' \
-H 'accept: text/plain' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' \
-H 'Content-Type: application/json'\
-d '
{
"code": "04",
"address": "Չարենցի 1"
}'
Response body (200 OK)
{
"code": "04",
"name": "Համակարգիչների հավաքման բաժին",
"stockkeeper": "Պողոսյան Հարութ",
"address": "Չարենցի 1",
"retail": false
}
|
|
Օրինակ 5. Նշված կոդով պահեստի տեղեկատուի հեռացում
DELETE
|
Request
curl -X DELETE \
'https://api.armsoft.am/trade/v1/directories/storages/04' \
-H 'accept: */*' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' \
Response body (200 OK)
|
|