We will describe methods and steps to implement REST API Pagination in SSIS PowerPack or\u00a0\u00a0ODBC PowerPack API Drivers (for apps like Excel, Power BI, Informatica…)<\/a> without coding. Both Products share a similar user interface with minor differences. For example purpose, we will show screenshots from SSIS PowerPack UI but concepts should remain same. You will also learn some techniques about how to implement an infinite loop in SSIS<\/strong>.\u00a0Sometimes your REST API requires you to loop through all pages until no more data found then you can use pattern described in this article (sample package attached at the end).<\/p>\n In this article, we will use\u00a0SSIS REST API Task<\/a> and JSON Source Connector<\/a>\u00a0to process data from RESTful web service. If you have to process XML (or SOAP) data from REST API then simply use XML Source Connector for REST API, SOAP or File<\/a> rather than JSON Source.<\/p>\n Before we look at various aspects of REST API Pagination, we highly recommend you install FREE Web Debugging Tool Fiddler. Look at this article<\/a> to understand how to debug REST API requests.<\/p>\n If you have paging requirement by specifying page number in URL then you can loop until no more pages found. Your REST API can indicate no more page found by any of the following ways.<\/p>\n Example URL:\u00a0<\/strong> http:\/\/myserver.com\/v1\/api\/getcustomers\/?page=1<\/strong><\/p>\n If no more data found for specified page number then<\/p>\n JSON Source Connector<\/a>\u00a0comes with flexible paging options to handle this scenario. See below screenshot how to configure this.<\/p>\n REST API Looping\/Pagination via URL Page Number Parameter (Loop until last page detected)<\/p><\/div>\n URL with offset and limit<\/strong><\/p>\n Sometimes you may have URLs with offset + limit parameters. as below. In this case, you can use the same technique as the above screenshot but just specify Page Num Indicator as offset<\/strong> and Increment by the same as your limit parameter (e.g. 1000 in this case). At runtime, your offset parameter will increment and generate URLs like below to fetch the next page.<\/p>\n Example URLs:\u00a0<\/strong> Sometimes your URL may contain a page or other identifier using path format.<\/p>\n Example URLs:\u00a0<\/strong> If no more data is found for the specified page number then<\/p>\n JSON Source Connector<\/a>\u00a0comes with flexible paging options to handle this scenario. See the below screenshot of how to configure this.<\/p>\n REST API Looping\/Pagination via URL Path (Loop until last page detected)<\/p><\/div>\n Now let’s look at another common pattern just like the offset we discussed earlier but in the Skip pattern, it starts at zero rather than offset=1. In the previous mode, we didn’t have the option to supply the initial value to start the counter but if you use Path mode then you can start the counter at some custom value. See the below screen to show how we can setup pagination with the skip method with custom increment.<\/p>\n Example URLs<\/strong><\/p>\n REST API Pagination with Custom Skip \/ Increment Settings (Offset Starts from 0)<\/p><\/div>\n <\/p>\n This method is not discussed in this article but click here to read more<\/a><\/p>\n There are mainly 3 ways you can get next link or cursor.<\/p>\n Example response with next URL would be<\/p>\n In this method you don’t specify page number in URL. If response\u00a0include many records then you will get partial response along with indicator\u00a0of next link.<\/p>\n For more information about this\u00a0REST API Pagination<\/em>\u00a0please check below links. It explains in depth how to paginate REST API response with next page link found in response.<\/p>\n OData Paging using SSIS \u2013 REST API Paging Example<\/a><\/p>\n Read Twitter data in SSIS using REST API Task and JSON Source \u2013 OAuth2 Protocol<\/a><\/p>\n SSIS API Pagination \u2013 Next Link from Response Attribute<\/p><\/div>\n Now let’s look at a little bit different scenario where the Next Link is never empty even on the last page. This can cause an infinite loop if we configure it like the last section. So in such a case (see below example) when the last page still has the next link URL but the data row array is empty then use settings like the screenshot below.<\/p>\n First Page Example<\/strong><\/p>\n Last Page\u00a0Example<\/strong><\/p>\n Example: Last Page<\/strong><\/p>\n Basically, configure the following options<\/p>\n Last Page with non empty next link and empty data array (Detect Last Page based on zero row count)<\/p><\/div>\n Many API returns cursor rather than link. Cursor method usually used to support a large number of records. Cursor is opened at server side with initial query information you submit and if cursor has more records you may get next cursor indicator in your response. In cursor method you have to supply Suffix for Next URL so after First URL your next URL will contain extra attribute which will include pagination information.<\/p>\n Suffix for next URL<\/strong><\/p>\n Suffix for next URL can include special placeholders. There are two placeholders allowed. If you wish to append Next URL value in raw text then use <%nextlink%><\/strong> but if your API needs value in\u00a0encoded format e.g. A%20B rather than A+B then you have to use <%nextlink_encoded%><\/strong><\/p>\n Example URLs for Cursor:<\/strong><\/p>\n Below is few sample URLs in the log when pagination occurs via Cursor method. As you see the first URL has Cursor=* means its first call, after first request server may send next cursor in the response body (see example)<\/p>\n First URL: http:\/\/api.crossref.org\/members\/311\/works?filter=type:journal-article&rows=100&cursor=* Some API allows you to pass your PageSize and Page number inside Request Body (i.e. POST data) in that case you may configure your options like below (We used Google AdWords Api as an example)<\/p>\n Configure REST API Pagination \u2013 using Page Number via POST Body Method<\/p><\/div>\n REST API Pagination \u2013 Passing PageNumber inside POST Body (Example: Google AdWords SOAP API)<\/p><\/div>\n In the previous section, you saw how to pass page numbers via URL (Single Parameter: http:\/\/abc.com\/?page=1). However, sometimes you have a pagination requirement where you have to specify multiple parameters that need increment. See below example URL.<\/p>\n Pagination via Multiple URL Parameters<\/p><\/div>\n Another popular pagination method is paginate via Header. In this method, each API response includes special Header which indicates next link for your response. In header method there are two approaches. [1] Custom Method [2] RFC 5988 Method. Lets look at both.<\/p>\n In this method you have to specify which response header contains next URL. When no more NEXT url found in response reader stops.<\/p>\n Custom Header Pagination Method<\/p><\/div>\n In this method, HTTP response contains a\u00a0special header (Link) which contains next link for our response. If no link found to read more data then reader stops. This method is described well here in RFC 5988<\/a>. Check this GitHub API Example<\/a> to understand more on this pagination method.<\/p>\n Link Header Pagination Method (RFC 5988)<\/p><\/div>\n There will be a time when your API sends some sort of Continuation Token in Response Header and you have to use that token to call next request. Some API needs this token passed as query string in Next URL and in some API you have to pass as request header. We will cover both cases in the following section.<\/p>\n Your API might call these tokens as “Cursor” too so we will use these both terms in the following section (They both mean same thing).<\/p>\n There are few ways these APIs pass Cursor to the next request<\/p>\n Lets see all approaches.<\/p>\n Consider the API pagination use case in which you get some sort of continuation token in the response header and you take it and pass in the next request via request header (same header name).<\/p>\n Example:<\/p>\n First Request \/ Response:<\/strong><\/p>\n Second Request \/ Response:<\/strong><\/p>\n ……<\/p>\n ……<\/p>\n Last Request \/ Response:<\/strong><\/p>\n For above pagination pattern\u00a0 that just enter the response header name in Page Num Indicator<\/strong> field as below<\/p>\n Pagination using response header continuation token \u2013 Pass as Request Header<\/p><\/div>\n All possible formats for Page Num Indicator is below<\/p>\n x-page-token Consider the API pagination use case just like previous one but only different is request header name is not same as response header name. For example rather than x-token in request we need to call it x-next-token.<\/p>\n Example:<\/p>\n First Request \/ Response:<\/strong><\/p>\n Second Request \/ Response:<\/strong><\/p>\n ……<\/p>\n ……<\/p>\n Last Request \/ Response:<\/strong><\/p>\n For above pagination pattern\u00a0 that just enter the response header name in Page Num Indicator<\/strong> field as below<\/p>\n Pagination using response header continuation token \u2013 Pass as Request Header (Different name)<\/p><\/div>\n Some API like Azure Cosmos DB<\/a> uses Continuation Token via Header approach. In that case you can enter single header name or multiple headers like below (For multiple headers use comma)<\/p>\n REST API Pagination using Continuation Token via Header (Azure CosmosDB \/ DocumentDB API Example )<\/p><\/div>\n You can use use tools like Fiddler<\/a> to see paginated requests as below.<\/p>\n First Request<\/strong><\/p>\n View Paginated Requests in Fiddler (Azure CosmosDB API Example)<\/p><\/div>\n Second Request<\/strong><\/p>\n Pass Next Page Token via Header (View Paginated Requests in Fiddler \u2013 Azure CosmosDB API Example)<\/p><\/div>\n In the new version we added a feature where you can actually read Continuation Token (i.e. Cursor) from Response Header and then pass to next request in the URL rather than Request Header. Here is the example API<\/a> which uses such method.<\/p>\n First Request<\/strong><\/p>\n Second Request\u00a0<\/strong><\/p>\n Here is how to configure above pagination pattern<\/p>\n Pass Response Header value to URL (Cursor)<\/p><\/div>\n Now consider previous scenario but with slightly different requirement. By default previous pagination pattern stops when specified response header is missing or response header value is blank. However is some cases header value contains custom string to indicate last page. For example x-token: NULL. In such case we need to use Page Num Indicator<\/strong> like below (must use v4.2.3 or higher in SSIS PowerPack \/ 1.5.2 or higher in ODBC PowerPack)<\/p>\n For example to stop pagination in below case you have to enter Page Num Indicator as below. It says stop pagination when\u00a0 “NULL” word is detected<\/p>\n <\/p>\n First Request<\/strong><\/p>\n Second Request\u00a0<\/strong><\/p>\n ……<\/p>\n ……<\/p>\n Last Request\u00a0<\/strong><\/p>\n Here is how to configure above pagination pattern<\/p>\n Pass Response Header value to URL (Cursor)<\/p><\/div>\n In previous section (Method-4: Pass Page Number in Body Attribute ) we saw how to pass simple numeric page counter in Body. This is fine for some API but if your API has base64 style text token then counter based method doesn’t work. Also if you have requirement to hide page attribute node in first request and send page counter node in second request body (Changing Request Body Pattern for First vs Next)\u00a0 then check next two sections.<\/p>\n Next two sections covers two API Pagination patterns to fetch 100 rows (1000 in each page) . Both requires to send token in Body but second section is more complex need (Different Body Attributes in first vs next requests )<\/p>\n Lets look at simple pattern where first request has blank token in Body but all other requests until we find last page we keep sending non-empty token. This approach works as long as API Provider doesn’t mind having Blank Token in first request. If you get error then check next section to handle more complex way.<\/p>\n Here is the example of API which needs token in body<\/p>\n First API call<\/strong><\/p>\n Second API call<\/strong><\/p>\n ….. many more calls …<\/p>\n …. many more calls ….<\/p>\n Last API call (no more\u00a0nextToken in response so STOP pagination)<\/strong><\/p>\n So if you have such pattern then you can set few properties<\/p>\n For such issue you can use Changing few properties like below. Use Property Grid if you cant find on UI<\/p>\n Setting Body with [$pagetoken$] to implement dynamic pagination<\/p><\/div>\n Setting Page Placeholders in Advanced Pagination tab.<\/p><\/div>\n Now let’s look at more complex pattern. Here our first request body is different than other requests.<\/p>\n First API call<\/strong><\/p>\n Second API call<\/strong><\/p>\n ….. many more calls …<\/p>\n …. many more calls ….<\/p>\n Last API call (no more\u00a0nextToken)<\/strong><\/p>\n So notice few things<\/p>\n We have this article<\/a> and this article<\/a> which describes similar pattern.<\/p>\n Now lets look at how to solve both problems<\/p>\n For such issue you can use Changing few properties like below. Use Property Grid if you cant find on UI<\/p>\n So notice how we defined Body in two different properies as template. And in HttpRequestData we used [$tag$]<\/span><\/p>\n Sometimes you have use case where you want to Start Page Number from the last page loaded successfully. By default, you will see one additional column __FileName in the output. This column contains PageNumber \u00a0from URL for each row. You can save this into database so when next time you run your SSIS you can start at MAX(PageNumber) + 1.<\/p>\n Outputting PageNumber option is not visible by default so Use Property Grid and look for OutputFileName<\/strong> property (Default=true)<\/p>\n Every API may have different way of telling you that you reached last page or no more data found so you should stop looping. SSIS PowerPack comes with many options so you can implement desired logic for last page detection.<\/p>\n Following approaches supported by last page detection. Below options are not applicable if you are using Method#3 (Response contains Next Link \/ Cursor)<\/p>\n Now lets look at each setting. You should choose correct one based on your API behavior<\/p>\n If your API returns blank document or blank Array (if its JSON) then you can use this method to detect the last page. So when no content found in Response document it will stop pagination.<\/p>\n See below example of JSON API .. It shows sample first page and Sample last page (Assuming you entered Filter as $.Records[*] to extract data from Records array.<\/p>\n First Page<\/strong><\/p>\n Last Page<\/strong><\/p>\n SSIS API Pagination \u2013 Detect the last page by row count (Blank document or array)<\/p><\/div>\n Sometimes you get error with status code when the last page is reached (Most common is 404). So rather than failure, you can treat that status code as last page indicator using this option (see below).<\/p>\n SSIS API Pagination \u2013 Detect last page by response status code<\/p><\/div>\n If you cant use above two methods and want to detect the last page based on a certain error string in the response then use below approach.<\/p>\n SSIS API Pagination \u2013 Detect the last page by error\/response string search<\/p><\/div>\n Sometimes you can detect the last page by response size. For example, your response contains “–” only if no more data is found then you cannot use any of the above approaches and you have to detect based on response size (e.g. less than 3 bytes). See below<\/p>\n SSIS API Pagination \u2013 Detect last page by response size<\/p><\/div>\n There will be a time when you want to detect the last page based on some indicator value from your response. In that case, you can use the following settings to detect the last page.<\/p>\n If you don’t want to use Hardcoded value for stop indicator and want to use expression then see next section.<\/p>\n There will be a time when you want to detect the last page based on some indicator value from your response. In that case, you can use the following settings to detect the last page.<\/p>\n Here is an example from Zendesk API<\/a> (Stop pagination when count attribute from the response is less than 1000)<\/p>\nDebugging REST API Requests<\/h2>\n
Method-1: REST API\u00a0Pagination\u00a0via URL Parameter<\/h2>\n
\n
![\"Pagination](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-1-JSON-source-Pagination-URL-parameter-mode.png\")
<\/a>
\nhttp:\/\/myserver.com\/v1\/api\/getcustomers\/?offset=1<\/strong>&limit=1000
\nhttp:\/\/myserver.com\/v1\/api\/getcustomers\/?offset=1001<\/strong>&limit=1000
\nhttp:\/\/myserver.com\/v1\/api\/getcustomers\/?offset=2001<\/strong>&limit=1000<\/p>\nMethod-2: REST API\u00a0Pagination\u00a0via URL Path<\/h2>\n
\nhttp:\/\/myserver.com\/v1\/api\/getcustomers\/1\/<\/strong>
\nhttp:\/\/myserver.com\/v1\/api\/getcustomers\/2<\/strong>\/
\nhttp:\/\/myserver.com\/data\/file1<\/strong>.json
\nhttp:\/\/myserver.com\/data\/file2<\/strong>.json<\/p>\n\n
![\"Pagination](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-2-JSON-source-Pagination-URL-path-mode-Page-number-offset-passed-as-URL-path.png\")
<\/a>URL with Skip Parameter (Offset starts at zero)<\/h3>\n
http:\/\/mysite.com\/api\/getorders?skip=0&pagesize=100\r\nhttp:\/\/mysite.com\/api\/getorders?skip=100&pagesize=100\r\nhttp:\/\/mysite.com\/api\/getorders?skip=200&pagesize=100\r\nhttp:\/\/mysite.com\/api\/getorders?skip=300&pagesize=100\r\n....<\/pre>\n
![\"Pagination](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-2-Pagination-URL-with-Skip-Parameter.png\")
<\/a>Method-3 : REST API\u00a0Pagination\u00a0via Response Attribute (Next Link or Cursor)<\/h2>\n
\n
Next Link Method\u00a0(Partial or Full URL)<\/h3>\n
{ \r\n \"value\" : [....], \r\n \"odata.nextLink\" : \"http:\/\/abc.com\/customers\/2\/\" \r\n}<\/pre>\n![\"Method-3:](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-3-Pagination-via-Response-Attribute-Next-Link-or-Cursor.png\")
<\/a>Next Link – Detect the last page based on empty rows (Regular Expression)<\/h3>\n
{ \r\n \"value\" : [....], \r\n \"odata.nextLink\" : \"http:\/\/abc.com\/customers\/2\/\" \r\n}<\/pre>\n{ \r\n \"value\" : [], \r\n \"odata.nextLink\" : \"http:\/\/abc.com\/customers\/NNNN\/\" \r\n}<\/pre>\n\n
![\"Method-3](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-3-Pagination-Detect-the-last-page-based-on-empty-rows.png\")
<\/a>Cursor\u00a0Method<\/h3>\n
{ \r\n\u00a0 data: [....], \r\n\u00a0 nextCursor: \"Aooo\/MxxxxxxxxxxxtdA==\" \r\n}<\/pre>\n
\nSecond\u00a0URL: http:\/\/api.crossref.org\/members\/311\/works?filter=type:journal-article&rows=100&cursor=Aooo\/MxxxxxxxxxxxtdA==
\nThird\u00a0URL: http:\/\/api.crossref.org\/members\/311\/works?filter=type:journal-article&rows=100&cursor=Booo\/MxxxxxxxxxxxtdA==
\n…..
\n…..<\/p>\nMethod-4: Pass Page Number in Body Attribute<\/h2>\n
![\"Method-4](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-4-pagination.png\")
<\/a>![\"Method-4:](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-4-Settings.png\")
<\/a>Method-5: REST API\u00a0Pagination\u00a0via multiple URL parameters (e.g. Start and End)<\/h2>\n
http:\/\/abc.com\/?startRow=1&endRow=100\r\nhttp:\/\/abc.com\/?startRow=101&endRow=200\r\nhttp:\/\/abc.com\/?startRow=201&endRow=300\r\n...<\/pre>\n
![\"Method-5:](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-5-pagination.png\")
<\/a>Method-6: REST API\u00a0Pagination\u00a0via Header (Next Link in Header)<\/h2>\n
Next Link in Custom Header<\/h3>\n
![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-6-REST-API-Pagination-via-Header.png\")
<\/a>Next Link in Header as per RFC 5988<\/h3>\n
![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-6-Next-Link-in-Header-as-per-RFC-5988.png\")
<\/a>Method-7: REST API\u00a0Pagination using Cursor \/ Continuation Token from Response Header<\/h2>\n
\n
Pass Token via Request Header (Same header name)<\/h3>\n
------- Request ------\r\nGET https:\/\/abc.com\/api\/getdata\r\n\r\n------- Response ------\r\nx-token: Nxdfabcd11111\r\n\r\n{ some response data }<\/pre>\n------- Request ------\r\nGET https:\/\/abc.com\/api\/getdata\r\nx-token: Nxdfabcd11111\r\n\r\n------- Response ------\r\nx-token: Nxdfabcd22222\r\n\r\n{ some response data }<\/pre>\n------- Request ------\r\nGET https:\/\/abc.com\/api\/getdata\r\nx-token: Nxdfabcd22222\r\n\r\n------- Response ------\r\n\r\n{ some response data }<\/pre>\n![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-7-Pass-Token-via-Request-Header.png\")
<\/a>
\nx-token1, x-token2
\nRequestUrlQueryName=ResponseHeaderName
\nheader::RequestHeaderName=ResponseHeaderName
\nRequestUrlQueryName=ResponseHeaderName(regular-expression)<\/p>\nPass Token via Request Header (Different header name)<\/h3>\n
------- Request ------\r\nGET https:\/\/abc.com\/api\/getdata\r\n\r\n------- Response ------\r\nx-token: Nxdfabcd11111\r\n\r\n{ some response data }<\/pre>\n------- Request ------\r\nGET https:\/\/abc.com\/api\/getdata\r\nx-next-token: Nxdfabcd11111\r\n\r\n------- Response ------\r\nx-token: Nxdfabcd22222\r\n\r\n{ some response data }<\/pre>\n------- Request ------\r\nGET https:\/\/abc.com\/api\/getdata\r\nx-next-token: Nxdfabcd22222\r\n\r\n------- Response ------\r\n\r\n{ some response data }<\/pre>\n![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-6-Pass-Token-via-Request-Header.png\")
<\/a>Pass multiple Response Headers via Request Headers (Azure DocumentDB style usecase)<\/h3>\n
![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-7-Pass-multiple-Response-Headers-via-Request-Headers-Azure-DocumentDB-style-usecase.png\")
<\/a>![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-7-Fiddler-1.png\")
<\/a>![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-7-Fiddler-2.png\")
<\/a>Pass Token via URL Parameter (Query String)<\/h3>\n
--------- Request ---------\r\nGET\r\nhttp:\/\/test.com\/api\/getdata\r\n\r\n--------- Response ---------\r\nX-RESPONSE-TOKEN : Pg2xxxxxxxxxxxxxxxxx\r\n\r\n{ data : [ 1,2,3.... 10 ] }\r\n<\/pre>\n--------- Request ---------\r\nGET\r\nhttp:\/\/test.com\/api\/getdata?cursor=Pg2xxxxxxxxxxxxxxxxx\r\n\r\n--------- Response ---------\r\nX-RESPONSE-TOKEN : Pg3xxxxxxxxxxxxxxxxx\r\n\r\n{ data : [ 11,12,13.... 20 ] }<\/pre>\n![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-6-Pass-Token-via-URL-Parameter.png\")
<\/a>Pass Token via URL Parameter (Query String) – with\u00a0custom Regular expression (Usecase: Salesforce BULK query API)<\/h3>\n
nextUrlParameterName=responseHeadername(Some_Regular_Expression)<\/pre>\n
cursor=X-RESPONSE-TOKEN(^((?!NULL\\b).)*$)<\/pre>\n
--------- Request ---------\r\nGET\r\nhttp:\/\/test.com\/api\/getdata\r\n\r\n--------- Response ---------\r\nX-RESPONSE-TOKEN : Pg2xxxxxxxxxxxxxxxxx\r\n\r\n{ data : [ 1,2,3.... 10 ] }\r\n<\/pre>\n--------- Request ---------\r\nGET\r\nhttp:\/\/test.com\/api\/getdata?cursor=Pg2xxxxxxxxxxxxxxxxx\r\n\r\n--------- Response ---------\r\nX-RESPONSE-TOKEN : Pg3xxxxxxxxxxxxxxxxx\r\n\r\n{ data : [ 11,12,13.... 20 ] }<\/pre>\n--------- Request ---------\r\nGET\r\nhttp:\/\/test.com\/api\/getdata?cursor=Pg3xxxxxxxxxxxxxxxxx\r\n\r\n--------- Response ---------\r\nX-RESPONSE-TOKEN : NULL\r\n\r\n{ data : [ 21,22,23.... 30 ] }<\/pre>\n![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-7-with-custom-Regular-expression.png\")
<\/a>Method-8: Pass Pagination Token in Request Body<\/h2>\n
Passing Page Token in Body (Blank Token in first request allowed)<\/h3>\n
--------- Request ---------\r\nPOST http:\/\/test.com\/api\/getdata\r\n\r\n{ searchFor: \"Account\", continueToken:\"\" }\r\n\r\n--------- Response ---------\r\n{recordsFound: 5000, data: [\"Acct1\", \"Acct2\"..., \"Acct1000\"], nextToken:\"AxBxCx112233001==\" }<\/pre>\n--------- Request ---------\r\nPOST http:\/\/test.com\/api\/getdata\r\n\r\n{ searchFor: \"Account\", continueToken:\"AxBxCx112233001==\" }\r\n\r\n--------- Response ---------\r\n{data: [\"Acct1001\", \"Acct1002\"..., \"Acct2000\"], nextToken:\"AxBxCx112233002==\" }<\/pre>\n--------- Request ---------\r\nPOST http:\/\/test.com\/api\/getdata\r\n\r\n{ searchFor: \"Account\", continueToken:\"AxBxCx112233009==\" }\r\n\r\n--------- Response ---------\r\n{data: [\"Acct9001\", \"Acct9002\"..., \"Acct10000\"] }<\/pre>\n\n
![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-8-Pass-Passing-Page-Token-in-Body-1.png\")
<\/a>![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-8-Pass-Passing-Page-Token-in-Body-2.png\")
<\/a>Passing Page Token in Body (Blank Token in first request)<\/h3>\n
--------- Request ---------\r\nPOST http:\/\/test.com\/api\/getdata\r\n\r\n{ searchFor: \"Account\" }\r\n\r\n--------- Response ---------\r\n{recordsFound: 5000, data: [\"Acct1\", \"Acct2\"..., \"Acct1000\"], nextToken:\"AxBxCx112233001==\" }<\/pre>\n--------- Request ---------\r\nPOST http:\/\/test.com\/api\/getdataNext\r\n\r\n{ continueToken:\"AxBxCx112233001==\" }\r\n\r\n--------- Response ---------\r\n{data: [\"Acct1001\", \"Acct1002\"..., \"Acct2000\"], nextToken:\"AxBxCx112233002==\" }<\/pre>\n--------- Request ---------\r\nPOST http:\/\/test.com\/api\/getdataNext\r\n\r\n{ continueToken:\"AxBxCx112233009==\" }\r\n\r\n--------- Response ---------\r\n{data: [\"Acct9001\", \"Acct9002\"..., \"Acct10000\"] }<\/pre>\n\n
Passing PageToken or Counter in Next API Call Body<\/h3>\n
\n
Output Page Number as column<\/h2>\n
Last Page Detection<\/h2>\n
\n
Detect the last page by row count<\/h3>\n
{\u00a0\r\n\u00a0 Records : [ {...}, {...}, {...} .........\u00a0]\r\n}<\/pre>\n{\u00a0\r\n\u00a0 Records : [\u00a0\u00a0]\r\n}<\/pre>\n![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-8-Detect-the-last-page-by-row-count.png\")
<\/a>Detect the last page by response status code<\/h3>\n
![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-8-Detect-the-last-page-by-response-status-code.png\")
<\/a>Detect the last page by the error message<\/h3>\n
![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-8-Detect-the-last-page-by-the-error-message.png\")
<\/a>Detect the last page by response size<\/h3>\n
![\"Method](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/04\/Method-8-Detect-the-last-page-by-response-size-1.png\")
<\/a>Detect the last page based on the response attribute value<\/h3>\n
\n
Detect the last page based on regular expression pattern<\/h3>\n
\n