GET api/v1/account/users/{userId}/homeCard

Return Preferred List of Location for Home Card.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

User ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

HomeCardLocations

Collection of LocationSortOrder
NameDescriptionTypeAdditional information
LocationId

integer

None.

LocationOrder

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "LocationId": 1,
    "LocationOrder": 2
  },
  {
    "LocationId": 1,
    "LocationOrder": 2
  }
]

application/xml, text/xml

Sample:
<ArrayOfLocationSortOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain">
  <LocationSortOrder>
    <LocationId>1</LocationId>
    <LocationOrder>2</LocationOrder>
  </LocationSortOrder>
  <LocationSortOrder>
    <LocationId>1</LocationId>
    <LocationOrder>2</LocationOrder>
  </LocationSortOrder>
</ArrayOfLocationSortOrder>