{"__v":3,"_id":"561da674e078f40d00eadd75","category":{"__v":20,"_id":"55e67b5dde6fef23009480ca","pages":["55ed06c7023a81170018f163","55ed079b0d968e2100de8339","55ed0b530d968e2100de8345","55ed0bb078319821005005cf","55ed0df94fba582b0036a18a","55ed0e0c4fba582b0036a18d","55ed0ebd8da0b12100e64246","55ed10bec9d5b3350072ae9a","55ed11410d968e2100de834d","55ed118678319821005005d9","55ed121dc9d5b3350072ae9e","55ed12de8da0b12100e6424e","55ed13930d968e2100de8352","55ed140c4fba582b0036a196","55ed1902c9d5b3350072aebb","55ed197bc9d5b3350072aec0","55ee3dba1452cd0d009e5ee9","5600a22f0c703d19009531e1","5600c6b23aa0520d00da0c41","561da674e078f40d00eadd75"],"project":"55e67aaa9cc7c62b00c4a1ea","version":"55e67aab9cc7c62b00c4a1ed","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-02T04:30:21.948Z","from_sync":false,"order":5,"slug":"rest-api","title":"REST API"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"55e67aaa9cc7c62b00c4a1ea","user":"55d29988486de50d00327118","version":{"__v":10,"_id":"55e67aab9cc7c62b00c4a1ed","project":"55e67aaa9cc7c62b00c4a1ea","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z","categories":["55e67aac9cc7c62b00c4a1ee","55e67b5556007d23005fee7d","55e67b5dde6fef23009480ca","55e680efde6fef23009480db","55e6829485a9741900314e99","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","589b8e1fdbb7cd190026732c","58b8ca5e3265d70f001788d4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-14T00:48:52.638Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"curl -X GET -u :API_KEY https://api.carnivalmobile.com/v5/devices/:device_id","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n\t\"devices\": {\n    \"id\": \"123\",\n    \"user_id\": \"johnsmith:::at:::example.com\",\n    \"push_enabled\": true,\n    \"push_token\": \"d35c15ee345d07f42016738323aa4818e4deacd6****f54dea932a677\",\n    \"platform\": \"iOS\",\n    \"last_opened\": \"2016-11-23T20:31:03.000Z\",\n    \"user_attributes\": {\n      \"age\": {\n        \"type\": \"integer\",\n        \"value\": 30\n      },\n      \"height\": {\n        \"type\": \"float\",\n        \"value\": 1.75\n      },\n      \"birthdate\": {\n        \"type\": \"date\",\n        \"value\": \"1985-05-01T00:00:00Z\"\n      },\n      \"vip\": {\n        \"type\": \"boolean\",\n        \"value\": true\n      },\n      \"favorite_color\": {\n        \"type\": \"string\",\n        \"value\": \"blue\"\n      }\n    },\n    \"user_events\": {\n      \"purchase_unlocked\": {\n        \"count\": 10,\n        \"first_happened_at\": \"2016-05-23T04:12:34.173Z\",\n        \"last_happened_at\": \"2016-05-24T04:12:34.173Z\"\n      }\n    },\n    \"location\": {\n      \"gps\": {\n        \"lat\": \"-41.12345\",\n        \"lng\": \"174.12345\"\n      },\n      \"geoip\": {\n        \"lat\": \"-41.0\",\n        \"lng\": \"174.0\",\n        \"city\": \"Wellington\",\n        \"country\": \"New Zealand\"\n      }\n    }\n  }\n}","language":"json","status":200},{"name":"","code":"{\n  \"error\":\"unauthorized\"\n}","language":"json","status":401},{"code":"{\n  \"error\":\"your api client does not have the correct roles\"\n}","language":"json","status":403}]},"settings":"","auth":"required","params":[{"_id":"561daa59e4dabd1700703c1d","ref":"","in":"path","required":false,"desc":"The Carnival Device ID","default":"","type":"string","name":"device_id"}],"url":"/devices/:device_id"},"isReference":true,"order":4,"body":"","excerpt":"","slug":"devices-1","type":"endpoint","title":"Devices"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

device_id:
string
The Carnival Device ID

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}