Description

Get all profile groups you can give a user access over

Parameters

Name Type Required Optional Searchable Note
siteid numeric REQUIRED, Passed via URI
groupname string via search string

Examples

Example Request

http://devsandbox.targetsolutions.com/v1/sites/{siteid}/access/groups

Example Request with Search String

http://devsandbox.targetsolutions.com/v1/sites/{siteid}/access/groups?q={"groupname":"random groupname"}

Example Header

GET /sites/{siteid}/access/groups HTTP/1.1
Host: http://devsandbox.targetsolutions.com/v1
AccessToken: 2n/23RxPBVqE+Kp3dfxE0Q==
Cache-Control: no-cache

Possible Results Sets

Results Set

{
  "groups":[
    {
      "links":{
        "users":"http://devsandbox.targetsolutions.com/v1/sites/12/access/groups/307686/users",
        "resourcelink":"http://devsandbox.targetsolutions.com/v1/sites/12/access/groups/307686"
      },
      "usercount":0,
      "groupid":307686,
      "siteid":12,
      "accessusercount":0,
      "categoryid":5467,
      "groupname":" Dave PUT Test"
    }
  ],
  "pagination":{
    "next":"http://devsandbox.targetsolutions.com/v1/sites/12/access/groups?startrow=2&limit=1"
  }
}

No Results Set

{
  "httpcode":200,
  "moreinfo":"http://developers.targetsolutions.com/v1/responsecodes/901",
  "developermessage":"The request returned zero results.",
  "statuscode":901,
  "status":"ok"
}

Access Denied Set

{
  "httpcode":401,
  "moreinfo":"http://developers.targetsolutions.com/v1/responsecodes/800",
  "developermessage":"A request was made to a resource that you do not have ownership of.",
  "statuscode":800,
  "status":"access denied"
}