docs: add date section to version 1

This commit is contained in:
Stevan Freeborn
2023-04-22 15:38:44 -05:00
parent 5f65eb8248
commit 895df5e23f
4 changed files with 35 additions and 1 deletions
+3
View File
@@ -0,0 +1,3 @@
# Dates and Times {% #dates %}
Onspring stores date/time information in UTC (Coordinated Universal Time), and the API expects to pass UTC data back and forth. The Onspring GUI converts the UTC value to the appropriate display value depending on your instance configuration and a user's profile settings. This means that when you are working with dates and times via the API, you need to be expecting to send and receive dates in UTC.
+25
View File
@@ -0,0 +1,25 @@
# Retrieving and sending date field values
{% code heading="Date Field Value" defaultLanguage="json" %}
```json
{
"Type": 3,
"FieldId": 4800,
"Value": "2023-04-22T05:00:00Z"
}
```
{% /code %}
**Note:** The format of the date field value will be impacted based on the [data format](#data-format) sent in the request to retrieve it.
{% code heading="Value for Date Field" defaultLanguage="json" %}
```json
{
"4800": "2023-04-22T05:00:00Z"
}
```
{% /code %}
+6
View File
@@ -22,5 +22,11 @@ export const versionOne: DocsStructure = {
copy: 'copy.md', copy: 'copy.md',
example: 'example.md', example: 'example.md',
}, },
{
title: 'Dates',
folder: 'dates',
copy: 'copy.md',
example: 'example.md',
},
], ],
}; };
+1 -1
View File
@@ -12,7 +12,7 @@
{% /code %} {% /code %}
**Note:**: The format of the date field value will be impacted based on the [data format](#data-format) sent in the request to retrieve it. **Note:** The format of the date field value will be impacted based on the [data format](#data-format) sent in the request to retrieve it.
{% code heading="Value for Date Field" defaultLanguage="json" %} {% code heading="Value for Date Field" defaultLanguage="json" %}