GET api/v3/locations/{locationId}/locationInfo

Returns the data associated with a Location object from the database EQUIVALENT SOAP API : GetLocation by location ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

Location ID

 integer

Required

Body Parameters

None.

Response Information

Resource Description

LocationDetailByLocIDResult

LocationResult
NameDescriptionTypeAdditional information
LocationInfo

LocationInfo

None.
ResultCode

integer

None.
ResultData

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "LocationInfo": {
    "Image": "QEA=",
    "ContentServiceLevelID": 1,
    "DoorBellServiceLevelID": 2,
    "DealerPushMessageRemainingCount": 3,
    "AdvertisingServiceLevelID": 4,
    "LatestMessageDate": "2025-04-24T03:42:33.4643512-04:00",
    "ISNewSkyBellAccount": true,
    "ISDaylightSavingTime": true,
    "VideoServiceLevelID": 8,
    "GarageDoorServiceLevelID": 9,
    "MotionViewerServiceLevelID": 10,
    "OutboundServiceLevelID": 11,
    "ISOccupied": true,
    "ISCoBrandingEnabled": true,
    "IsSMSNotificationEnabled": true,
    "IsPushNotificationEnabled": true,
    "IsEmailNotificationEnabled": true,
    "MonitoringTypeID": 1,
    "IsRemoteNetworkSetup": 1,
    "IsRental": true,
    "PackageId": 14,
    "IsAVCEnabled": true,
    "DataApiServiceLevelID": 16,
    "PartnerDataURLList": {
      "PartnerDataURL": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "IsBLEdisarmEnabled": true,
    "IsVAVEnabled": true,
    "LocationId": 19,
    "LocationName": "sample string 20",
    "AccountId": 21,
    "PhotoId": 22,
    "TimeZoneId": 23,
    "PhotoURL": "sample string 24",
    "SetDefaultLocationName": true,
    "SecuritySystemAlias": "sample string 26",
    "SecuritySystemPanelDeviceID": 27,
    "CountryID": 28,
    "StreetNumber": "sample string 29",
    "StreetName": "sample string 30",
    "City": "sample string 31",
    "StateID": 32,
    "PostalCode": "sample string 33",
    "TemperatureUnits": "sample string 34",
    "Latitude": "sample string 35",
    "Longitude": "sample string 36"
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample: 
<LocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <LocationInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain">
    <d2p1:AccountId>21</d2p1:AccountId>
    <d2p1:City>sample string 31</d2p1:City>
    <d2p1:CountryID>28</d2p1:CountryID>
    <d2p1:Latitude>sample string 35</d2p1:Latitude>
    <d2p1:LocationId>19</d2p1:LocationId>
    <d2p1:LocationName>sample string 20</d2p1:LocationName>
    <d2p1:Longitude>sample string 36</d2p1:Longitude>
    <d2p1:PhotoId>22</d2p1:PhotoId>
    <d2p1:PhotoURL>sample string 24</d2p1:PhotoURL>
    <d2p1:PostalCode>sample string 33</d2p1:PostalCode>
    <d2p1:SecuritySystemAlias>sample string 26</d2p1:SecuritySystemAlias>
    <d2p1:SecuritySystemPanelDeviceID>27</d2p1:SecuritySystemPanelDeviceID>
    <d2p1:SetDefaultLocationName>true</d2p1:SetDefaultLocationName>
    <d2p1:StateID>32</d2p1:StateID>
    <d2p1:StreetName>sample string 30</d2p1:StreetName>
    <d2p1:StreetNumber>sample string 29</d2p1:StreetNumber>
    <d2p1:TemperatureUnits>sample string 34</d2p1:TemperatureUnits>
    <d2p1:TimeZoneId>23</d2p1:TimeZoneId>
    <d2p1:AdvertisingServiceLevelID>4</d2p1:AdvertisingServiceLevelID>
    <d2p1:ContentServiceLevelID>1</d2p1:ContentServiceLevelID>
    <d2p1:DataApiServiceLevelID>16</d2p1:DataApiServiceLevelID>
    <d2p1:DealerPushMessageRemainingCount>3</d2p1:DealerPushMessageRemainingCount>
    <d2p1:DoorBellServiceLevelID>2</d2p1:DoorBellServiceLevelID>
    <d2p1:GarageDoorServiceLevelID>9</d2p1:GarageDoorServiceLevelID>
    <d2p1:ISCoBrandingEnabled>true</d2p1:ISCoBrandingEnabled>
    <d2p1:ISDaylightSavingTime>true</d2p1:ISDaylightSavingTime>
    <d2p1:ISNewSkyBellAccount>true</d2p1:ISNewSkyBellAccount>
    <d2p1:ISOccupied>true</d2p1:ISOccupied>
    <d2p1:Image>QEA=</d2p1:Image>
    <d2p1:IsAVCEnabled>true</d2p1:IsAVCEnabled>
    <d2p1:IsBLEdisarmEnabled>true</d2p1:IsBLEdisarmEnabled>
    <d2p1:IsEmailNotificationEnabled>true</d2p1:IsEmailNotificationEnabled>
    <d2p1:IsPushNotificationEnabled>true</d2p1:IsPushNotificationEnabled>
    <d2p1:IsRemoteNetworkSetup>1</d2p1:IsRemoteNetworkSetup>
    <d2p1:IsRental>true</d2p1:IsRental>
    <d2p1:IsSMSNotificationEnabled>true</d2p1:IsSMSNotificationEnabled>
    <d2p1:IsVAVEnabled>true</d2p1:IsVAVEnabled>
    <d2p1:LatestMessageDate>2025-04-24T03:42:33.4643512-04:00</d2p1:LatestMessageDate>
    <d2p1:MonitoringTypeID>1</d2p1:MonitoringTypeID>
    <d2p1:MotionViewerServiceLevelID>10</d2p1:MotionViewerServiceLevelID>
    <d2p1:OutboundServiceLevelID>11</d2p1:OutboundServiceLevelID>
    <d2p1:PackageId>14</d2p1:PackageId>
    <d2p1:PartnerDataURLList>
      <d2p1:PartnerDataURL xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:PartnerDataURL>
    </d2p1:PartnerDataURLList>
    <d2p1:VideoServiceLevelID>8</d2p1:VideoServiceLevelID>
  </LocationInfo>
</LocationResult>