API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) գործընկերների խմբերը։
URI
|
https://api.armsoft.am/trade/v1/directories/partnersgroups
|
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:'
|
Գործընկերների խմբեր օբյեկտի դաշտերը
Ստորև ներկայացված է օբյեկտի դաշտերի նկարագրությունը.
Անվանում
|
Տեսակ
|
Կիրառումը
|
Նկարագրություն
|
code
|
String(5)
|
*Required
|
Գործընկերոջ խմբի կոդ։
|
name
|
String(50)
|
Optional
|
Գործընկերոջ խմբի անվանում։
|
parent
|
String(5)
|
Optional
|
Կուտակիչ խմբի կոդ։
|
path
|
String
|
System defined
|
Գործընկերոջ խմբի անվանումը, որի մեջ մտնում է տվյալ ենթախումբը։
|
Օրինակ 1. Գործընկերների խմբի ավելացում
POST
|
Request
curl -X 'POST' \
https://api.armsoft.am/trade/v1/directories/partnersgroups' \
-H 'accept: text/plain' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: If;]_v&aEh06.L$h.ipU ' \
-H 'Content-Type: application/json' \
-d '{
"code": "01",
"name": "Մատակարարներ",
"parent": "",
"path": "011"
}'
Response body (201 Created)
{
"code": "01",
"name": "Մատակարարներ",
"parent": "",
"path": "011"
}
|
|
Օրինակ 2. Գործընկերների խմբերի ցուցակի ստացում
GET
|
Request
curl -X 'GET' \
'https://api.armsoft.am/trade/v1/directories/partnersgroups' \
-H 'accept: text/plain' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: If;]_v&aEh06.L$h.ipU '
Response body (200 OK)
[
{
"code": "01",
"name": "Մատակարարներ",
"parent": "",
"path": "011"
},
{
"code": "012",
"name": "Արտերկրյա մատակարարներ",
"parent": "01",
"path": "01!012"
},
{
"code": "02",
"name": "Գնորդներ",
"parent": "",
"path": "02"
},
{
"code": "04",
"name": "Այլ",
"parent": "",
"path": "04"
}
]
|
|
Օրինակ 3. Նշված կոդով գործընկերների խմբի տվյալների ստացում
GET
|
Request
curl -X 'GET' \
'https://api.armsoft.am/trade/v1/directories/partnersgroups/01' \
-H 'accept: */*' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: If;]_v&aEh06.L$h.ipU '
Response body (200 OK)
[
{
"code": "01",
"name": "Մատակարարներ",
"parent": "",
"path": "011"
}
]
|
|
Օրինակ 4. Նշված կոդով գործընկերների խմբի տվյալների խմբագրում
PUT
|
Request
curl -X 'PUT' \
'https://api.armsoft.am/trade/v1/directories/partnersgroups/01' \
-H 'accept: text/plain' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: If;]_v&aEh06.L$h.ipU ' \
-H 'Content-Type: application/json' \
-d '{
"code": "01",
"name": "Մատակարարներ",
"parent": "",
"path": "011"
}'
Response body (200 OK)
{
"code": "01",
"name": "Մատակարարներ նոր",
"parent": "",
"path": "011"
}
|
|
Օրինակ 3. Նշված կոդով գործընկերների խմբի հեռացում
DELETE
|
Request
curl -X 'DELETE' \
'https://api.armsoft.am/trade/v1/directories/partnersgroups/01' \
-H 'accept: */*' \
-H 'Accept-Language: hy-AM' \
-H 'apiKey: If;]_v&aEh06.L$h.ipU '
Response body (200 OK)
|
|
