User Gear
This resource allows creation and modification of user gear.
Resource URIs
- Item URI:
/v7.1/usergear/{id}/ - Collection URI:
/v7.1/usergear/
Item
Item Methods
GETRetrieve a User GearPATCHUpdate a User GearDELETEDelete a User Gear
Item properties
| Name | Description | Type | Units | HTTP Support |
|---|---|---|---|---|
name |
The name that the user has give this specific piece of gear. | string | PUT: Required | |
purchase_date |
Date the user purchased the gear. | date | PUT: Required | |
initial_distance |
Number of miles the gear was already used for. | number | miles | PUT: Optional |
current_distance |
Number of miles used on the current gear during workouts since initial_distance. |
number | miles | PUT: Optional |
target_distance |
A max number of miles that the gear should be used for. | number | miles | PUT: Optional |
total_time |
The amount of time (both during and not during workouts) this gear has been used. | number | seconds | PUT: Optional |
total_steps |
The number of steps (both during and not during workouts) this gear has been used for. | number | PUT: Optional | |
retired |
Whether the gear has been retired or not. | boolean | PUT: Required | |
default_activities |
Setting for the default activities for which the gear is used. | list of Activity Type ids | PUT: Optional | |
brand |
The over-arching brand of the gear. | string | PUT: Optional | |
model |
The specific gear model. | string | PUT: Optional | |
gender |
The gender the gear was designed for. | string | PUT: Optional | |
advertised_name |
(For Connected Gear) The name a Gear advertises over Bluetooth. | string | PUT: Optional | |
serial_number |
(For Connected Gear) A unique identifier for the Gear. | string | PUT: Optional | |
bluetooth_device_address |
(For Connected Gear) The BDA(Bluetooth Device Address) for the Gear. | string | PUT: Optional | |
firmware_version |
(For Connected Gear) The firmware version of the Gear. | string | PUT: Optional | |
hardware_version |
(For Connected Gear) The hardware version of the Gear. | string | PUT: Optional |
A Note on Total and Current
The current_distance property is calculated by the server by adding the
distances of all the workouts the gear was used for. If you wear, e.g. a pair of
shoes while just walking around town without recording a workout, the distance
will not be updated.
The properties total_time and total_steps, on the other hand, are not
calculated by the server. They’re meant to be a way that a client can track
these data either on the gear (if it has the ability to do so) or on the client
and then store those values in the API.
Item links
selfA link to this resourceuserA link to the User resource that owns the usergeargearAn embedded link to the Gear resource that the user has
Collection
Collection methods
GETRetrieve User Gear for the authenticated userPOSTCreate some User Gear
Usage
Retrieve a single User Gear
Request GET /v7.1/usergear/{id}/
Response: 200
{
"_embedded": {
"_links": {
"self": [
{
"href": "/v7.1/gear/47053/",
"id": 47053
}
]
},
"gear": {
"style_number": "1245952-100",
"color": "White",
"product_url": "http://www.zappos.com/product/8248039/color/80263?utm_campaign=mmf_mobile&splash=none&zhlfid=212",
"keywords": null,
"age_group": "adult",
"size": "10,10.5,11,11.5,12,12.5,13,14,15,7,7.5,8,8.5,9,9.5",
"sku": "8248039",
"source": "zappos",
"department": "Footwear: Athletic: General Athletic",
"brand": "Under Armour",
"available": true,
"category": "Shoes",
"description": "Once again, Under Armour brings new innovation into the field of performance. The Speedform Apollo features a unique construction, taking place entirely in a clothing factory. Every aspect of the Apollo is designed to help you perform at your highest levels. ; Breathable, mesh upper features ultrasonic seams for a smooth look. ; First-ever molded seamless heel cup offers the highest levels of comfort and support. ; Perforations throughout upper promote ventilation and keep you cool. ; Lace up closure for a custom fit. ; High-rebound, Micro G midsole for lightweight support. ; Medial TPU stability bar ensures superior reinforcement. ; High-abrasion rubber outsole features natural flex grooves to create a natural stride. ; Imported. Measurements: ; Weight: 8 oz ; Product measurements were taken using size 12, width D - Medium. Please note that measurements may vary by size.",
"price": null,
"purchase_url": "http://www.zappos.com/product/8248039/color/80263?utm_campaign=mmf_mobile&zhlfid=212",
"mid_level_product_type": "Athletic",
"photo_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964736/gear/5dc67ae4027e4b52a3836a3a62a879fb.jpg",
"detail_photo_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964735/gear/1e8c629e83194495bddc9130faa96f09.jpg",
"product_type": "General Athletic",
"gender": "Male",
"upc": 888284356644,
"thumbnail_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964735/gear/d35532a0269e4c969562dd10f177bfc9.jpg",
"styleid": "2727065",
"model": "UA Speedform Apollo Shoes",
"msrp": "99.99"
}
},
"name": "fancy shoes",
"initial_distance": 0.0,
"target_distance": 100,
"_links": {
"self": [
{
"href": "/v7.1/usergear/750998/",
"id": "750998"
}
],
"documentation": [
{
"href": "https://developer.mapmyfitness.com/docs/${doc_uri}"
}
],
"user": [
{
"href": "/v7.1/user/user_id/",
"id": "user_id"
}
]
},
"purchase_date": "2014-10-10",
"current_distance": 0.0,
"total_steps": null,
"total_time": null,
"retired": false,
"advertised_name": null,
"serial_number": null,
"bluetooth_device_address": null,
"firmware_version": null,
"hardware_version": null
}
Update a User Gear
Request: PATCH /v7.1/usergear/{id}/
{
"current_distance": 50.1
}
Response: 200
{
"_embedded": {
"_links": {
"self": [
{
"href": "/v7.1/gear/47053/",
"id": 47053
}
]
},
"gear": {
"style_number": "1245952-100",
"color": "White",
"product_url": "http://www.zappos.com/product/8248039/color/80263?utm_campaign=mmf_mobile&splash=none&zhlfid=212",
"keywords": null,
"age_group": "adult",
"size": "10,10.5,11,11.5,12,12.5,13,14,15,7,7.5,8,8.5,9,9.5",
"sku": "8248039",
"source": "zappos",
"department": "Footwear: Athletic: General Athletic",
"brand": "Under Armour",
"available": true,
"category": "Shoes",
"description": "Once again, Under Armour brings new innovation into the field of performance. The Speedform Apollo features a unique construction, taking place entirely in a clothing factory. Every aspect of the Apollo is designed to help you perform at your highest levels. ; Breathable, mesh upper features ultrasonic seams for a smooth look. ; First-ever molded seamless heel cup offers the highest levels of comfort and support. ; Perforations throughout upper promote ventilation and keep you cool. ; Lace up closure for a custom fit. ; High-rebound, Micro G midsole for lightweight support. ; Medial TPU stability bar ensures superior reinforcement. ; High-abrasion rubber outsole features natural flex grooves to create a natural stride. ; Imported. Measurements: ; Weight: 8 oz ; Product measurements were taken using size 12, width D - Medium. Please note that measurements may vary by size.",
"price": null,
"purchase_url": "http://www.zappos.com/product/8248039/color/80263?utm_campaign=mmf_mobile&zhlfid=212",
"mid_level_product_type": "Athletic",
"photo_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964736/gear/5dc67ae4027e4b52a3836a3a62a879fb.jpg",
"detail_photo_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964735/gear/1e8c629e83194495bddc9130faa96f09.jpg",
"product_type": "General Athletic",
"gender": "Male",
"upc": 888284356644,
"thumbnail_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964735/gear/d35532a0269e4c969562dd10f177bfc9.jpg",
"styleid": "2727065",
"model": "UA Speedform Apollo Shoes",
"msrp": "99.99"
}
},
"name": "fancy shoes",
"initial_distance": 0.0,
"target_distance": 100,
"_links": {
"self": [
{
"href": "/v7.1/usergear/750998/",
"id": "750998"
}
],
"documentation": [
{
"href": "https://developer.mapmyfitness.com/docs/${doc_uri}"
}
],
"user": [
{
"href": "/v7.1/user/user_id/",
"id": "user_id"
}
]
},
"purchase_date": "2014-10-10",
"current_distance": 50.1,
"total_steps": null,
"total_time": null,
"retired": false,
"advertised_name": null,
"serial_number": null,
"bluetooth_device_address": null,
"firmware_version": null,
"hardware_version": null
}
Retrieve several User Gear
Request: GET /v7.1/usergear/
Response: 200
{
"_embedded": {
"usergear": [
{
"_embedded": {
"_links": {
"self": [
{
"href": "/v7.1/gear/47053/",
"id": 47053
}
]
},
"gear": {
"style_number": "1245952-100",
"color": "White",
"product_url": "http://www.zappos.com/product/8248039/color/80263?utm_campaign=mmf_mobile&splash=none&zhlfid=212",
"keywords": null,
"age_group": "adult",
"size": "10,10.5,11,11.5,12,12.5,13,14,15,7,7.5,8,8.5,9,9.5",
"sku": "8248039",
"source": "zappos",
"department": "Footwear: Athletic: General Athletic",
"brand": "Under Armour",
"available": true,
"category": "Shoes",
"description": "Once again, Under Armour brings new innovation into the field of performance. The Speedform Apollo features a unique construction, taking place entirely in a clothing factory. Every aspect of the Apollo is designed to help you perform at your highest levels. ; Breathable, mesh upper features ultrasonic seams for a smooth look. ; First-ever molded seamless heel cup offers the highest levels of comfort and support. ; Perforations throughout upper promote ventilation and keep you cool. ; Lace up closure for a custom fit. ; High-rebound, Micro G midsole for lightweight support. ; Medial TPU stability bar ensures superior reinforcement. ; High-abrasion rubber outsole features natural flex grooves to create a natural stride. ; Imported. Measurements: ; Weight: 8 oz ; Product measurements were taken using size 12, width D - Medium. Please note that measurements may vary by size.",
"price": null,
"purchase_url": "http://www.zappos.com/product/8248039/color/80263?utm_campaign=mmf_mobile&zhlfid=212",
"mid_level_product_type": "Athletic",
"photo_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964736/gear/5dc67ae4027e4b52a3836a3a62a879fb.jpg",
"detail_photo_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964735/gear/1e8c629e83194495bddc9130faa96f09.jpg",
"product_type": "General Athletic",
"gender": "Male",
"upc": 888284356644,
"thumbnail_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964735/gear/d35532a0269e4c969562dd10f177bfc9.jpg",
"styleid": "2727065",
"model": "UA Speedform Apollo Shoes",
"msrp": "99.99"
}
},
"name": "fancy shoes",
"initial_distance": 0.0,
"target_distance": 100,
"_links": {
"self": [
{
"href": "/v7.1/usergear/750998/",
"id": "750998"
}
],
"user": [
{
"href": "/v7.1/user/user_id/",
"id": "user_id"
}
]
},
"purchase_date": "2014-10-10",
"current_distance": 0.0,
"total_steps": null,
"total_time": null,
"retired": false,
"advertised_name": null,
"serial_number": null,
"bluetooth_device_address": null,
"firmware_version": null,
"hardware_version": null
}
]
},
"_links": {
"self": [
{
"href": "/v7.1/usergear/?limit=20&offset=0"
}
],
"documentation": [
{
"href": "https://developer.mapmyfitness.com/docs/${doc_uri}"
}
]
},
"total_count": 1
}
Create a User Gear
Request: POST /v7.1/usergear/
{
"model": "fancy",
"retired": false,
"name": "fancy shoes",
"gear": "/v7.1/gear/47053/",
"initial_distance": 0,
"target_distance": 100,
"brand": "off",
"purchase_date": "2014-10-10"
}
Response: 201
{
"_embedded": {
"_links": {
"self": [
{
"href": "/v7.1/gear/47053/",
"id": 47053
}
]
},
"gear": {
"style_number": "1245952-100",
"color": "White",
"product_url": "http://www.zappos.com/product/8248039/color/80263?utm_campaign=mmf_mobile&splash=none&zhlfid=212",
"keywords": null,
"age_group": "adult",
"size": "10,10.5,11,11.5,12,12.5,13,14,15,7,7.5,8,8.5,9,9.5",
"sku": "8248039",
"source": "zappos",
"department": "Footwear: Athletic: General Athletic",
"brand": "Under Armour",
"available": true,
"category": "Shoes",
"description": "Once again, Under Armour brings new innovation into the field of performance. The Speedform Apollo features a unique construction, taking place entirely in a clothing factory. Every aspect of the Apollo is designed to help you perform at your highest levels. ; Breathable, mesh upper features ultrasonic seams for a smooth look. ; First-ever molded seamless heel cup offers the highest levels of comfort and support. ; Perforations throughout upper promote ventilation and keep you cool. ; Lace up closure for a custom fit. ; High-rebound, Micro G midsole for lightweight support. ; Medial TPU stability bar ensures superior reinforcement. ; High-abrasion rubber outsole features natural flex grooves to create a natural stride. ; Imported. Measurements: ; Weight: 8 oz ; Product measurements were taken using size 12, width D - Medium. Please note that measurements may vary by size.",
"price": null,
"purchase_url": "http://www.zappos.com/product/8248039/color/80263?utm_campaign=mmf_mobile&zhlfid=212",
"mid_level_product_type": "Athletic",
"photo_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964736/gear/5dc67ae4027e4b52a3836a3a62a879fb.jpg",
"detail_photo_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964735/gear/1e8c629e83194495bddc9130faa96f09.jpg",
"product_type": "General Athletic",
"gender": "Male",
"upc": 888284356644,
"thumbnail_url": "https://res.cloudinary.com/mapmyfitness/image/upload/v1407964735/gear/d35532a0269e4c969562dd10f177bfc9.jpg",
"styleid": "2727065",
"model": "UA Speedform Apollo Shoes",
"msrp": "99.99"
}
},
"name": "fancy shoes",
"initial_distance": 0.0,
"target_distance": 100,
"_links": {
"self": [
{
"href": "/v7.1/usergear/750998/",
"id": "750998"
}
],
"documentation": [
{
"href": "https://developer.mapmyfitness.com/docs/${doc_uri}"
}
],
"user": [
{
"href": "/v7.1/user/user_id/",
"id": "user_id"
}
]
},
"purchase_date": "2014-10-10",
"current_distance": 0.0,
"total_steps": null,
"total_time": null,
"retired": false,
"advertised_name": null,
"serial_number": null,
"bluetooth_device_address": null,
"firmware_version": null,
"hardware_version": null
}