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

Name	Description	Type	Additional 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",
          "deviceVariant": "sample string 3",
          "deviceClassID": 4,
          "deviceSerialNumber": "sample string 5",
          "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 7",
          "panelUserCode": "sample string 8",
          "previousUserCode": "sample string 9",
          "userCodeLength": 10,
          "userCodeLengthChanged": 11,
          "sync": "sample string 12",
          "deviceAuthorizationAttributes": [
            {
              "name": "sample string 1",
              "value": "sample string 2"
            },
            {
              "name": "sample string 1",
              "value": "sample string 2"
            }
          ],
          "prerequisiteDeviceID": 13,
          "prerequisiteDeviceClassID": 14,
          "deviceTypeID": 15,
          "isDuplicateUserCode": true,
          "isPartitionManager": true,
          "isZwaveLockControlEnabled": true,
          "isDisarmOnZwaveUnLockEnabled": true,
          "isVoDAccessEnabled": 1,
          "partitionNumber": 1,
          "fireAuthorityEnabled": 20,
          "isFireAuthoritySupported": true
        },
        {
          "deviceID": 1,
          "deviceName": "sample string 2",
          "deviceVariant": "sample string 3",
          "deviceClassID": 4,
          "deviceSerialNumber": "sample string 5",
          "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 7",
          "panelUserCode": "sample string 8",
          "previousUserCode": "sample string 9",
          "userCodeLength": 10,
          "userCodeLengthChanged": 11,
          "sync": "sample string 12",
          "deviceAuthorizationAttributes": [
            {
              "name": "sample string 1",
              "value": "sample string 2"
            },
            {
              "name": "sample string 1",
              "value": "sample string 2"
            }
          ],
          "prerequisiteDeviceID": 13,
          "prerequisiteDeviceClassID": 14,
          "deviceTypeID": 15,
          "isDuplicateUserCode": true,
          "isPartitionManager": true,
          "isZwaveLockControlEnabled": true,
          "isDisarmOnZwaveUnLockEnabled": true,
          "isVoDAccessEnabled": 1,
          "partitionNumber": 1,
          "fireAuthorityEnabled": 20,
          "isFireAuthoritySupported": true
        }
      ],
      "photoURL": "sample string 3"
    },
    {
      "locationID": 1,
      "locationName": "sample string 2",
      "deviceList": [
        {
          "deviceID": 1,
          "deviceName": "sample string 2",
          "deviceVariant": "sample string 3",
          "deviceClassID": 4,
          "deviceSerialNumber": "sample string 5",
          "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 7",
          "panelUserCode": "sample string 8",
          "previousUserCode": "sample string 9",
          "userCodeLength": 10,
          "userCodeLengthChanged": 11,
          "sync": "sample string 12",
          "deviceAuthorizationAttributes": [
            {
              "name": "sample string 1",
              "value": "sample string 2"
            },
            {
              "name": "sample string 1",
              "value": "sample string 2"
            }
          ],
          "prerequisiteDeviceID": 13,
          "prerequisiteDeviceClassID": 14,
          "deviceTypeID": 15,
          "isDuplicateUserCode": true,
          "isPartitionManager": true,
          "isZwaveLockControlEnabled": true,
          "isDisarmOnZwaveUnLockEnabled": true,
          "isVoDAccessEnabled": 1,
          "partitionNumber": 1,
          "fireAuthorityEnabled": 20,
          "isFireAuthoritySupported": true
        },
        {
          "deviceID": 1,
          "deviceName": "sample string 2",
          "deviceVariant": "sample string 3",
          "deviceClassID": 4,
          "deviceSerialNumber": "sample string 5",
          "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 7",
          "panelUserCode": "sample string 8",
          "previousUserCode": "sample string 9",
          "userCodeLength": 10,
          "userCodeLengthChanged": 11,
          "sync": "sample string 12",
          "deviceAuthorizationAttributes": [
            {
              "name": "sample string 1",
              "value": "sample string 2"
            },
            {
              "name": "sample string 1",
              "value": "sample string 2"
            }
          ],
          "prerequisiteDeviceID": 13,
          "prerequisiteDeviceClassID": 14,
          "deviceTypeID": 15,
          "isDuplicateUserCode": true,
          "isPartitionManager": true,
          "isZwaveLockControlEnabled": true,
          "isDisarmOnZwaveUnLockEnabled": true,
          "isVoDAccessEnabled": 1,
          "partitionNumber": 1,
          "fireAuthorityEnabled": 20,
          "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>4</deviceClassID>
          <deviceID>1</deviceID>
          <deviceName>sample string 2</deviceName>
          <deviceSerialNumber>sample string 5</deviceSerialNumber>
          <deviceTypeID>15</deviceTypeID>
          <deviceVariant>sample string 3</deviceVariant>
          <fireAuthorityEnabled>20</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 7</panelSlotNumber>
          <panelUserCode>sample string 8</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>14</prerequisiteDeviceClassID>
          <prerequisiteDeviceID>13</prerequisiteDeviceID>
          <previousUserCode>sample string 9</previousUserCode>
          <sync>sample string 12</sync>
          <userCodeLength>10</userCodeLength>
          <userCodeLengthChanged>11</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>4</deviceClassID>
          <deviceID>1</deviceID>
          <deviceName>sample string 2</deviceName>
          <deviceSerialNumber>sample string 5</deviceSerialNumber>
          <deviceTypeID>15</deviceTypeID>
          <deviceVariant>sample string 3</deviceVariant>
          <fireAuthorityEnabled>20</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 7</panelSlotNumber>
          <panelUserCode>sample string 8</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>14</prerequisiteDeviceClassID>
          <prerequisiteDeviceID>13</prerequisiteDeviceID>
          <previousUserCode>sample string 9</previousUserCode>
          <sync>sample string 12</sync>
          <userCodeLength>10</userCodeLength>
          <userCodeLengthChanged>11</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>4</deviceClassID>
          <deviceID>1</deviceID>
          <deviceName>sample string 2</deviceName>
          <deviceSerialNumber>sample string 5</deviceSerialNumber>
          <deviceTypeID>15</deviceTypeID>
          <deviceVariant>sample string 3</deviceVariant>
          <fireAuthorityEnabled>20</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 7</panelSlotNumber>
          <panelUserCode>sample string 8</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>14</prerequisiteDeviceClassID>
          <prerequisiteDeviceID>13</prerequisiteDeviceID>
          <previousUserCode>sample string 9</previousUserCode>
          <sync>sample string 12</sync>
          <userCodeLength>10</userCodeLength>
          <userCodeLengthChanged>11</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>4</deviceClassID>
          <deviceID>1</deviceID>
          <deviceName>sample string 2</deviceName>
          <deviceSerialNumber>sample string 5</deviceSerialNumber>
          <deviceTypeID>15</deviceTypeID>
          <deviceVariant>sample string 3</deviceVariant>
          <fireAuthorityEnabled>20</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 7</panelSlotNumber>
          <panelUserCode>sample string 8</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>14</prerequisiteDeviceClassID>
          <prerequisiteDeviceID>13</prerequisiteDeviceID>
          <previousUserCode>sample string 9</previousUserCode>
          <sync>sample string 12</sync>
          <userCodeLength>10</userCodeLength>
          <userCodeLengthChanged>11</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

Name	Description	Type	Additional 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>