\nthe current page to be returned<\/li>\n
\nnumber of rows to return. this cannot be greater than the maximum page size defined on the controller or route<\/li>\n<\/ul>\n
ad last but not least the return data will include a X-Pagination http header containing the information on the page returned.<\/p>\n
The X-Pagination header contains a json object with the following fields<\/p>\n
- \n
- PageSize<\/li>\n
- CurrentPage<\/li>\n
- TotalCount (not with embedded db)<\/li>\n
- TotalPages\u00a0(not with embedded db)<\/li>\n<\/ul>\n
the X-Pagination header can be used by the calling program.<\/p>\n
In addition to paging we want to be able to sort the orders by different sort orders. We need to declare these so we can allow the client to set the sort order<\/p>\n
lets add the following to our route delcaration<\/p>\n
Send AddPathOrder \"orderNumber\" 1 True \n\nSend AddPathOrder \"orderDate\" 3 True\nSend AddPathOrder \"Customer\" 2 False\nSet psPathDefaultOrder to \"orderNumber\"\n<\/pre>\n
this will declare 3 different sort orders, by order number, order date as well as customer. The first two allow descending orders as well.<\/p>\n
And last we set the default sort order to order number.<\/p>\n
this now enables the client to send two additional query parameters<\/p>\n
- \n
- order<\/li>\n
- desc<\/li>\n<\/ul>\n
for example<\/p>\n
\/api\/v1\/order?order=orderDate&desc=true<\/strong><\/p>\n
or with paging<\/p>\n
\/api\/v1\/order?order=orderDate&desc=true&page=10<\/strong><\/p>\n
Of course we also need to be able to select orders for example by date. Lets add some functionality to do just that.<\/p>\n
First we modify the orderheader datadictionary to add the constraint logic<\/p>\n
Object oOrderHeader_DD is a cOrderHeaderDataDictionary\n Set DDO_Server to oSalesPerson_DD\n Set DDO_Server to oCustomer_DD\n\n Property Date pdDateFrom \"\"\n Property Date pdDateTo \"\"\n\n Procedure OnConstrain \n If (pdDateFrom(Self)<>\"\") Constrain OrderHeader.Order_Date ge (pdDateFrom(Self))\n If (pdDateTo(Self)<>\"\") Constrain OrderHeader.Order_Date le (pdDateTo(Self))\n End_Procedure\n\n Procedure ClearConstraints\n Set pdDateFrom to \"\"\n Set pdDateTo to \"\"\n Send Rebuild_Constraints\n End_Procedure\nEnd_Object<\/pre>\n
now we add a new method for our order API<\/p>\n
Procedure WebAPI_GetOrders\n Date dFrom dTo\n Get UrlParameter \"dateFrom\" to dFrom\n Get UrlParameter \"dateTo\" to dTo\n\n Set pdDateFrom of oOrderHeader_DD to dFrom\n Set pdDateTo of oOrderHeader_DD to dTo\n Send Rebuild_Constraints to oOrderHeader_DD\n\n \/\/ call original get API\n Send webAPI_Get\n\n Send ClearConstraints to oOrderHeader_DD\nEnd_Procedure<\/pre>\n
this new method gets the url parameters ‘dateFrom’ and ‘dateTo’ and uses these values to initialize the DDs constraints<\/p>\n
then we simply call the original GET API to get the data and then clear the constraints<\/p>\n
we need to modify the route declaration to call this new method<\/p>\n
Send RegisterPath \"GET\" \"\" (RefProc(WebAPI_GetOrders))<\/pre>\n
this will now allow the user of the API to specify the dateFrom and dateTo parameters to constrain the orders returned.<\/p>\n
Of course all these changes are also made to the OpenAPI documentation as well<\/p>\n
Now as a last feature lets see how we can use a second schema in the same API to return the same dataset with a different schema<\/p>\n
All we need to do is to declare a new route as follows<\/p>\n
Send RegisterPath \"GET\" \"\/orderlist\" (RefProc(webAPI_Get)) \"orderlist\"<\/pre>\n
as you can see in this route we are calling the same WebAPI_GET method but we are\u00a0 specifying a different schema called “orderlist”.<\/p>\n
this will return the same dataset but with a much smaller number of fields.<\/p>\n
In the following posts in this series we will look into detailed features such as authentication and more.<\/p>\n
<\/p>\n
[\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row _builder_version=”3.26.7″][et_pb_column type=”4_4″ _builder_version=”3.26.7″][et_pb_text _builder_version=”3.26.7″]\n\t\t
\n\t\t\t\n\t\t\t\t\n\t\t\t
\n\t\t\t