PUT api/content/v4/usertrip/dashboard

Request Information

URI Parameters

None.

Body Parameters

APIDashBoardRequest
NameDescriptionTypeAdditional information
CustomerId

integer

None.

UniqueId

globally unique identifier

None.

UserUniqueId

integer

None.

ProgramId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerId": 1,
  "UniqueId": "cc75065d-2cf1-44a0-a0fc-eeab30b0dfcf",
  "UserUniqueId": 3,
  "ProgramId": 4
}

application/xml, text/xml

Sample:
<APIDashBoardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <CustomerId>1</CustomerId>
  <ProgramId>4</ProgramId>
  <UniqueId>cc75065d-2cf1-44a0-a0fc-eeab30b0dfcf</UniqueId>
  <UserUniqueId>3</UserUniqueId>
</APIDashBoardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfAPIDashBoardResponse
NameDescriptionTypeAdditional information
Status

HttpStatusCode

None.

Message

string

None.

Data

APIDashBoardResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {
    "TotalUnits": "sample string 1",
    "TotalCalories": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<APICommonWrapperOfAPIDashBoardResponseZdSfSp5S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data>
    <TotalCalories>sample string 2</TotalCalories>
    <TotalUnits>sample string 1</TotalUnits>
  </Data>
  <Message>sample string 1</Message>
  <Status>Continue</Status>
</APICommonWrapperOfAPIDashBoardResponseZdSfSp5S>