Գործընկերների պայմանագրերի ցուցակ |
  
|
Գործընկերների պայմանագրերի ցուցակ |
|
API-ի միջոցով հնարավոր է ստանալ (POST) գործընկերների պայմանագրերի ցուցակը:
URI |
https://api.armsoft.am/trade/v1/directories/partners/contract/list |
URL Swagger |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:
Հարցման պարամետրեր (Request Body)
Գործընկերների պայմանագրերի ցուցակ տեղեկատուի ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
pageSize |
Integer |
Optional |
Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վեչադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։ Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
PartnerCodes |
String(20) |
*Required |
Գորրծընկերջ կոդը։ |
currency |
String(3) |
*Required |
Արժույթ։ |
exceptNCC |
Boolean |
Optional |
|
onlyCustomers |
Boolean |
Optional |
Մատակարար է, թե ոչ։ |
onlySuppliers |
Boolean |
Optional |
Գնորդ է, թե ոչ։ |
onlyBonusCards |
Boolean |
Optional |
Բոնուսային քարտ կիրառվում է, թե ոչ։ |
lastModifiedDate |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Optional |
Վերջին խմբագրման ամսաթիվ։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
id |
UUID |
System defined |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Optional |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
data[] |
Array |
Optional |
Տվյալների ցուցակ (մասսիվ), որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։ |
Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
partnerId |
UUID |
System defined |
Գործընկերոջ նույնացուցիչ։ |
partnerCode |
String(20) |
*Required |
Գործընկերոջ կոդ։ |
partnerName |
String(50) |
*Required |
Գործընկերոջ անվանումը։Պարտադիր լրացվող դաշտ է։ |
partnerTaxCode |
String(20) |
Optional |
Գործընկերոջ հարկ վճարողի հաշվառման համարը։ |
partnerPhone |
String(50) |
Optional |
Գործընկերոջ հեռախոսահամար։ |
partnerGroup |
String(5) |
*Required |
Գործընկերոջ խումբ։ |
partnerGroupName |
String(5) |
*Required |
Գործընկերոջ խմբի անվանումը։ |
costumer |
Boolean |
Optional |
Հայտանիշ, արդյոք գործընկերը Գնորդ է, թե ոչ: |
supplier |
Boolean |
Optional |
Հայտանիշ, արդյոք գործընկերը Մատակարար է, թե ոչ: |
contractCode |
String(3) |
Optional |
Պայմանագրի կոդ։ |
contractName |
String(45) |
Optional |
Պայմանագրի անվանումը։ |
currency |
String(3) |
Optional |
Արժույթ։ |
priceType |
Array |
Optional |
Գնի տեսակի կոդ: |
date |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Optional |
Պայմանագրի կնքման ամսաթիվ: |
description |
String(45) |
Optional |
Պայմանագրի նկարագրություն: |
discountPercent |
Decimal |
Optional |
Զեղչի տոկոս։ |
cardCode |
String(45) |
Optional |
Քարտի կոդ: |
bonusCard |
Boolean |
Optional |
Բոնուսային պայմանագիր է, թե ոչ։ |
bonusPercen |
Decimal |
Optional |
Բոնուսային քարտի %: |
bonusPoint |
Decimal |
Optional |
Բոնուսային քարտի միավոր: |
validationPeriodStart |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Optional |
Վավերականության ժամկետի սկիզբ։ |
validationPeriodEnd |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Optional |
Վավերականության ժամկետի ավարտ։ |
canceled |
Boolean |
Optional |
Պայմանագիրը կասեցված է, թե ոչ։ |
receivablesControl |
Boolean |
Optional |
Պայմանագրով պարտքի մնացորդը կվերահսկվում է, թե ոչ: |
receivablesLimit |
Decimal |
Optional |
Պայմանագրով պարտքի մնացորդի սահմանաչափ: |
default |
Boolean |
Optional |
Հիմնական պայմնագիրն է, թե ոչ։ |
GitHub |
https://github.com/armsoft/trade-public-api-docs/tree/main/examples/csharp/directories/partners |
Օրինակ 1. Նշված գործընկերոջ կոդով և ընդլայնված տարբերակով պայմանագրերի ցուցակի ստացում
|
