From 671c66afa366879efa1f00ea264dd3b1c8cf4a89 Mon Sep 17 00:00:00 2001
From: StevanFreeborn <sfreeborn7@gmail.com>
Date: Tue, 3 May 2022 15:14:11 -0500
Subject: [PATCH] update README.md

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/README.md b/README.md
index 078bd26..b08af2b 100644
--- a/README.md
+++ b/README.md
@@ -512,7 +512,53 @@ print(f'Message: {response.message}')
 
 #### Get Records By Ids
 
+Returns a collection of Onspring records based on the provided appId and recordIds.
+
 ```python
+from Models import GetBatchRecordsRequest
+
+request = GetBatchRecordsRequest(appId=195, recordIds=[1, 2, 3])
+
+response = client.GetRecordsByIds(request)
+
+print(f'Status Code: {response.statusCode}')
+print(f'Count: {response.data.count}')
+
+for record in response.data.records:
+    print(f'AppId: {record.appId}')
+    print(f'RecordId: {record.recordId}')
+
+    for field in record.fields:
+        print(f'Type: {field.type}')
+        print(f'FieldId: {field.fieldId}')
+        print(f'Value: {field.GetResultValueString()}')
+```
+
+You can also specify what field values to return and in what format (Raw vs. Formatted) to return them.
+
+```python
+from Models import GetBatchRecordsRequest
+from Enums import DataFormat
+
+request = GetBatchRecordsRequest(
+    appId=195, 
+    recordIds=[1, 2, 3],
+    fieldIds=[9686],
+    dataFormat=DataFormat.Formatted.name)
+
+response = client.GetRecordsByIds(request)
+
+print(f'Status Code: {response.statusCode}')
+print(f'Count: {response.data.count}')
+
+for record in response.data.records:
+    print(f'AppId: {record.appId}')
+    print(f'RecordId: {record.recordId}')
+
+    for field in record.fields:
+        print(f'Type: {field.type}')
+        print(f'FieldId: {field.fieldId}')
+        print(f'Value: {field.GetResultValueString()}')
 ```
 
 #### Query Records