Էջավորում

Ուղղորդիչ:  REST API (ամպային տարբերակ) >

Էջավորում

 Previous pageReturn to chapter overviewNext page

Բացել/Փակել թաքցված տեքստը

Այն դեպքերում, երբ հարցումների արդյունքում վերադարձվող տվյալների քանակը մեծ է, API-ն օգտագործում է էջավորման մեխանիզմ։ Էջավորումը թույլ է տալիս մեծ ծավալի տվյալները ստանալ մի քանի հաջորդական հարցումների միջոցով՝ մաս-մաս։ Յուրաքանչյուր հարցման արդյունքում վերադարձվում է տվյալների մի մասը։ Եթե կան դեռ չվերադարձված գրառումներ, պատասխանում ներառվում են հատուկ դաշտեր, որոնք թույլ են տալիս շարունակել հաջորդ էջերի ստացումը։

 

Էջավորումը գործում է հետևյալ հարցումների դեպքում՝

Անվանում

Endpoint

Ընդհանրացված փաստաթղթերի մատյան

URI: https://api.armsoft.am/accountant/v1/journals/alldocuments/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Journals/post_v1_journals_alldocuments_nextpage

Դուրս գրված հաշիվների մատյան

URI: https://api.armsoft.am/accountant/v1/journals/invoices/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Journals/post_v1_journals_invoices_nextpage

ՀԴՄ կտրոններ

URI: https://api.armsoft.am/accountant/v1/journals/ecrchecks/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Journals/post_v1_journals_ecrchecks_nextpage

Մնացորդներ

URI: https://api.armsoft.am/accountant/v1/reports/accountsbalances/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_accountsbalances_nextpage

Գործընկերների մնացորդներ

URI: https://api.armsoft.am/accountant/v1/reports/partnersbalances/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_partnersbalances_nextpage

Գործառնությունների մատյան

URI: https://api.armsoft.am/accountant/v1/reports/transactions/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_transactions_nextpage

Գործընկերների գործառնությունների մատյան

URI: https://api.armsoft.am/accountant/v1/reports/partnerstransactions/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_partnerstransactions_nextpage

Տեղեկանք ՆԱ առկայության մասին

URI: https://api.armsoft.am/accountant/v1/reports/materialsbalances/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_materialsbalances_nextpage

Գործընկերներ

URI: https://api.armsoft.am/accountant/v1/directories/partners/list/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Partners/post_v1_directories_partners_list_nextpage

Նյութական արժեքներ

URI: https://api.armsoft.am/trade/v1/directories/materials/list/nextpage

Swagger: https://api.armsoft.am/accountant/swagger/index.html#/Materials/post_v1_directories_materials_list_nextpage

 

Էջավորման (Pagination) պարամետրեր

Անվանում

Նկարագրություն

pageSize

Սահմանում է մեկ հարցման արդյունքում վերադարձվող գրառումների քանակը։

•Նվազագույն վերադարձվող քանակը 5000 տող է։

•Եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։

•Եթե pageSize = 0, վերադարձվում են բոլոր հասանելի տվյալները։

•Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։

id

Հարցման ունիկալ նույնացուցիչ է(GUID), որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման համար։

Եթե hasMore = true, նույն id-ը պետք է օգտագործել հաջորդ հարցման մեջ՝ մնացած տվյալները ստանալու համար։

hasMore

Լոգիկական (boolean) դաշտ, որը ցույց է տալիս՝ արդյոք կան դեռ չվերադարձված գրառումներ։

true արժեքի դեպքում առկա են լրացուցիչ տվյալներ (կա հաջորդ էջ):

false արժեքի դեպքում բոլոր տվյալներն արդեն վերադարձված են:

 

Հաջորդ էջի ստացում (Next Page)

 

Եթե hasMore = true, հաջորդ էջի տվյալները ստանալու համար անհրաժեշտ է կատարել նոր հարցում՝ օգտագործելով նախորդ պատասխանում վերադարձված id արժեքը։

 

Request

Անվանում

Տեսակ

Կիրառումը

Նկարագրություն

id

UUID

*Required

Նախորդ հարցման նույնացուցիչը:

close

Boolean

*Required

Լոգիկական (boolean) պարամետր։

Ընդունում է հետևյալ արժեքները․

false - ստանալ հաջորդ էջը,

true - ավարտել սեսիան։

 

Օրինակ

Առաջին հարցում

POST

Request

 

curl -X 'POST' \

 'https://api.armsoft.am/accountant/v1/directories/materials/list' \

 -H 'accept: text/plain' \

 -H 'Accept-Language: hy-AM' \

 -H 'apiKey: N03S=AI8*vE]vkhplZYD' \

 -H 'Content-Type: application/json' \

 -d '{

"pageSize": 5000

}'

 

Response body (200 Created)

 

{

  "id": "59e20a5d-0c25-4edf-b2f3-4a4821889c8c",

  "hasMore": true,

   "data": [

       {

           "id": 100000,

           "code": "1110001",

           "name": "Ալյումինե փայլաթիթեղ 0,090*60մմ",

           "fullName": "Ալյումինե փայլաթիթեղ 0,090*60մմ",

           "unitMeasure": "303",

           "unitMeasureAbbreviation": "կգ",

           "group": "111",

           "cpaClassifier": "7607",

           "account": "2111",

           "wholePrice": 0.0000,

           "retailPrice": 0.0000,

           "specification": "",

           "barcode": "",

           "externalCode": "",

           "costingMethod": "1",

           "aoeCoefficient": 1.0000,

           "discountPercent": 0.0000,

           "environmentalFeePercent": 0.0000,

           "minimumQuantity": 0.0000,

           "maximumQuantity": 0.0000,

           "vat": true,

           "revenueAccount": "",

           "retailRevenueAccount": "",

           "expenseAccount": "",

           "revenueAdjustmentAccount": "",

           "lastModifierName": "0 user",

           "lastModifyDate": "2018-02-21T12:42:12.52"

       },

       {

           "id": 100001,

           "code": "1110002",

           "name": "Ալյումինե փայլաթիթեղ 0,080*60մմ",

           "fullName": "Ալյումինե փայլաթիթեղ 0,080*60մմ",

           "unitMeasure": "305",

           "unitMeasureAbbreviation": "տ",

           "group": "111",

           "cpaClassifier": "7607",

           "account": "2111",

           "wholePrice": 0.0000,

           "retailPrice": 0.0000,

           "specification": "",

           "barcode": "",

           "externalCode": "",

           "costingMethod": "1",

           "aoeCoefficient": 1.0000,

           "discountPercent": 0.0000,

           "environmentalFeePercent": 0.0000,

           "minimumQuantity": 0.0000,

           "maximumQuantity": 0.0000,

           "vat": true,

           "revenueAccount": "",

           "retailRevenueAccount": "",

           "expenseAccount": "",

           "revenueAdjustmentAccount": "",

           "lastModifierName": "0 user",

           "lastModifyDate": "2018-02-21T12:42:12.637"

       }

այսիպիսի 4998 տող

 ]

}

 

Հաջորդ էջի հարցում

 

POST

Request

 

curl -X 'POST' \

 'https://api.armsoft.am/accountant/v1/directories/materials/list/nextpage' \

 -H 'accept: text/plain' \

 -H 'Accept-Language: hy-AM' \

 -H 'apiKey: N03S=AI8*vE]vkhplZYD' \

 -H 'Content-Type: application/json' \

 -d '{

"id": "59e20a5d-0c25-4edf-b2f3-4a4821889c8c",

"close": false

}

 

Response body (200 Created)

 

{

   {

  "id": "59e20a5d-0c25-4edf-b2f3-4a4821889c8c",

  "hasMore": false,

   "data": [

       {

           "id": 104085,

           "code": "21604032",

           "name": "Եռաբաշխիչ PPR անցում  32х25х20 (Lammin) 100/20",

           "fullName": "Եռաբաշխիչ PPR անցում  32х25х20 (Lammin) 100/20",

           "unitMeasure": "001",

           "unitMeasureAbbreviation": "հատ",

           "group": "216",

           "cpaClassifier": "3917",

           "account": "2161",

           "wholePrice": 96.0000,

           "retailPrice": 120.0000,

           "specification": "75165",

           "barcode": "",

           "externalCode": "",

           "costingMethod": "1",

           "aoeCoefficient": 1.0000,

           "discountPercent": 0.0000,

           "environmentalFeePercent": 0.0000,

           "minimumQuantity": 0.0000,

           "maximumQuantity": 0.0000,

           "vat": true,

           "revenueAccount": "",

           "retailRevenueAccount": "",

           "expenseAccount": "",

           "revenueAdjustmentAccount": "",

           "lastModifierName": "0 user",

           "lastModifyDate": "2018-02-21T12:44:46.457"

       },

       {

           "id": 104086,

           "code": "21604033",

           "name": "Եռաբաշխիչ PPR անցում  32х25х32 (Lammin) 120/20",

           "fullName": "Եռաբաշխիչ PPR անցում  32х25х32 (Lammin) 120/20",

           "unitMeasure": "001",

           "unitMeasureAbbreviation": "հատ",

           "group": "216",

           "cpaClassifier": "3917",

           "account": "2161",

           "wholePrice": 90.0000,

           "retailPrice": 100.0000,

           "specification": "75166",

           "barcode": "",

           "externalCode": "",

           "costingMethod": "1",

           "aoeCoefficient": 1.0000,

           "discountPercent": 0.0000,

           "environmentalFeePercent": 0.0000,

           "minimumQuantity": 0.0000,

           "maximumQuantity": 0.0000,

           "vat": true,

           "revenueAccount": "",

           "retailRevenueAccount": "",

           "expenseAccount": "",

           "revenueAdjustmentAccount": "",

           "lastModifierName": "0 user",

           "lastModifyDate": "2018-08-11T13:29:00.757"

       }

 ]

}