Paging
Some Geo Services functions support paging. Different versions of the service have different requirements. Generally, if the function supports paging, it will return two paramenters: Cursor and TotalCount.
To get the next page of results, the value of Cursor should be copied from the response and inserted into the next request. If the response contains no Cursor, the end of results is reached.
REST interface also supports paging using query string parameters: pageNumber and pageSize. These parameters override Cursor and TotalCount, but can be used in conjunction.
Page size is determined by your subscription. Currently, the paid subscriptions default to 1000 records per page, free subscriptions return 100 records per page.
Parameters:
CURSOR - Identifies the next page of dataTOTALCOUNT- Total number of records on all pages
REQUEST- Function specific request data
PAGE_NUMBER - next page number
PAGE_SIZE - page size
Examples:
GET http://api.geosvc.com/rest/{REQUEST}&pageNumber={PAGE_NUMBER}&pageSize={PAGE_SIZE} HTTP/1.1 X-Cursor: {CURSOR} Accept: application/xml Host: api.geosvc.comResponse:
HTTP/1.1 200 OK Content-Length: Content-Type: X-Cursor: {CURSOR} X-TotalCount: {TOTALCOUNT}
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:geos="http://geoservice/"> <soapenv:Header> <geos:Cursor>{CURSOR}</geos:Cursor> </soapenv:Header> <soapenv:Body> {REQUEST} </soapenv:Body> </soapenv:Envelope>Response:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <geos:Cursor>{CURSOR}</geos:Cursor> <geos:TotalCount>{TOTALCOUNT}</geos:TotalCount> </soapenv:Header> <s:Body> </s:Body> </s:Envelope>
<soapenv:Envelope xmlns:ser="http://skats.net/services/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://skats.net/services/"> <soapenv:Header> <ser:Pager id="h_id1"> <Cursor xsi:type="xsd:string">{Cursor}</Cursor> </ser:Pager> </soapenv:Header> <soapenv:Body> {REQUEST} </soapenv:Body> </soapenv:Envelope>Response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://skats.net/services/" xmlns:types="http://skats.net/services/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <soapenv:Header> <ser:Pager id="h_id1"> <Cursor xsi:type="xsd:string">{Cursor}</Cursor> <TotalCount xsi:type="xsd:string">{TOTALCOUNT}</TotalCount> </ser:Pager> </soapenv:Header> </soap:Body> </soapenv:Body> </soap:Envelope>