{"_id":"56c41911c4796b0d007ef03c","category":{"_id":"56c418162d97560d00e23cf6","__v":3,"pages":["56c41905c39ff40d00d25f98","56c41911c4796b0d007ef03c","56c4191cbb64720d00552b89"],"project":"56bc8e679afb8b0d00d62dcf","version":"56bc8e689afb8b0d00d62dd2","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-17T06:49:58.871Z","from_sync":false,"order":0,"slug":"device-information","title":"Device Information"},"user":"56b98db7bb36440d0001f492","version":{"_id":"56bc8e689afb8b0d00d62dd2","project":"56bc8e679afb8b0d00d62dcf","__v":18,"createdAt":"2016-02-11T13:36:40.146Z","releaseDate":"2016-02-11T13:36:40.146Z","categories":["56bc8e689afb8b0d00d62dd3","56c3c837bc41330d009f25ed","56c3c83e521f350d00d348eb","56c3c8452d97560d00e23cd8","56c3c85234df460d00c2beb8","56c4180d70187b17005f43b4","56c418162d97560d00e23cf6","56c4181cc4796b0d007ef039","56c4182370187b17005f43b5","56c418292e75e01700986052","56c4183328bd680d005e7ac6","56c4183bbb64720d00552b88","56c418414040602b0064cea0","56c4184754b6030d00ec29a1","56c4184c28bd680d005e7ac7","56c4185370187b17005f43b6","56c4185b6063071700500cfc","582a98b6f8c0a0190053d7a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":3,"parentDoc":null,"project":"56bc8e679afb8b0d00d62dcf","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T06:54:09.635Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"type\": \"patch\",\n  \"title\": \"/devices/current\"\n}\n[/block]\nUpdates device status information, such as location, network connection type, or push notification token.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var options = {\\n\\tlocation: \\\"47.1, -121.292\\\",\\n\\tpushToken: \\\"my-SP3C14L-puSH-t0k3n\\\",\\n\\tconnectionType: \\\"WiFi\\\",\\n\\ttag: \\\"Some useful tag\\\",\\n\\tappVersion: \\\"1.11\\\",\\n\\tosVersion: \\\"10\\\"\\n};\\n\\nBuddy.patch('/devices/current',\\n\\t\\toptions,\\n\\t\\tfunction(err, result) {\\n\\t\\t\\t \\n\\t\\t\\tif (result.success) {\\n\\t\\t\\t\\t// Do something with the result!\\n\\t\\t\\t} else { \\n\\t\\t\\t\\t// Otherwise log the error\\n\\t\\t\\t\\tconsole.log(err); \\n\\t\\t\\t} \\n\\t\\t}\\n\\t);\",\n      \"language\": \"javascript\"\n    },\n    {\n      \"code\": \"NSDictionary *params = :::at:::{\\n\\t\\t\\[email protected]\\\"location\\\": BPCoordinateMake(47.1, -121.292),\\n\\t\\t\\[email protected]\\\"pushToken\\\": @\\\"my-SP3C14L-puSH-t0k3n\\\",\\n\\t\\t\\[email protected]\\\"connectionType\\\": @\\\"WiFi\\\",\\n\\t\\t\\[email protected]\\\"tag\\\": @\\\"Some useful tag\\\",\\n\\t\\t\\[email protected]\\\"appVersion\\\": @\\\"1.11\\\",\\n\\t\\t\\[email protected]\\\"osVersion\\\": @\\\"10\\\"\\n\\t\\t};\\n\\n[Buddy PATCH:@\\\"/devices/current\\\" parameters:params class:[NSDictionary class] callback:^(id obj, NSError *error) {\\n\\t// Your callback code here\\n}];\",\n      \"language\": \"objectivec\",\n      \"name\": \"iOS\"\n    },\n    {\n      \"code\": \"Map<String, Object> parameters = new HashMap<String, Object>();\\nparameters.put(\\\"location\\\", myLocation);\\nparameters.put(\\\"pushToken\\\", \\\"my-SP3C14L-puSH-t0k3n\\\");\\nparameters.put(\\\"connectionType\\\", \\\"WiFi\\\");\\nparameters.put(\\\"tag\\\", \\\"Some useful tag\\\");\\nparameters.put(\\\"appVersion\\\", \\\"1.11\\\");\\nparameters.put(\\\"osVersion\\\", \\\"10\\\");\\n\\nBuddy.<JsonObject>patch(\\\"/devices/current\\\", parameters, new BuddyCallback<JsonObject>(JsonObject.class) {\\n\\[email protected]\\n\\tpublic void completed(BuddyResult<JsonObject> result) {\\n\\t\\t// Your callback code here\\n\\t}\\n});\",\n      \"language\": \"java\",\n      \"name\": \"Android\"\n    },\n    {\n      \"code\": \"var options = new {\\n\\t\\t\\tlocation = new BuddyGeoLocation(47.1, -122.3),\\n\\t\\t\\tpushToken = \\\"my-SP3C14L-puSH-t0k3n\\\",\\n\\t\\t\\tconnectionType = \\\"WiFi\\\",\\n\\t\\t\\ttag = \\\"Some useful tag\\\",\\n\\t\\t\\tappVersion = \\\"1.11\\\",\\n\\t\\t\\tosVersion = \\\"10\\\"\\n\\t\\t};\\n\\nvar result = await Buddy.PatchAsync<IDictionary<string,object>>(\\\"/devices/current\\\", options);\",\n      \"language\": \"csharp\",\n      \"name\": \".NET\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Body Parameters\n\nThese parameters should be specified as part of the request body.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"location\",\n    \"0-1\": \"The latitude and longitude of the device.\",\n    \"1-0\": \"pushToken\",\n    \"1-1\": \"A platform-specific token used for push notifications on this device.\",\n    \"2-0\": \"connectionType\",\n    \"3-0\": \"tag\",\n    \"4-0\": \"appVersion\",\n    \"5-0\": \"osVersion\",\n    \"2-1\": \"Valid values are: \\\"Unknown\\\", \\\"Carrier\\\", and \\\"Wifi\\\".\",\n    \"3-1\": \"A string value to attach to this object. This value will be returned with the object as a property called `tag`.\",\n    \"4-1\": \"The version of the app installed on this device.\",\n    \"5-1\": \"The version of the OS installed on this device.\",\n    \"0-2\": \"string\",\n    \"1-2\": \"string\",\n    \"2-2\": \"string\",\n    \"3-2\": \"string\",\n    \"4-2\": \"string\",\n    \"5-2\": \"string\",\n    \"0-3\": \"Optional\",\n    \"1-3\": \"Optional\",\n    \"2-3\": \"Optional\",\n    \"3-3\": \"Optional\",\n    \"4-3\": \"Optional\",\n    \"5-3\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"status\\\": 200,\\n    \\\"request_id\\\": \\\"e0175818-89c4-4fc5-bb99-e8ae7f5ef10a\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"update-device","type":"basic","title":"Update Device"}
[block:api-header] { "type": "patch", "title": "/devices/current" } [/block] Updates device status information, such as location, network connection type, or push notification token. [block:code] { "codes": [ { "code": "var options = {\n\tlocation: \"47.1, -121.292\",\n\tpushToken: \"my-SP3C14L-puSH-t0k3n\",\n\tconnectionType: \"WiFi\",\n\ttag: \"Some useful tag\",\n\tappVersion: \"1.11\",\n\tosVersion: \"10\"\n};\n\nBuddy.patch('/devices/current',\n\t\toptions,\n\t\tfunction(err, result) {\n\t\t\t \n\t\t\tif (result.success) {\n\t\t\t\t// Do something with the result!\n\t\t\t} else { \n\t\t\t\t// Otherwise log the error\n\t\t\t\tconsole.log(err); \n\t\t\t} \n\t\t}\n\t);", "language": "javascript" }, { "code": "NSDictionary *params = @{\n\t\t\[email protected]\"location\": BPCoordinateMake(47.1, -121.292),\n\t\t\[email protected]\"pushToken\": @\"my-SP3C14L-puSH-t0k3n\",\n\t\t\[email protected]\"connectionType\": @\"WiFi\",\n\t\t\[email protected]\"tag\": @\"Some useful tag\",\n\t\t\[email protected]\"appVersion\": @\"1.11\",\n\t\t\[email protected]\"osVersion\": @\"10\"\n\t\t};\n\n[Buddy PATCH:@\"/devices/current\" parameters:params class:[NSDictionary class] callback:^(id obj, NSError *error) {\n\t// Your callback code here\n}];", "language": "objectivec", "name": "iOS" }, { "code": "Map<String, Object> parameters = new HashMap<String, Object>();\nparameters.put(\"location\", myLocation);\nparameters.put(\"pushToken\", \"my-SP3C14L-puSH-t0k3n\");\nparameters.put(\"connectionType\", \"WiFi\");\nparameters.put(\"tag\", \"Some useful tag\");\nparameters.put(\"appVersion\", \"1.11\");\nparameters.put(\"osVersion\", \"10\");\n\nBuddy.<JsonObject>patch(\"/devices/current\", parameters, new BuddyCallback<JsonObject>(JsonObject.class) {\n\[email protected]erride\n\tpublic void completed(BuddyResult<JsonObject> result) {\n\t\t// Your callback code here\n\t}\n});", "language": "java", "name": "Android" }, { "code": "var options = new {\n\t\t\tlocation = new BuddyGeoLocation(47.1, -122.3),\n\t\t\tpushToken = \"my-SP3C14L-puSH-t0k3n\",\n\t\t\tconnectionType = \"WiFi\",\n\t\t\ttag = \"Some useful tag\",\n\t\t\tappVersion = \"1.11\",\n\t\t\tosVersion = \"10\"\n\t\t};\n\nvar result = await Buddy.PatchAsync<IDictionary<string,object>>(\"/devices/current\", options);", "language": "csharp", "name": ".NET" } ], "sidebar": true } [/block] ###Body Parameters These parameters should be specified as part of the request body. [block:parameters] { "data": { "0-0": "location", "0-1": "The latitude and longitude of the device.", "1-0": "pushToken", "1-1": "A platform-specific token used for push notifications on this device.", "2-0": "connectionType", "3-0": "tag", "4-0": "appVersion", "5-0": "osVersion", "2-1": "Valid values are: \"Unknown\", \"Carrier\", and \"Wifi\".", "3-1": "A string value to attach to this object. This value will be returned with the object as a property called `tag`.", "4-1": "The version of the app installed on this device.", "5-1": "The version of the OS installed on this device.", "0-2": "string", "1-2": "string", "2-2": "string", "3-2": "string", "4-2": "string", "5-2": "string", "0-3": "Optional", "1-3": "Optional", "2-3": "Optional", "3-3": "Optional", "4-3": "Optional", "5-3": "Optional" }, "cols": 4, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"request_id\": \"e0175818-89c4-4fc5-bb99-e8ae7f5ef10a\"\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]