POST api/v1/account/users/state/{stateToSet}?UserCodeDirectPush={UserCodeDirectPush}

TC2.3+ Disable / Enable multiple users

Request Information

URI Parameters

NameDescriptionTypeAdditional information
stateToSet

state

boolean

Required

UserCodeDirectPush

boolean

Default value is False

Body Parameters

userID

UserId
NameDescriptionTypeAdditional information
UserIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "UserIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<UserId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.UserConfiguration">
  <UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </UserIds>
</UserId>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SaveUserResults

DisableEnableUserResults
NameDescriptionTypeAdditional information
EnableState

boolean

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EnableState": true,
  "ResultCode": 2,
  "ResultData": "sample string 3"
}

application/xml, text/xml

Sample:
<DisableEnableUserResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.UserConfiguration">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">2</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
  <EnableState>true</EnableState>
</DisableEnableUserResults>