API-ի միջոցով հնարավոր է ստանալ (POST) Աշխատակիցների ցուցակը։
URI |
https://api.armsoft.am/accountant/v1/directories/employees/list |
URL Swagger |
https://api.armsoft.am/accountant/swagger/index.html#/Employees/post_v1_directories_employees_list |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
@SKq7*ERI]ZIgXvpkWhV |
Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:
Հարցման պարամետրեր (Request Body)
Աշխատակիցների տեղեկատուի ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
pageSize |
Integer |
Optional |
Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վերադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։ Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
codes |
Array |
Optional Reference type |
Աշխատակիցների կոդերը։ |
lastModifiedDate |
Enum |
Optional |
Վերջին խմբագրման ամսաթիվը։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
data[] |
Array |
Տվյալների ցուցակ (մասսիվ), որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։ |
Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Աշխատակցի ներքին նույնացուցիչ։ |
code |
String |
Աշխատակցի տաբելային համար։ Արժեք չտալու դեպքում ընդունում է ծրագրից գեներացված հերթական համարը։ |
fullName |
String |
Աշխատակցի ազգանուն, անուն, հայրանունը: |
departmentCode |
String |
Աշխատակցի ստորաբաժանման կոդը։ |
departmentName |
String |
Աշխատակցի ստորաբաժանման անվանումը։ |
positionCode |
String |
Աշխատակցի պաշտոնի կոդը: |
positionName |
String |
Աշխատակցի պաշտոնի անվանումը: |
positionStartDate |
Date(YYYY-MM-DD) |
Աշխատակցի պաշտոնի նշանակման ամսաթիվը: |
defaultTimeSheet |
String |
Աշխատակցի հիմնական աշխատանքի գրաֆիկի կոդը։ |
contractTypeCode |
String |
Աշխատակցի հետ կնքված պայմանագրի տեսակի կոդը։ |
contractTypeName |
String |
Աշխատակցի հետ կնքված պայմանագրի տեսակի անվանումը։ |
employmentStartDate |
Date(YYYY-MM-DD) |
Աշխատակցի աշխատանքի ընդունման ամսաթիվը: |
birthDate |
Date(YYYY-MM-DD) |
Աշխատակցի ծննդյան ամսաթիվը: |
genderCode |
String |
Աշխատակցի սեռի կոդը։ |
genderName |
String |
Աշխատակցի սեռը։ |
phone |
String |
Աշխատակցի հեռախոսի համարը: |
passport |
String |
Աշխատակցի անձնագրի համարը: |
bankAccount |
String |
Աշխատակցի հաշվի համարը բանկում: |
professionName |
String |
Աշխատակցի մասնագիտությունը: |
raCitizen |
Boolean |
Աշխատակցի ՀՀ ռեզիդենտ լինելու հայտանիշ։ |
calculateIncomeTax |
Boolean |
Աշխատակցից եկամային հարկը պահելու հայտանիշ։ |
stampFeeType |
Enum |
Դրոշմանիշային վճար վճարողի կարգավիճակը: |
insuranceFeeType |
Enum |
Ապահովագրավճար վճարողի կարգավիճակը: |
insuranceFeeDate |
Date(YYYY-MM-DD) |
Ամսաթիվը, որից սկսած գործում է ապահովագրավճար վճարողի կարգավիճակը։ |
salaryAccount |
String |
Աշխատավարձի հաշվառման սինթետիկ հաշիվը։ |
partnerCode |
String |
Աշխատակցին կցված գործընկերոջ կոդը: |
partnerName |
String |
Աշխատակցին կցված գործընկերոջ անվանումը: |
tradeUnionDuesPercent |
Decimal |
Աշխատակցի արհմիութենական անդամավճարի տոկոսի չափը: |
participationStatus |
Enum |
Կուտակային կենսաթոշակային համակարգին մասնակցության կարգավիճակը։ |
lastModifierName |
String |
Օգտագործողի անվանումը։ |
lastModifyDate |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Վերջին կատարված փոփոխություն։ |
Օրինակ 1. Աշխատակիցների ցուցակի ստացում
|