POST api/Health/GetHealthForPeriod

The number of steps in a certain period of time

Request Information

Body Parameters

GetHealthModel
NameDescriptionTypeAdditional information
StartTime

start time

date

None.

EndTime

ending time

date

None.

DeviceId

device id

integer

None.

TimeOffset

time zone

decimal number

None.

Token

Get it after logging in Token

string

None.

Language

Language Option

string

None.

AppId

APP Application Identifier

string

None.

Request Formats

application/json, text/json

Sample:
{
  "StartTime": "2018-10-21T02:11:02.0142878+08:00",
  "EndTime": "2018-10-21T02:11:02.0142878+08:00",
  "DeviceId": 3,
  "TimeOffset": 4.1,
  "Token": "sample string 5",
  "Language": "sample string 6",
  "AppId": "sample string 7"
}

application/xml, text/xml

Sample:
<GetHealthModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewGPS2012.AppApi.Models.ParModel">
  <AppId>sample string 7</AppId>
  <Language>sample string 6</Language>
  <Token>sample string 5</Token>
  <DeviceId>3</DeviceId>
  <EndTime>2018-10-21T02:11:02.0142878+08:00</EndTime>
  <StartTime>2018-10-21T02:11:02.0142878+08:00</StartTime>
  <TimeOffset>4.1</TimeOffset>
</GetHealthModel>

Response Information

Resource Description

State status code:
0. Indicates success
1100. device does not exist

GetHealthForDayResult
NameDescriptionTypeAdditional information
StepsCount

The total number of steps

integer

None.

State

status code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "StepsCount": 1,
  "State": 2
}

application/xml, text/xml

Sample:
<GetHealthForDayResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewGPS2012.AppApi.Models.ResModel">
  <State>2</State>
  <StepsCount>1</StepsCount>
</GetHealthForDayResult>