GET /service/api/console/gsm/{gsmKey}/lookupsite/{siteKeycode}

Looks up information about a specific GSM site which is associated with a given site keycode. You can use this method to query site details using a site keycode and to retrieve the site's identifier for follow-up calls.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

siteKeycode

The site keycode to look up.

string

Required

Body Parameters

None.

Response Information

Resource Description

Information about the desired GSM site.

GetGSMSitesResponseModel
NameDescriptionTypeAdditional Information
TotalSeatsAllowed

The total number of Parent Keycode Site Seats/devices purchased.

integer

None.

ParentDescription

Indicates if parent key is a "Full" or "Trial" license.

string

None.

SumTotalDevices

The total number of Active Devices installed on the GSM sites.

integer

None.

SumTotalDevicesAllowed

The total number of Site Seats allocated to all GSM sites.

integer

None.

SumTotalDevicesNotTrial

The total number of Site Seats allocated to all GSM sites which are not trial sites.

integer

None.

SumTotalMobileDevicesAllowed

The total number of mobile Site Seats allocated to the GSM sites.

integer

None.

TotalCount

The total number of sites under the GSM.

integer

None.

Sites

List of site details records.

Collection of GetGSMSitesResponseModel_Site

None.

Sample Response

{
  "TotalSeatsAllowed": 250,
  "ParentDescription": "Full",
  "SumTotalDevices": 57,
  "SumTotalDevicesAllowed": 200,
  "SumTotalDevicesNotTrial": 200,
  "SumTotalMobileDevicesAllowed": 50,
  "TotalCount": 1,
  "Sites": [
    {
      "SiteId": "920b5cac-9a72-418a-9c79-43712daaeeb7",
      "SiteName": "Site 1",
      "SiteType": "R",
      "TotalEndpoints": 24,
      "PCsInfected24": 0,
      "AccountKeyCode": "7CA9-39E1-1307-47C4-8B40",
      "DevicesAllowed": 100,
      "MobileSeats": 5,
      "Deactivated": false,
      "Suspended": false,
      "EndDate": "2020-03-19T04:45:53.3501509Z",
      "Device": true,
      "Infect": false,
      "BillingCycle": "Anually",
      "BillingDate": "Jan 01",
      "CompanyComments": "",
      "DeactivatedBy": null,
      "SuspendedBy": null,
      "CreatedBy": "test@webroot.com",
      "GlobalPolicies": true,
      "GlobalOverrides": true,
      "GlobalAlerts": true,
      "AllKeysExpired": false,
      "Description": "Full",
      "PolicyId": "1f1acc93-8929-40bc-a0b4-533c40f35aa9",
      "PolicyName": "Test policy",
      "PolicyDescription": "Sample policy for testing",
      "Emails": "test@webroot.com",
      "AccessLevel": 128,
      "Modules": [
        {
          "Type": "DNSP",
          "LicenseType": "Trial",
          "EndDate": "2020-03-19T04:45:53.3501509Z"
        },
        {
          "Type": "WSAT",
          "LicenseType": "Trial",
          "EndDate": "2020-03-19T04:45:53.3501509Z"
        }
      ]
    }
  ]
}                    
<GetGSMSitesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <ParentDescription>Full</ParentDescription>
  <Sites>
    <GetGSMSitesResponseModel_Site>
      <AccessLevel>128</AccessLevel>
      <AccountKeyCode>7CA9-39E1-1307-47C4-8B40</AccountKeyCode>
      <AllKeysExpired>false</AllKeysExpired>
      <BillingCycle>Anually</BillingCycle>
      <BillingDate>Jan 01</BillingDate>
      <CompanyComments></CompanyComments>
      <CreatedBy>test@webroot.com</CreatedBy>
      <Deactivated>false</Deactivated>
      <DeactivatedBy i:nil="true" />
      <Description>Full</Description>
      <Device>true</Device>
      <DevicesAllowed>100</DevicesAllowed>
      <Emails>test@webroot.com</Emails>
      <EndDate>2020-03-19T04:45:53.3501509Z</EndDate>
      <GlobalAlerts>true</GlobalAlerts>
      <GlobalOverrides>true</GlobalOverrides>
      <GlobalPolicies>true</GlobalPolicies>
      <Infect>false</Infect>
      <MobileSeats>5</MobileSeats>
      <Modules>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2020-03-19T04:45:53.3501509Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <Type>DNSP</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2020-03-19T04:45:53.3501509Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <Type>WSAT</Type>
        </GetGSMSitesResponseModel_Module>
      </Modules>
      <PCsInfected24>0</PCsInfected24>
      <PolicyDescription>Sample policy for testing</PolicyDescription>
      <PolicyId>1f1acc93-8929-40bc-a0b4-533c40f35aa9</PolicyId>
      <PolicyName>Test policy</PolicyName>
      <SiteId>920b5cac-9a72-418a-9c79-43712daaeeb7</SiteId>
      <SiteName>Site 1</SiteName>
      <SiteType>R</SiteType>
      <Suspended>false</Suspended>
      <SuspendedBy i:nil="true" />
      <TotalEndpoints>24</TotalEndpoints>
    </GetGSMSitesResponseModel_Site>
  </Sites>
  <SumTotalDevices>57</SumTotalDevices>
  <SumTotalDevicesAllowed>200</SumTotalDevicesAllowed>
  <SumTotalDevicesNotTrial>200</SumTotalDevicesNotTrial>
  <SumTotalMobileDevicesAllowed>50</SumTotalMobileDevicesAllowed>
  <TotalCount>1</TotalCount>
  <TotalSeatsAllowed>250</TotalSeatsAllowed>
</GetGSMSitesResponseModel>