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

Gets information about a given GSM console.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

Body Parameters

None.

Response Information

Resource Description

Information about a given GSM console.

GetGSMDetailsResponseModel
NameDescriptionTypeAdditional Information
GSMConsoleName

The name of the GSM console.

string

None.

CreatedDate

The date when the GSM key has been created.

date

None.

EndDate

The date when the GSM key expires.

date

None.

RemainingDays

The number of days until the GSM key expires.

integer

None.

LicenseType

The license type of the GSM key: Full or Trial.

string

None.

TotalSeatsAllowed

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

integer

None.

TotalSites

The total number of sites.

integer

None.

DeactivatedSites

The number of deactivated sites.

integer

None.

CompanyEmail

The company's email address.

string

None.

CompanyPhone

The company's phone number.

string

None.

CompanyAddress

The company's address.

string

None.

Modules

The list of modules associated with the GSM key.

Collection of GetGSMDetailsResponseModel_Module

None.

Sample Response

{
  "GSMConsoleName": "GSM Test Console",
  "CreatedDate": "2019-04-19T04:32:11.1359374Z",
  "EndDate": "2020-09-19T04:32:11.1359374Z",
  "RemainingDays": 153,
  "LicenseType": "Full",
  "TotalSeatsAllowed": 800,
  "TotalSites": 500,
  "DeactivatedSites": 14,
  "CompanyEmail": "test1@webroot.com",
  "CompanyPhone": "07194745",
  "CompanyAddress": "",
  "Modules": [
    {
      "Type": "DNSP",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2020-09-19T04:32:11.1359374Z"
    },
    {
      "Type": "WSAT",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2020-09-19T04:32:11.1359374Z"
    }
  ]
}                    
<GetGSMDetailsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <CompanyAddress></CompanyAddress>
  <CompanyEmail>test1@webroot.com</CompanyEmail>
  <CompanyPhone>07194745</CompanyPhone>
  <CreatedDate>2019-04-19T04:32:11.1359374Z</CreatedDate>
  <DeactivatedSites>14</DeactivatedSites>
  <EndDate>2020-09-19T04:32:11.1359374Z</EndDate>
  <GSMConsoleName>GSM Test Console</GSMConsoleName>
  <LicenseType>Full</LicenseType>
  <Modules>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2020-09-19T04:32:11.1359374Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>DNSP</Type>
    </GetGSMDetailsResponseModel_Module>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2020-09-19T04:32:11.1359374Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>WSAT</Type>
    </GetGSMDetailsResponseModel_Module>
  </Modules>
  <RemainingDays>153</RemainingDays>
  <TotalSeatsAllowed>800</TotalSeatsAllowed>
  <TotalSites>500</TotalSites>
</GetGSMDetailsResponseModel>