Display Groups

POST /Account/Read/Group
Authorization key & Authorization date & Authorization hmac

This process returns the display group availble for this customer number. Secret Hmac Required. Cache Time 1 Hour.

Body

  • ShowAll number

    If set, all display groups that this customer number can access are returned. Otherwise the primary display group for this customer is returned.

Responses

  • 200

    Display Group Information successfully returned

    Hide response attributes Show response attributes array[object]
    • GroupId number

      the display group id

    • GroupName string

      the Group Name assigned by your administrator

    • Parent number

      Parent User Number

    • Hierarchy array[string]

      display group hierarchy list

    • CopyId string

      if this display group is a copy of another one using a different hierarchy

    • PageCount number

      the number of pages assigned to this display group

    • UserCount number

      the number of users assigned to this display group

    • LocCount number

      the number of subscription locations assigned to this display group
POST /Account/Read/Group 
curl \
 -X POST https://Api.StrandVision.com/v1.0/Account/Read/Group \
 -H "Authorization: X-apikey $ACCESS_TOKEN" \
 -H "Authorization: X-apidate $ACCESS_TOKEN" \
 -H "Authorization: X-apihmac $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"ShowAll":1}'
Request example 
{
  "ShowAll": 1
}
Request examples 
{
  "ShowAll": 1
}
Response examples (200) 
[
  {
    "GroupId": 9,
    "GroupName": "All of StrandVision Digital Signage",
    "Parent": 10028,
    "Hierarchy": [
      "All of StrandVision Digital Signage (9)"
    ],
    "CopyId": "None (0)",
    "PageCount": 8,
    "UserCount": 2,
    "LocCount": 0
  },
  {
    "GroupId": 14030,
    "GroupName": "U.S.A",
    "Parent": 10028,
    "Hierarchy": [
      "All of StrandVision Digital Signage (9)",
      "U.S.A (14030)"
    ],
    "CopyId": "None (0)",
    "PageCount": 0,
    "UserCount": 2,
    "LocCount": 0
  },
  {
    "GroupId": 14031,
    "GroupName": "East Coast",
    "Parent": 10028,
    "Hierarchy": [
      "All of StrandVision Digital Signage (9)",
      "U.S.A (14030)",
      "East Coast (14031)"
    ],
    "CopyId": "None (0)",
    "PageCount": 0,
    "UserCount": 0,
    "LocCount": 0
  },
  {
    "GroupId": 10,
    "GroupName": "Altoona, WI",
    "Parent": 10028,
    "Hierarchy": [
      "All of StrandVision Digital Signage (9)",
      "U.S.A (14030)",
      "East Coast (14031)",
      "Altoona, WI (10)"
    ],
    "CopyId": "None (0)",
    "PageCount": 36,
    "UserCount": 1,
    "LocCount": 1
  },
  {
    "GroupId": 14032,
    "GroupName": "West Coast",
    "Parent": 10028,
    "Hierarchy": [
      "All of StrandVision Digital Signage (9)",
      "U.S.A (14030)",
      "West Coast (14032)"
    ],
    "CopyId": "None (0)",
    "PageCount": 0,
    "UserCount": 0,
    "LocCount": 0
  }
]
Response examples (200) 
[
  {
    "GroupId": 9,
    "GroupName": "All of StrandVision Digital Signage",
    "Parent": 10028,
    "Hierarchy": [
      "All of StrandVision Digital Signage (9)"
    ],
    "CopyId": "None (0)",
    "PageCount": 68,
    "UserCount": 2,
    "LocCount": 0
  }
]