Գործընկերների ցուցակ |
  
|
Գործընկերների ցուցակ |
|
API-ի միջոցով հնարավոր է ստանալ (POST) գործընկերների ցուցակը:
URI |
https://api.armsoft.am/trade/v1/directories/partners/list |
URL Swagger |
https://api.armsoft.am/trade/swagger/index.html#/Partners/post_v1_directories_partners_list |
GitHub |
https://github.com/armsoft/trade-public-api-docs/tree/main/docs/api/directories/partners/list |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
group |
String(5) |
Optional Reference type |
Գործընկերոջ խումբը։ |
codes |
Array |
Optional |
Գորրծընկերջ կոդը։ |
extended |
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)
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
code |
String(20) |
*Required |
Գործընկերոջ կոդը։Նոր ավելացվող գործընկերոջ համար, որպես հերթական կոդ, համակարգն ավտոմատ առաջարկում է հաջորդը, որը հաշվարկվում է վերջին ավելացված գործընկերոջ կոդից։ Այս դաշտը խմբագրման ենթակա չէ։Պարտադիր լրացվող դաշտ է։ |
name |
String(50) |
*Required |
Գործընկերոջ անվանումը։Պարտադիր լրացվող դաշտ է։ |
fullName |
String(255) |
Optional |
Գործընկերոջ լրիվ անվանումը։ |
taxCode |
String(20) |
Optional |
Գործընկերոջ հարկ վճարողի հաշվառման համարը։ |
group |
String(5) |
*Required |
Գործընկերոջ խմբի անվանումը։ |
supplier |
Boolean |
Optional |
Հայտանիշ, արդյոք գործընկերը Մատակարար է, թե ոչ: |
costumer |
Boolean |
Optional |
Հայտանիշ, արդյոք գործընկերը Գնորդ է, թե ոչ: |
legalAddress |
String(255) |
Optional |
Գործընկերոջ իրավաբանական հասցեն։ |
businessAddress |
String(255) |
Optional |
Գործընկերոջ գործունեության իրականացման վայրի հասցեն։ |
managerName |
String(50) |
Optional |
Գործընկերոջ ղեկավարի ազգանուն, անուն, հայրանունը։ |
managerPosition |
String(50) |
Optional |
Գործընկերոջ ղեկավարի պաշտոնը։ |
accountantName |
String(50) |
Optional |
Գործընկերոջ հաշվապահի ազգանուն, անուն, հայրանունը։ |
accountantPosition |
String(50) |
Optional |
Գործընկերոջ հաշվապահի պաշտոնը։ |
paymentMainAim |
String(50) |
Optional |
Վճարման հիմնական նպատակ։ |
phoneNumber |
String(50) |
Optional |
Գործընկերոջ հեռախոսահամար։ |
String(129) |
Optional |
Գործընկերոջ էլեկտրոնային փոստի հասցեն։ |
|
stateRegisterNumber |
String(50) |
Optional |
Եթե տվյալ գործընկերը անհատ ձեռնարկատեր է, ապա այստեղ լրացվում է նրա պետական գրանցման վկայականի համարը։ |
passportNumber |
String(32) |
Optional |
Գործընկերոջ անձնագևային համարը։ |
gender |
Enum |
Optional |
Գործընկերոջ սեռը։ Ընդունում է հետևյալ արժեքները․ 1-Արական 2-Իգական |
birthDate |
Date(YYYY-MM-DD) |
Optional |
Լրացվում է գործընկերոջ ծննդյան ամսաթիվը։ |
idDocumentType |
Enum |
Optional |
Գործընկերոջ անձը հաստատող փաստաթղթի տեսակ: |
status |
String |
Optional |
Մեկնաբանություն։ |
groupName |
String(50) |
Optional |
Գործընկերոջ խմբի անվանումը։ |
settlementAccount |
Array |
Optional |
Հաշվարկային հաշիվներ (մասսիվ): |
userName |
String(50) |
Optional |
Օգտագործողի անվանումը։ |
creationDate |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Optional |
Ստեղծման օրը։ |
lastChange |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Optional |
Վերջին կատարված փոփոխություն։ |
GitHub |
https://github.com/armsoft/trade-public-api-docs/tree/main/examples/csharp/directories/partners |
Օրինակ 1. Նշված խմբով և ընդլայնված տարբերակով գործընկերների ցուցակի ստացում
|
