GET api/v1/account/users/validateuser/location

Returns list of locations having the given usercode

Request Information

URI Parameters

None.

Body Parameters

Request payload can contain upto 10 locations

MultiLocationUserDetails
NameDescriptionTypeAdditional information
UserId

integer

None.

Locations

Collection of LocationUserAuthorization

None.

Request Formats

application/json, text/json

Sample:
{
  "Locations": [
    {
      "locationID": 1,
      "locationName": "sample string 2",
      "deviceList": [
        {
          "deviceID": 1,
          "deviceName": "sample string 2",
          "deviceClassID": 3,
          "deviceSerialNumber": "sample string 4",
          "isAccessGranted": true,
          "partitionAuthorization": [
            {
              "PartitionId": 1,
              "PartitionName": "sample string 2",
              "AuthorityLevel": 3,
              "IsAccessGranted": true,
              "IsStayArmed": true,
              "IsFireEnabled": true,
              "IsCommonEnabled": true,
              "IsLocked": true,
              "OpenCloseReport": 1,
              "GlobalArm": 1
            },
            {
              "PartitionId": 1,
              "PartitionName": "sample string 2",
              "AuthorityLevel": 3,
              "IsAccessGranted": true,
              "IsStayArmed": true,
              "IsFireEnabled": true,
              "IsCommonEnabled": true,
              "IsLocked": true,
              "OpenCloseReport": 1,
              "GlobalArm": 1
            }
          ],
          "panelSlotNumber": "sample string 6",
          "panelUserCode": "sample string 7",
          "previousUserCode": "sample string 8",
          "userCodeLength": 9,
          "userCodeLengthChanged": 10,
          "sync": "sample string 11",
          "deviceAuthorizationAttributes": [
            {
              "name": "sample string 1",
              "value": "sample string 2"
            },
            {
              "name": "sample string 1",
              "value": "sample string 2"
            }
          ],
          "prerequisiteDeviceID": 12,
          "prerequisiteDeviceClassID": 13,
          "deviceTypeID": 14,
          "isDuplicateUserCode": true,
          "isPartitionManager": true,
          "isZwaveLockControlEnabled": true,
          "isDisarmOnZwaveUnLockEnabled": true,
          "isVoDAccessEnabled": 1,
          "partitionNumber": 1,
          "fireAuthorityEnabled": 19,
          "isFireAuthoritySupported": true
        },
        {
          "deviceID": 1,
          "deviceName": "sample string 2",
          "deviceClassID": 3,
          "deviceSerialNumber": "sample string 4",
          "isAccessGranted": true,
          "partitionAuthorization": [
            {
              "PartitionId": 1,
              "PartitionName": "sample string 2",
              "AuthorityLevel": 3,
              "IsAccessGranted": true,
              "IsStayArmed": true,
              "IsFireEnabled": true,
              "IsCommonEnabled": true,
              "IsLocked": true,
              "OpenCloseReport": 1,
              "GlobalArm": 1
            },
            {
              "PartitionId": 1,
              "PartitionName": "sample string 2",
              "AuthorityLevel": 3,
              "IsAccessGranted": true,
              "IsStayArmed": true,
              "IsFireEnabled": true,
              "IsCommonEnabled": true,
              "IsLocked": true,
              "OpenCloseReport": 1,
              "GlobalArm": 1
            }
          ],
          "panelSlotNumber": "sample string 6",
          "panelUserCode": "sample string 7",
          "previousUserCode": "sample string 8",
          "userCodeLength": 9,
          "userCodeLengthChanged": 10,
          "sync": "sample string 11",
          "deviceAuthorizationAttributes": [
            {
              "name": "sample string 1",
              "value": "sample string 2"
            },
            {
              "name": "sample string 1",
              "value": "sample string 2"
            }
          ],
          "prerequisiteDeviceID": 12,
          "prerequisiteDeviceClassID": 13,
          "deviceTypeID": 14,
          "isDuplicateUserCode": true,
          "isPartitionManager": true,
          "isZwaveLockControlEnabled": true,
          "isDisarmOnZwaveUnLockEnabled": true,
          "isVoDAccessEnabled": 1,
          "partitionNumber": 1,
          "fireAuthorityEnabled": 19,
          "isFireAuthoritySupported": true
        }
      ],
      "photoURL": "sample string 3"
    },
    {
      "locationID": 1,
      "locationName": "sample string 2",
      "deviceList": [
        {
          "deviceID": 1,
          "deviceName": "sample string 2",
          "deviceClassID": 3,
          "deviceSerialNumber": "sample string 4",
          "isAccessGranted": true,
          "partitionAuthorization": [
            {
              "PartitionId": 1,
              "PartitionName": "sample string 2",
              "AuthorityLevel": 3,
              "IsAccessGranted": true,
              "IsStayArmed": true,
              "IsFireEnabled": true,
              "IsCommonEnabled": true,
              "IsLocked": true,
              "OpenCloseReport": 1,
              "GlobalArm": 1
            },
            {
              "PartitionId": 1,
              "PartitionName": "sample string 2",
              "AuthorityLevel": 3,
              "IsAccessGranted": true,
              "IsStayArmed": true,
              "IsFireEnabled": true,
              "IsCommonEnabled": true,
              "IsLocked": true,
              "OpenCloseReport": 1,
              "GlobalArm": 1
            }
          ],
          "panelSlotNumber": "sample string 6",
          "panelUserCode": "sample string 7",
          "previousUserCode": "sample string 8",
          "userCodeLength": 9,
          "userCodeLengthChanged": 10,
          "sync": "sample string 11",
          "deviceAuthorizationAttributes": [
            {
              "name": "sample string 1",
              "value": "sample string 2"
            },
            {
              "name": "sample string 1",
              "value": "sample string 2"
            }
          ],
          "prerequisiteDeviceID": 12,
          "prerequisiteDeviceClassID": 13,
          "deviceTypeID": 14,
          "isDuplicateUserCode": true,
          "isPartitionManager": true,
          "isZwaveLockControlEnabled": true,
          "isDisarmOnZwaveUnLockEnabled": true,
          "isVoDAccessEnabled": 1,
          "partitionNumber": 1,
          "fireAuthorityEnabled": 19,
          "isFireAuthoritySupported": true
        },
        {
          "deviceID": 1,
          "deviceName": "sample string 2",
          "deviceClassID": 3,
          "deviceSerialNumber": "sample string 4",
          "isAccessGranted": true,
          "partitionAuthorization": [
            {
              "PartitionId": 1,
              "PartitionName": "sample string 2",
              "AuthorityLevel": 3,
              "IsAccessGranted": true,
              "IsStayArmed": true,
              "IsFireEnabled": true,
              "IsCommonEnabled": true,
              "IsLocked": true,
              "OpenCloseReport": 1,
              "GlobalArm": 1
            },
            {
              "PartitionId": 1,
              "PartitionName": "sample string 2",
              "AuthorityLevel": 3,
              "IsAccessGranted": true,
              "IsStayArmed": true,
              "IsFireEnabled": true,
              "IsCommonEnabled": true,
              "IsLocked": true,
              "OpenCloseReport": 1,
              "GlobalArm": 1
            }
          ],
          "panelSlotNumber": "sample string 6",
          "panelUserCode": "sample string 7",
          "previousUserCode": "sample string 8",
          "userCodeLength": 9,
          "userCodeLengthChanged": 10,
          "sync": "sample string 11",
          "deviceAuthorizationAttributes": [
            {
              "name": "sample string 1",
              "value": "sample string 2"
            },
            {
              "name": "sample string 1",
              "value": "sample string 2"
            }
          ],
          "prerequisiteDeviceID": 12,
          "prerequisiteDeviceClassID": 13,
          "deviceTypeID": 14,
          "isDuplicateUserCode": true,
          "isPartitionManager": true,
          "isZwaveLockControlEnabled": true,
          "isDisarmOnZwaveUnLockEnabled": true,
          "isVoDAccessEnabled": 1,
          "partitionNumber": 1,
          "fireAuthorityEnabled": 19,
          "isFireAuthoritySupported": true
        }
      ],
      "photoURL": "sample string 3"
    }
  ],
  "UserId": 1
}

application/xml, text/xml

Sample:
<MultiLocationUserDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.UserConfiguration">
  <Locations>
    <LocationUserAuthorization>
      <deviceList>
        <DeviceUserAuthorization>
          <deviceAuthorizationAttributes>
            <DeviceAttribute>
              <name>sample string 1</name>
              <value>sample string 2</value>
            </DeviceAttribute>
            <DeviceAttribute>
              <name>sample string 1</name>
              <value>sample string 2</value>
            </DeviceAttribute>
          </deviceAuthorizationAttributes>
          <deviceClassID>3</deviceClassID>
          <deviceID>1</deviceID>
          <deviceName>sample string 2</deviceName>
          <deviceSerialNumber>sample string 4</deviceSerialNumber>
          <deviceTypeID>14</deviceTypeID>
          <fireAuthorityEnabled>19</fireAuthorityEnabled>
          <isAccessGranted>true</isAccessGranted>
          <isDisarmOnZwaveUnLockEnabled>true</isDisarmOnZwaveUnLockEnabled>
          <isDuplicateUserCode>true</isDuplicateUserCode>
          <isFireAuthoritySupported>true</isFireAuthoritySupported>
          <isPartitionManager>true</isPartitionManager>
          <isVoDAccessEnabled>1</isVoDAccessEnabled>
          <isZwaveLockControlEnabled>true</isZwaveLockControlEnabled>
          <panelSlotNumber>sample string 6</panelSlotNumber>
          <panelUserCode>sample string 7</panelUserCode>
          <partitionAuthorization>
            <PartitionUserAuthorization>
              <AuthorityLevel>3</AuthorityLevel>
              <GlobalArm>1</GlobalArm>
              <IsAccessGranted>true</IsAccessGranted>
              <IsCommonEnabled>true</IsCommonEnabled>
              <IsFireEnabled>true</IsFireEnabled>
              <IsLocked>true</IsLocked>
              <IsStayArmed>true</IsStayArmed>
              <OpenCloseReport>1</OpenCloseReport>
              <PartitionId>1</PartitionId>
              <PartitionName>sample string 2</PartitionName>
            </PartitionUserAuthorization>
            <PartitionUserAuthorization>
              <AuthorityLevel>3</AuthorityLevel>
              <GlobalArm>1</GlobalArm>
              <IsAccessGranted>true</IsAccessGranted>
              <IsCommonEnabled>true</IsCommonEnabled>
              <IsFireEnabled>true</IsFireEnabled>
              <IsLocked>true</IsLocked>
              <IsStayArmed>true</IsStayArmed>
              <OpenCloseReport>1</OpenCloseReport>
              <PartitionId>1</PartitionId>
              <PartitionName>sample string 2</PartitionName>
            </PartitionUserAuthorization>
          </partitionAuthorization>
          <partitionNumber>1</partitionNumber>
          <prerequisiteDeviceClassID>13</prerequisiteDeviceClassID>
          <prerequisiteDeviceID>12</prerequisiteDeviceID>
          <previousUserCode>sample string 8</previousUserCode>
          <sync>sample string 11</sync>
          <userCodeLength>9</userCodeLength>
          <userCodeLengthChanged>10</userCodeLengthChanged>
        </DeviceUserAuthorization>
        <DeviceUserAuthorization>
          <deviceAuthorizationAttributes>
            <DeviceAttribute>
              <name>sample string 1</name>
              <value>sample string 2</value>
            </DeviceAttribute>
            <DeviceAttribute>
              <name>sample string 1</name>
              <value>sample string 2</value>
            </DeviceAttribute>
          </deviceAuthorizationAttributes>
          <deviceClassID>3</deviceClassID>
          <deviceID>1</deviceID>
          <deviceName>sample string 2</deviceName>
          <deviceSerialNumber>sample string 4</deviceSerialNumber>
          <deviceTypeID>14</deviceTypeID>
          <fireAuthorityEnabled>19</fireAuthorityEnabled>
          <isAccessGranted>true</isAccessGranted>
          <isDisarmOnZwaveUnLockEnabled>true</isDisarmOnZwaveUnLockEnabled>
          <isDuplicateUserCode>true</isDuplicateUserCode>
          <isFireAuthoritySupported>true</isFireAuthoritySupported>
          <isPartitionManager>true</isPartitionManager>
          <isVoDAccessEnabled>1</isVoDAccessEnabled>
          <isZwaveLockControlEnabled>true</isZwaveLockControlEnabled>
          <panelSlotNumber>sample string 6</panelSlotNumber>
          <panelUserCode>sample string 7</panelUserCode>
          <partitionAuthorization>
            <PartitionUserAuthorization>
              <AuthorityLevel>3</AuthorityLevel>
              <GlobalArm>1</GlobalArm>
              <IsAccessGranted>true</IsAccessGranted>
              <IsCommonEnabled>true</IsCommonEnabled>
              <IsFireEnabled>true</IsFireEnabled>
              <IsLocked>true</IsLocked>
              <IsStayArmed>true</IsStayArmed>
              <OpenCloseReport>1</OpenCloseReport>
              <PartitionId>1</PartitionId>
              <PartitionName>sample string 2</PartitionName>
            </PartitionUserAuthorization>
            <PartitionUserAuthorization>
              <AuthorityLevel>3</AuthorityLevel>
              <GlobalArm>1</GlobalArm>
              <IsAccessGranted>true</IsAccessGranted>
              <IsCommonEnabled>true</IsCommonEnabled>
              <IsFireEnabled>true</IsFireEnabled>
              <IsLocked>true</IsLocked>
              <IsStayArmed>true</IsStayArmed>
              <OpenCloseReport>1</OpenCloseReport>
              <PartitionId>1</PartitionId>
              <PartitionName>sample string 2</PartitionName>
            </PartitionUserAuthorization>
          </partitionAuthorization>
          <partitionNumber>1</partitionNumber>
          <prerequisiteDeviceClassID>13</prerequisiteDeviceClassID>
          <prerequisiteDeviceID>12</prerequisiteDeviceID>
          <previousUserCode>sample string 8</previousUserCode>
          <sync>sample string 11</sync>
          <userCodeLength>9</userCodeLength>
          <userCodeLengthChanged>10</userCodeLengthChanged>
        </DeviceUserAuthorization>
      </deviceList>
      <locationID>1</locationID>
      <locationName>sample string 2</locationName>
      <photoURL>sample string 3</photoURL>
    </LocationUserAuthorization>
    <LocationUserAuthorization>
      <deviceList>
        <DeviceUserAuthorization>
          <deviceAuthorizationAttributes>
            <DeviceAttribute>
              <name>sample string 1</name>
              <value>sample string 2</value>
            </DeviceAttribute>
            <DeviceAttribute>
              <name>sample string 1</name>
              <value>sample string 2</value>
            </DeviceAttribute>
          </deviceAuthorizationAttributes>
          <deviceClassID>3</deviceClassID>
          <deviceID>1</deviceID>
          <deviceName>sample string 2</deviceName>
          <deviceSerialNumber>sample string 4</deviceSerialNumber>
          <deviceTypeID>14</deviceTypeID>
          <fireAuthorityEnabled>19</fireAuthorityEnabled>
          <isAccessGranted>true</isAccessGranted>
          <isDisarmOnZwaveUnLockEnabled>true</isDisarmOnZwaveUnLockEnabled>
          <isDuplicateUserCode>true</isDuplicateUserCode>
          <isFireAuthoritySupported>true</isFireAuthoritySupported>
          <isPartitionManager>true</isPartitionManager>
          <isVoDAccessEnabled>1</isVoDAccessEnabled>
          <isZwaveLockControlEnabled>true</isZwaveLockControlEnabled>
          <panelSlotNumber>sample string 6</panelSlotNumber>
          <panelUserCode>sample string 7</panelUserCode>
          <partitionAuthorization>
            <PartitionUserAuthorization>
              <AuthorityLevel>3</AuthorityLevel>
              <GlobalArm>1</GlobalArm>
              <IsAccessGranted>true</IsAccessGranted>
              <IsCommonEnabled>true</IsCommonEnabled>
              <IsFireEnabled>true</IsFireEnabled>
              <IsLocked>true</IsLocked>
              <IsStayArmed>true</IsStayArmed>
              <OpenCloseReport>1</OpenCloseReport>
              <PartitionId>1</PartitionId>
              <PartitionName>sample string 2</PartitionName>
            </PartitionUserAuthorization>
            <PartitionUserAuthorization>
              <AuthorityLevel>3</AuthorityLevel>
              <GlobalArm>1</GlobalArm>
              <IsAccessGranted>true</IsAccessGranted>
              <IsCommonEnabled>true</IsCommonEnabled>
              <IsFireEnabled>true</IsFireEnabled>
              <IsLocked>true</IsLocked>
              <IsStayArmed>true</IsStayArmed>
              <OpenCloseReport>1</OpenCloseReport>
              <PartitionId>1</PartitionId>
              <PartitionName>sample string 2</PartitionName>
            </PartitionUserAuthorization>
          </partitionAuthorization>
          <partitionNumber>1</partitionNumber>
          <prerequisiteDeviceClassID>13</prerequisiteDeviceClassID>
          <prerequisiteDeviceID>12</prerequisiteDeviceID>
          <previousUserCode>sample string 8</previousUserCode>
          <sync>sample string 11</sync>
          <userCodeLength>9</userCodeLength>
          <userCodeLengthChanged>10</userCodeLengthChanged>
        </DeviceUserAuthorization>
        <DeviceUserAuthorization>
          <deviceAuthorizationAttributes>
            <DeviceAttribute>
              <name>sample string 1</name>
              <value>sample string 2</value>
            </DeviceAttribute>
            <DeviceAttribute>
              <name>sample string 1</name>
              <value>sample string 2</value>
            </DeviceAttribute>
          </deviceAuthorizationAttributes>
          <deviceClassID>3</deviceClassID>
          <deviceID>1</deviceID>
          <deviceName>sample string 2</deviceName>
          <deviceSerialNumber>sample string 4</deviceSerialNumber>
          <deviceTypeID>14</deviceTypeID>
          <fireAuthorityEnabled>19</fireAuthorityEnabled>
          <isAccessGranted>true</isAccessGranted>
          <isDisarmOnZwaveUnLockEnabled>true</isDisarmOnZwaveUnLockEnabled>
          <isDuplicateUserCode>true</isDuplicateUserCode>
          <isFireAuthoritySupported>true</isFireAuthoritySupported>
          <isPartitionManager>true</isPartitionManager>
          <isVoDAccessEnabled>1</isVoDAccessEnabled>
          <isZwaveLockControlEnabled>true</isZwaveLockControlEnabled>
          <panelSlotNumber>sample string 6</panelSlotNumber>
          <panelUserCode>sample string 7</panelUserCode>
          <partitionAuthorization>
            <PartitionUserAuthorization>
              <AuthorityLevel>3</AuthorityLevel>
              <GlobalArm>1</GlobalArm>
              <IsAccessGranted>true</IsAccessGranted>
              <IsCommonEnabled>true</IsCommonEnabled>
              <IsFireEnabled>true</IsFireEnabled>
              <IsLocked>true</IsLocked>
              <IsStayArmed>true</IsStayArmed>
              <OpenCloseReport>1</OpenCloseReport>
              <PartitionId>1</PartitionId>
              <PartitionName>sample string 2</PartitionName>
            </PartitionUserAuthorization>
            <PartitionUserAuthorization>
              <AuthorityLevel>3</AuthorityLevel>
              <GlobalArm>1</GlobalArm>
              <IsAccessGranted>true</IsAccessGranted>
              <IsCommonEnabled>true</IsCommonEnabled>
              <IsFireEnabled>true</IsFireEnabled>
              <IsLocked>true</IsLocked>
              <IsStayArmed>true</IsStayArmed>
              <OpenCloseReport>1</OpenCloseReport>
              <PartitionId>1</PartitionId>
              <PartitionName>sample string 2</PartitionName>
            </PartitionUserAuthorization>
          </partitionAuthorization>
          <partitionNumber>1</partitionNumber>
          <prerequisiteDeviceClassID>13</prerequisiteDeviceClassID>
          <prerequisiteDeviceID>12</prerequisiteDeviceID>
          <previousUserCode>sample string 8</previousUserCode>
          <sync>sample string 11</sync>
          <userCodeLength>9</userCodeLength>
          <userCodeLengthChanged>10</userCodeLengthChanged>
        </DeviceUserAuthorization>
      </deviceList>
      <locationID>1</locationID>
      <locationName>sample string 2</locationName>
      <photoURL>sample string 3</photoURL>
    </LocationUserAuthorization>
  </Locations>
  <UserId>1</UserId>
</MultiLocationUserDetails>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MultiLocationUserValidationResult
NameDescriptionTypeAdditional information
IsDuplicate

boolean

None.

Locations

LocationList

None.

Response Formats

application/json, text/json

Sample:
{
  "Locations": {
    "LocationInfo": [
      {
        "LocationID": 1,
        "LocationName": "sample string 2"
      },
      {
        "LocationID": 1,
        "LocationName": "sample string 2"
      }
    ]
  },
  "IsDuplicate": true
}

application/xml, text/xml

Sample:
<MultiLocationUserValidationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.UserConfiguration">
  <Locations xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Shared">
    <d2p1:LocationInfo>
      <d2p1:LocationInformation>
        <d2p1:LocationID>1</d2p1:LocationID>
        <d2p1:LocationName>sample string 2</d2p1:LocationName>
      </d2p1:LocationInformation>
      <d2p1:LocationInformation>
        <d2p1:LocationID>1</d2p1:LocationID>
        <d2p1:LocationName>sample string 2</d2p1:LocationName>
      </d2p1:LocationInformation>
    </d2p1:LocationInfo>
  </Locations>
</MultiLocationUserValidationResult>