{"_id":"5536e7609f7f2d0d00b1cd5d","category":{"_id":"5536e6bf7fe60f0d000fd1c0","__v":18,"pages":["5536e6ed9f7f2d0d00b1cd56","5536e736bbb4a70d00a53534","5536e73f9f7f2d0d00b1cd59","5536e74dbbb4a70d00a53536","5536e7569f7f2d0d00b1cd5b","5536e7609f7f2d0d00b1cd5d","5536e76b20d5ca0d0001580d","5536e78220d5ca0d0001580f","5536e797b91d030d004c3d91","5536e7a120d5ca0d00015811","5536e7b320d5ca0d00015813","5536e7bbbbb4a70d00a5353a","5536e7c99f7f2d0d00b1cd60","5536e7d29030530d0007f860","5536e7dbbbb4a70d00a5353c","5536e7e69f7f2d0d00b1cd62","5571ef581cd8283500a8b4de","55b80d6be89bbf25009f045b"],"project":"55357364e02d480d0003c6d3","version":"553591cd63cc650d00312925","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-22T00:09:35.017Z","from_sync":false,"order":9,"slug":"form-fields","title":"Form Fields"},"user":"55356ede6040a20d00454508","__v":3,"project":"55357364e02d480d0003c6d3","version":{"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z","releaseDate":"2015-04-20T23:54:53.134Z","categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-22T00:12:16.192Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"The Gps Field is responsible for storing a geographic image with coordinates.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"Job Site Location\\\": {\\n\\n      \\\"location\\\": {\\n        \\\"latitude\\\": 32.7159063,\\n        \\\"longitude\\\": -117.1685657,\\n        \\\"accuracy\\\": null\\n      },\\n      \\\"mapImage\\\": {\\n        \\\"id\\\": \\\"68d32c9b-d87c-44af-957d-b6b4477791b8\\\",\\n        \\\"link\\\": \\\"https://api.goformz.com/v2/files/68d32c9b-d87c-44af-957d-b6b4477791b8\\\"\\n      },\\n      \\\"id\\\": \\\"05bff11f-0674-438e-964f-a46c0108d3ca\\\",\\n      \\\"name\\\": \\\"Location\\\",\\n      \\\"type\\\": \\\"Gps\\\"\\n    }\\n \\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The id, name, and type are not necessary when setting or updating the Sketch Field. These properties are returned in the JSON of the request for readability.\",\n  \"title\": \"NOTE:\"\n}\n[/block]\nThe `mapImage` property is a `File` property type and each has the following properties:\n\n- `id` - The `id` of an image uploaded to the `Files` endpoint.\n- `link` - A downloadable `link` to that image's location in storage.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"NOTE:\",\n  \"body\": \"The `link` property is read-only and will not be persisted if it is updated.\"\n}\n[/block]\nThe `mapImage` file requires uploading a `File` first and then assigning that uploaded file's `id` to the `mapImage > id` property.  For more details see the section: \"[Uploading a file](doc:uploading-a-file)\".\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Location\"\n}\n[/block]\nIn addition to the `mapImage` property, the Gps Field also contains a `location` property which can be set to capture the geographic coordinates associated with the `mapImage`.\n\nThe `location` property has three properties:\n1. `latitude` - The latitudinal position of a geographic coordinate.\n2. `longitude` - The longitudinal position of a geographic coordinate.\n3. `accuracy` - The accuracy of the captured geographic coordinate.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The `accuracy` property of a `location` is optional.\",\n  \"title\": \"NOTE:\"\n}\n[/block]\nThe following `JSON` snippet shows how to set the location:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"location\\\": {\\n  \\\"latitude\\\": 32.715410, \\n  \\\"longitude\\\": -117.168705,\\n  // accuracy omitted since it's not required...\\n }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"gps-field","type":"basic","title":"Gps Field"}
The Gps Field is responsible for storing a geographic image with coordinates. [block:code] { "codes": [ { "code": "{\n \"Job Site Location\": {\n\n \"location\": {\n \"latitude\": 32.7159063,\n \"longitude\": -117.1685657,\n \"accuracy\": null\n },\n \"mapImage\": {\n \"id\": \"68d32c9b-d87c-44af-957d-b6b4477791b8\",\n \"link\": \"https://api.goformz.com/v2/files/68d32c9b-d87c-44af-957d-b6b4477791b8\"\n },\n \"id\": \"05bff11f-0674-438e-964f-a46c0108d3ca\",\n \"name\": \"Location\",\n \"type\": \"Gps\"\n }\n \n}", "language": "json" } ] } [/block] [block:callout] { "type": "info", "body": "The id, name, and type are not necessary when setting or updating the Sketch Field. These properties are returned in the JSON of the request for readability.", "title": "NOTE:" } [/block] The `mapImage` property is a `File` property type and each has the following properties: - `id` - The `id` of an image uploaded to the `Files` endpoint. - `link` - A downloadable `link` to that image's location in storage. [block:callout] { "type": "info", "title": "NOTE:", "body": "The `link` property is read-only and will not be persisted if it is updated." } [/block] The `mapImage` file requires uploading a `File` first and then assigning that uploaded file's `id` to the `mapImage > id` property. For more details see the section: "[Uploading a file](doc:uploading-a-file)". [block:api-header] { "type": "basic", "title": "Location" } [/block] In addition to the `mapImage` property, the Gps Field also contains a `location` property which can be set to capture the geographic coordinates associated with the `mapImage`. The `location` property has three properties: 1. `latitude` - The latitudinal position of a geographic coordinate. 2. `longitude` - The longitudinal position of a geographic coordinate. 3. `accuracy` - The accuracy of the captured geographic coordinate. [block:callout] { "type": "info", "body": "The `accuracy` property of a `location` is optional.", "title": "NOTE:" } [/block] The following `JSON` snippet shows how to set the location: [block:code] { "codes": [ { "code": "{\n \"location\": {\n \"latitude\": 32.715410, \n \"longitude\": -117.168705,\n // accuracy omitted since it's not required...\n }\n}", "language": "json" } ] } [/block]