Remote Connection
A Remote Connection represents a user’s OAuth connection with an external 3rd-party API. For example, a Under Armour user can give a 3rd-party (i.e. Jawbone, Fitbit, Withings, etc) permission to let Under Armour view his/her remote data.
The Remote Connection is a user’s list of all current connections with 3rd-parties. See RemoteConnectionType for list of all possible connections supported by Under Armour
Resource URIs
Item URI: /v7.0/remoteconnection/{pk}/
Collection URI: /v7.0/remoteconnection/
Item
Item Methods
GET Get a Remote Connection by id. The requesting user needs to be the owner of the connection.
DELETE Revoke a Remote Connection by id. The requesting user needs to be the owner of the connection.
Item query parameters
None
Item properties
| Property | type | description | |
|---|---|---|---|
remote_id |
Read only | String | The id of the Remote Connection. |
type |
Read only | String | The type of Remote Connection. See RemoteConnectionTypes resource for more information. |
created_datetime |
Read only | String: ISO8601 formatted with offset (YYYY-MM-DDThh:mm:ssZ) | The time at which the Remote Connection was made and authorized. |
last_sync_time |
Read only | String: ISO8601 formatted with offset (YYYY-MM-DDThh:mm:ssZ) | The last time of a successful sync. |
Item links
self A link to this resource
user A link to the user that owns the Remote Connection
Collection
Collection methods
GET Get a list of Remote Connections owned by the calling user.
Collection query parameters
None
Collection properties
| Property | type | description | |
|---|---|---|---|
total_count |
Read-only | Number | Total count of Remote Connections returned in a collection |
Collection links
self A link to this resource
Usage
Fetch a single Remote Connection
Request GET: /v7.0/remoteconnection/<remote_id>/
Response
{
"created_datetime": "2014-04-20T03:12:00+00:00",
"last_sync_time": "2014-05-04T17:31:06+00:00",
"remote_id": "<redacted>",
"_links": {
"self": [
{
"href": "/v7.0/remoteconnection/<id>/",
"id": "<id>"
}
],
"documentation": [
{
"href": "https://developer.underarmour.com/docs/"
}
],
"user": [
{
"href": "/v7.0/user/<user_id>/",
"id": "<user_id>"
}
]
},
"type": "withings"
}
Deleting a Remote Connection
Request DELETE: /v7.0/remoteconnection/<remote_id>/
Response 204
Fetching All Remote Connections (for the calling user)
Request GET /v7.0/remoteconnection/
Response
{
"_links": {
"self": [
{
"href": "/v7.0/remoteconnection/?limit=20&offset=0"
}
],
"documentation": [
{
"href": "https://developer.underarmour.com/docs/"
}
],
},
"_embedded": {
"remoteconnection": [
{
"created_datetime": "2014-04-20T03:12:00+00:00",
"last_sync_time": "2014-05-04T17:31:06+00:00",
"remote_id": "<redacted>",
"_links": {
"self": [
{
"href": "/v7.0/remoteconnection/555/",
"id": "555"
}
],
"user": [
{
"href": "/v7.0/user/<user_id>/",
"id": "<user_id>"
}
]
},
"type": "withings"
},
{
"created_datetime": "2014-04-22T22:24:00+00:00",
"last_sync_time": "2014-05-07T14:41:05+00:00",
"remote_id": "<redacted>",
"_links": {
"self": [
{
"href": "/v7.0/remoteconnection/666/",
"id": "666"
}
],
"user": [
{
"href": "/v7.0/user/<user_id>/",
"id": "<user_id>"
}
]
},
"type": "jawboneup"
},
]
},
"total_count": 2
}