{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Time Field","type":"basic","slug":"time-field","excerpt":"","body":"The Time Field stores a time value withing the property, 'value'.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"Start Time\\\": {\\n    \\\"displayValue\\\": \\\"8:05 AM\\\",\\n    \\\"value\\\": \\\"0000-01-01T12:34:20Z\\\",\\n    \\\"id\\\": \\\"28b3af03-6ae2-4a1c-9b01-a46c0108d3c5\\\",\\n    \\\"name\\\": \\\"Start Time_0\\\",\\n    \\\"type\\\": \\\"Time\\\"\\n   } \\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"NOTE:\",\n  \"body\": \"The id, name, and type are not necessary when creating or updating a form, they are returned in the `JSON` of a request for readability.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Value\"\n}\n[/block]\nThe `value` property of the Date Field expects the date in the [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format and more specifically in [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time).  \n\nThe expected format takes the following form, YYYY-MM-DDThh:mm:ssZ, where:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Format\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"YYYY\",\n    \"1-0\": \"MM\",\n    \"2-0\": \"DD\",\n    \"3-0\": \"hh\",\n    \"4-0\": \"mm\",\n    \"5-0\": \"ss\",\n    \"0-1\": \"A four-digit year, 0000 through 9999.\",\n    \"1-1\": \"A two-digit month of the year, 01 through 12.\",\n    \"2-1\": \"A two-digit day of that month, 01 through 31.\",\n    \"3-1\": \"Zero-padded hour between 00 and 23\",\n    \"4-1\": \"A zero-padded minute between 00 and 59\",\n    \"5-1\": \"A zero-padded second between 00 and 60 (where 60 is only used to denote an added leap second).\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\nThe Time Field is only concerned with storing time values.  To that end, in order to save times in the ISO 8601 format, set the YYYY-MM-DD of the format to 0000:01:01.\n\nAs an example, to set a TimeField to 1:30pm the following format would be used:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"value\\\": \\\"0000:01:01T13:30:00Z\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Display Value\"\n}\n[/block]\nThe `displayValue` property of a Time Field is read-only.  This means any change to this property will not be persisted after initially setting or updating a Time Field.  \n\nThe `displayValue` property presents the `value` property as a formatted `string` which is defined by the template rules.","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5536e78220d5ca0d0001580f","__v":3,"createdAt":"2015-04-22T00:12:50.204Z","githubsync":"","user":"55356ede6040a20d00454508","project":"55357364e02d480d0003c6d3","category":{"sync":{"isSync":false,"url":""},"pages":["5536e6ed9f7f2d0d00b1cd56","5536e736bbb4a70d00a53534","5536e73f9f7f2d0d00b1cd59","5536e74dbbb4a70d00a53536","5536e7569f7f2d0d00b1cd5b","5536e7609f7f2d0d00b1cd5d","5536e76b20d5ca0d0001580d","5536e78220d5ca0d0001580f","5536e797b91d030d004c3d91","5536e7a120d5ca0d00015811","5536e7b320d5ca0d00015813","5536e7bbbbb4a70d00a5353a","5536e7c99f7f2d0d00b1cd60","5536e7d29030530d0007f860","5536e7dbbbb4a70d00a5353c","5536e7e69f7f2d0d00b1cd62","5571ef581cd8283500a8b4de","55b80d6be89bbf25009f045b"],"title":"Form Fields","slug":"form-fields","order":9,"from_sync":false,"reference":false,"_id":"5536e6bf7fe60f0d000fd1c0","__v":18,"createdAt":"2015-04-22T00:09:35.017Z","project":"55357364e02d480d0003c6d3","version":"553591cd63cc650d00312925"},"version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","releaseDate":"2015-04-20T23:54:53.134Z","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z"},"parentDoc":null}

API

Formz

Templates

Groups

Users

Files

Queue

Data Sources

Form Fields

Webhooks

Time Field

The Time Field stores a time value withing the property, 'value'. [block:code] { "codes": [ { "code": "{\n\t\"Start Time\": {\n \"displayValue\": \"8:05 AM\",\n \"value\": \"0000-01-01T12:34:20Z\",\n \"id\": \"28b3af03-6ae2-4a1c-9b01-a46c0108d3c5\",\n \"name\": \"Start Time_0\",\n \"type\": \"Time\"\n } \n}", "language": "json" } ] } [/block] [block:callout] { "type": "info", "title": "NOTE:", "body": "The id, name, and type are not necessary when creating or updating a form, they are returned in the `JSON` of a request for readability." } [/block] [block:api-header] { "type": "basic", "title": "Value" } [/block] The `value` property of the Date Field expects the date in the [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format and more specifically in [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time). The expected format takes the following form, YYYY-MM-DDThh:mm:ssZ, where: [block:parameters] { "data": { "h-0": "Format", "h-1": "Description", "0-0": "YYYY", "1-0": "MM", "2-0": "DD", "3-0": "hh", "4-0": "mm", "5-0": "ss", "0-1": "A four-digit year, 0000 through 9999.", "1-1": "A two-digit month of the year, 01 through 12.", "2-1": "A two-digit day of that month, 01 through 31.", "3-1": "Zero-padded hour between 00 and 23", "4-1": "A zero-padded minute between 00 and 59", "5-1": "A zero-padded second between 00 and 60 (where 60 is only used to denote an added leap second)." }, "cols": 2, "rows": 6 } [/block] The Time Field is only concerned with storing time values. To that end, in order to save times in the ISO 8601 format, set the YYYY-MM-DD of the format to 0000:01:01. As an example, to set a TimeField to 1:30pm the following format would be used: [block:code] { "codes": [ { "code": "{\n\t\"value\": \"0000:01:01T13:30:00Z\"\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Display Value" } [/block] The `displayValue` property of a Time Field is read-only. This means any change to this property will not be persisted after initially setting or updating a Time Field. The `displayValue` property presents the `value` property as a formatted `string` which is defined by the template rules.