POST api/v1/wifi/saveWifiLock/location/{locationId}/wifiLocation/{wifiLocklocationId}

SaveWiFiLockDevice in Total Connect. Equivalent SOAP API : SaveWiFiLockDevice

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

integer

Required

wifiLocklocationId

string

Required

Body Parameters

Collection of WiFiLockInfo
NameDescriptionTypeAdditional information
LockID

string

None.

LockName

string

None.

LockStatus

string

None.

LockConfiguration

WiFiLockConfigInfo

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "LockID": "sample string 1",
    "LockName": "sample string 2",
    "LockStatus": "sample string 3",
    "LockConfiguration": {
      "LockID": 1,
      "LockConfigState": 2
    }
  },
  {
    "LockID": "sample string 1",
    "LockName": "sample string 2",
    "LockStatus": "sample string 3",
    "LockConfiguration": {
      "LockID": 1,
      "LockConfigState": 2
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfWiFiLockInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
  <WiFiLockInfo>
    <LockConfiguration>
      <IsWHEnabled>true</IsWHEnabled>
      <LockConfigState>2</LockConfigState>
      <LockID>1</LockID>
    </LockConfiguration>
    <LockID>sample string 1</LockID>
    <LockName>sample string 2</LockName>
    <LockStatus>sample string 3</LockStatus>
  </WiFiLockInfo>
  <WiFiLockInfo>
    <LockConfiguration>
      <IsWHEnabled>true</IsWHEnabled>
      <LockConfigState>2</LockConfigState>
      <LockID>1</LockID>
    </LockConfiguration>
    <LockID>sample string 1</LockID>
    <LockName>sample string 2</LockName>
    <LockStatus>sample string 3</LockStatus>
  </WiFiLockInfo>
</ArrayOfWiFiLockInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResults

BaseResults
NameDescriptionTypeAdditional 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>