Documentation

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/policies/{policyId}

Gets information about a site policy.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required
siteId	The site identifier.	string	Required
policyId	The identifier of the policy to query information for.	string	Required

Body Parameters

None.

Response Information

Resource Description

Information about the desired site policy.

GetGSMSitePoliciesResponseModel

Name	Description	Type	Additional Information
TotalCount	Total number of policies available.	integer	None.
Deleted	Value (true/false) indicating whether any policy has been deleted.	boolean	None.
Policies	List of policy details records.	Collection of GetGSMSitePoliciesResponseModel_Policy	None.

{
  "TotalCount": 1,
  "Deleted": false,
  "Policies": [
    {
      "PolicyId": "4f63a72e-038b-49d3-82df-5e5bcde1a833",
      "DateCreated": "2019-07-19T04:48:27.8281257Z",
      "PolicyName": "Test Policy 1",
      "LivePolicy": true,
      "PendingPolicy": false,
      "PolicyDescription": "Description of test policy 1",
      "Deleted": false,
      "Canned": false,
      "DefaultSetting": false,
      "GlobalPolicy": false,
      "PolicyType": "Advanced"
    }
  ]
}

<GetGSMSitePoliciesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Deleted>false</Deleted>
  <Policies>
    <GetGSMSitePoliciesResponseModel_Policy>
      <Canned>false</Canned>
      <DateCreated>2019-07-19T04:48:27.8281257Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <GlobalPolicy>false</GlobalPolicy>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>4f63a72e-038b-49d3-82df-5e5bcde1a833</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMSitePoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>1</TotalCount>
</GetGSMSitePoliciesResponseModel>