Stevan/onspring-api-sdk-python
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
StevanFreeborn
2022-05-03 13:02:30 -05:00
parent 9554521985
commit d4f0db34ef
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -8
View File
@@ -145,7 +145,7 @@ for app in response.data.apps:
Returns an Onspring app or survey according to provided id. Returns an Onspring app or survey according to provided id.
```python ```python
response = client.GetAppById(195) response = client.GetAppById(appId=195)
print(f'Status Code: {response.statusCode}') print(f'Status Code: {response.statusCode}')
print(f'id: {response.data.app.id}') print(f'id: {response.data.app.id}')
@@ -158,7 +158,7 @@ print(f'href: {response.data.app.href}')
Returns a collection of Onspring apps and/or surveys according to provided ids. Returns a collection of Onspring apps and/or surveys according to provided ids.
```python ```python
response = client.GetAppsByIds([195, 240]) response = client.GetAppsByIds(appIds=[195, 240])
print(f'Status Code: {response.statusCode}') print(f'Status Code: {response.statusCode}')
print(f'Count: {response.data.count}') print(f'Count: {response.data.count}')
@@ -215,7 +215,7 @@ def PrintField(field: Field):
Returns an Onspring field according to provided id. Returns an Onspring field according to provided id.
```python ```python
response = client.GetFieldById(9686) response = client.GetFieldById(fieldId=9686)
print(f'Status Code: {response.statusCode}') print(f'Status Code: {response.statusCode}')
PrintField(response.data.field) PrintField(response.data.field)
@@ -226,7 +226,7 @@ PrintField(response.data.field)
Returns a collection of Onspring fields according to provided ids. Returns a collection of Onspring fields according to provided ids.
```python ```python
response = client.GetFieldsByIds([9686, 9687]) response = client.GetFieldsByIds(fieldIds=[9686, 9687])
print(f'Status Code: {response.statusCode}') print(f'Status Code: {response.statusCode}')
print(f'Count: {response.data.count}') print(f'Count: {response.data.count}')
@@ -240,7 +240,7 @@ for field in response.data.fields:
Returns a paged collection of fields that can be paged through. By default the page size is 50 and page number is 1. Returns a paged collection of fields that can be paged through. By default the page size is 50 and page number is 1.
```python ```python
response = client.GetFieldsByAppId(195) response = client.GetFieldsByAppId(appId=195)
print(f'Status Code: {response.statusCode}') print(f'Status Code: {response.statusCode}')
print(f'Page Size: {response.data.pageSize}') print(f'Page Size: {response.data.pageSize}')
@@ -257,7 +257,7 @@ You can set your own page size and page number (max is 1,000) as well.
```python ```python
pagingRequest = PagingRequest(1, 100) pagingRequest = PagingRequest(1, 100)
response = client.GetFieldsByAppId(195, pagingRequest) response = client.GetFieldsByAppId(appId=195, pagingRequest)
print(f'Status Code: {response.statusCode}') print(f'Status Code: {response.statusCode}')
print(f'Page Size: {response.data.pageSize}') print(f'Page Size: {response.data.pageSize}')
@@ -274,7 +274,7 @@ response = client.GetFieldsByAppId(195, pagingRequest)
#### Get File Info By Id #### Get File Info By Id
```python ```python
response = client.GetFileInfoById(1, 6990, 274) response = client.GetFileInfoById(recordId=1, fieldId=6990, fileId=274)
print(f'Status Code: {response.statusCode}') print(f'Status Code: {response.statusCode}')
print(f'Name: {response.data.fileInfo.name}') print(f'Name: {response.data.fileInfo.name}')
@@ -289,7 +289,7 @@ print(f'File Href: {response.data.fileInfo.fileHref}')
#### Get File By Id #### Get File By Id
```python ```python
response = client.GetFileById(1, 6990, 274) response = client.GetFileById(recordId=1, fieldId=6990, fileId=274)
print(f'Status Code: {response.statusCode}') print(f'Status Code: {response.statusCode}')
print(f'Name: {response.data.file.name}') print(f'Name: {response.data.file.name}')