From 5ed1c012fc5a7007ec67e3d071d7dea1a660fec9 Mon Sep 17 00:00:00 2001 From: StevanFreeborn Date: Tue, 3 May 2022 11:54:23 -0500 Subject: [PATCH] update README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 4857e4d..9f14a8c 100644 --- a/README.md +++ b/README.md @@ -223,6 +223,8 @@ PrintField(response.data.field) #### Get Fields By Ids +Returns a collection of Onspring fields according to provided ids. + ```python response = client.GetFieldsByIds([9686, 9687]) @@ -235,7 +237,36 @@ for field in response.data.fields: #### Get Fields By App Id +Returns a paged collection of fields that can be paged through. By default the page size is 50 and page number is 1. + ```python +response = client.GetFieldsByAppId(195) + + print(f'Status Code: {response.statusCode}') + print(f'Page Size: {response.data.pageSize}') + print(f'Page Number: {response.data.pageNumber}') + print(f'Total Pages: {response.data.totalPages}') + print(f'Total Records: {response.data.totalRecords}') + + for field in response.data.fields: + PrintField(field) +``` + +You can set your own page size and page number (max is 1,000) as well. + +```python +pagingRequest = PagingRequest(1, 100) + +response = client.GetFieldsByAppId(195, pagingRequest) + + print(f'Status Code: {response.statusCode}') + print(f'Page Size: {response.data.pageSize}') + print(f'Page Number: {response.data.pageNumber}') + print(f'Total Pages: {response.data.totalPages}') + print(f'Total Records: {response.data.totalRecords}') + + for field in response.data.fields: + PrintField(field) ``` ### Files