POST HwStructure/setDirectControl?Token={Token}

Set direct control of the hardware unit (relay). Application privilege "View" for licensed agenda "HW structure" required. HW Structure permission - privilege "Direct control" required.

Request Information

Authorization

  • Authorization by token required

Availability

  • Method can be used

URI Parameters

NameDescriptionTypeAdditional information
Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

 globally unique identifier

Required

Body Parameters

HwStructureSetDirectControlReq
NameDescriptionTypeAdditional information
HwStructNodePath

Unique identification of the hardware unit (relay) in the system

 string

Required
Action

Definition of the action to be done on relay. The meaning is : 1 = unblock one shot(for sensors and "switch on time" configured relay) / switch (for "switching mode" configured relay), 2 = unblock permanently("switch on" permanently for relay), 3 = block (supported hw - units with sensors,EXP,EXP2,EXT), 4 = standard mode on(supported hw - units with sensors,EXP,EXP2,EXT)

 integer

Required

Matching regular expression pattern: [1,2,3,4]

Request Formats

application/json

Sample: 
{"HwStructNodePath":"HW Structure - 0000151515ff S3","Action":2}

application/xml

Sample: 

<Request>
  <HwStructNodePath>HW Structure - 0000151515ff S3</HwStructNodePath>
  <Action>2</Action>
</Request>

text/json

Sample: 
{
  "HwStructNodePath": "sample string 1",
  "Action": 2
}

text/xml

Sample: 
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <HwStructNodePath>sample string 1</HwStructNodePath>
  <Action>2</Action>
</Request>

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 success
400 bad request 1002 Entry parameter missing or parameter bindigs failed
401 unauthorized 1000 Token {0} not found
401 unauthorized 1001 Token {0} already expired
401 unauthorized 1006 Ip filter violated for ip client address [{0}]
401 unauthorized 1007 Ip filter [{0}] parsing failed
401 unauthorized 1008 Request rate policy violated for [{0}]
403 server refuses fo fulfill the request 1222 Privilege View of agenda HW structure violated for [{0}]. Direct control is not allowed.
403 server refuses fo fulfill the request 2 Comm.server operation failed, address point does not support direct control or is disabled for address point
403 server refuses fo fulfill the request 3 Comm.server operation failed, address point is deactivated
403 server refuses fo fulfill the request 4 Comm.server operation failed, communication server error
403 server refuses fo fulfill the request 5 Comm.server operation failed, address point communication error
404 required resource does not exist on the server 1220 Hardwware structure unit not found
404 required resource does not exist on the server 1223 Address point not found
404 required resource does not exist on the server 1224 Requested action [{0}] for address point type [{1}] not allowed
415 unsupported Media Type The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error Server exception description

Resource Description

BaseRespOfHwStructureSetDirectControlReq
NameDescriptionTypeAdditional information
Result

RequestResult

None.
Request

HwStructureSetDirectControlReq

None.

Response Formats

application/json

Sample: 
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"HwStructNodePath":"HW Structure - 0000151515ff S3","Action":2}}

application/xml

Sample: 

<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <HwStructNodePath>HW Structure - 0000151515ff S3</HwStructNodePath>
    <Action>2</Action>
  </Request>
</Response>

text/json

Sample: 
{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Request": {
    "HwStructNodePath": "sample string 1",
    "Action": 2
  }
}

text/xml

Sample: 
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>
    <Message>sample string 1</Message>
    <Code>2</Code>
    <ModelStateErr>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </ModelStateErr>
  </Result>
  <Request>
    <HwStructNodePath>sample string 1</HwStructNodePath>
    <Action>2</Action>
  </Request>
</Response>