Remote Connection Type
A Remote Connection Type
resource represents all of the possible RemoteConnection
s supported by MapMyFitness.
See RemoteConnection
resource for more background
Resource URIs
Collection URI: /v7.1/remoteconnectiontype/
Item URI: /v7.1/remoteconnectiontype/<pk>/
Item
Methods
GET
Retrieve a Remote Connection Type
Query parameters
None
Properties
Name | Description | Type | Units | HTTP Support |
---|---|---|---|---|
type |
The type of the remote account | string |
GET: Required | |
name |
The readable name of the remote type | string |
GET: Required | |
recorder_type_key |
Key for recorders of this remote account type | string |
GET: Required | |
intro_copy_heading |
Heading for introductory email | string |
GET: Required | |
intro_copy_body |
Body for introductory email | string |
GET: Required | |
disconnect_copy |
Body for disconnection email | string |
GET: Required | |
disconnect_confirm |
Text for disconnection confirmation | string |
GET: Required | |
disconnect_cancel |
Text for cancelled disconnection | string |
GET: Required | |
oauth_connect_link |
Used internally | string |
GET: Required | |
logo_link |
relative URL to logo image asset | string |
GET: Required |
Item links
self
A link to this resource
device
A link to the Device used to record data
Collection
Methods
GET
: Retrieve all Remote Connection Type
Query parameters
Properties
Property | type | description |
---|---|---|
_embedded |
list |
The Remote Connection Type objects that match the query |
_links |
dict |
HAL style links. |
total_count |
int |
Total count of objects that match the query |
Usage
GET a single RemoteConnection
Request GET /v7.1/remoteconnectiontype/<id>/
Response
{
"recorder_type_key": "jawboneupmoves",
"name": "Jawbone",
"logo_link": "<url_to_logo>",
"type": "jawboneup",
"_links": {
"device": [
{
"href": "/v7.1/device/jawboneupmoves/",
"id": "jawboneupmoves"
}
],
"self": [
{
"href": "/v7.1/remoteconnectiontype/<id>/",
"id": "<id>"
}
],
"documentation": [
{
"href": "https://developer.mapmyfitness.com/docs/"
}
]
}
}
GET All RemoteConnections
Request GET /v7.1/remoteconnectiontype/
Response
{
"_links": {
"self": [
{
"href": "/v7.1/remoteconnectiontype/?limit=20&offset=0"
}
],
"documentation": [
{
"href": "https://developer.mapmyfitness.com/docs/"
}
],
},
"_embedded": {
"remoteconnectiontypes": [
{
"recorder_type_key": "withings",
"name": "Withings",
"logo_link": "<url_to_logo>",
"_links": {
"device": [
{
"href": "/v7.1/device/jawboneupmoves/",
"id": "jawboneupmoves"
}
],
"self": [
{
"href": "/v7.1/remoteconnectiontype/3/",
"id": "3"
}
]
},
"type": "jawboneup"
},
{
"recorder_type_key": "jawboneupmoves",
"name": "Jawbone",
"logo_link": "<url_to_logo>",
"_links": {
"device": [
{
"href": "/v7.1/device/jawboneupmoves/",
"id": "jawboneupmoves"
}
],
"self": [
{
"href": "/v7.1/remoteconnectiontype/2/",
"id": "2"
}
]
},
"type": "jawboneup"
},
]
},
"total_count": 2
}