POST api/v1/account/users/{userId}/homeCard
Update user prefered HomeCard order
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId |
Master User ID |
integer |
Required |
Body Parameters
List of Location sort order
Collection of LocationSortOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationId | integer |
None. |
|
| LocationOrder | integer |
None. |
Request 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>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BaseResults
BaseResults| Name | Description | Type | Additional information |
|---|---|---|---|
| ResultCode | integer |
None. |
|
| ResultData | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResultCode": 1,
"ResultData": "sample string 2"
}
application/xml, text/xml
Sample:
<BaseResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi"> <ResultCode>1</ResultCode> <ResultData>sample string 2</ResultData> </BaseResults>