Description

Get all features a user has access to

Parameters

Name Type Required Optional Searchable Note
userid numeric REQUIRED, Passed via URI
functionname string via search string
modulename string via search string

Examples

Example Request

https://devsandbox.targetsolutions.com/v1/users/{userid}/access/modules

Example Request with Search String

https://devsandbox.targetsolutions.com/v1/users/{userid}/access/modules?q={"functionname":"random functionname","modulename":"random modulename"}

Example Header

GET /users/{userid}/access/modules HTTP/1.1
Host: https://devsandbox.targetsolutions.com/v1
AccessToken: MpECs9QBfEkGphMcVEOwxw==
Cache-Control: no-cache

Possible Results Sets

Results Set

{
  "modules":[
    {
      "links":{
        "users":"https://devsandbox.targetsolutions.com/v1/sites/20629/access/modules/38/users/",
        "resourcelink":"https://devsandbox.targetsolutions.com/v1/sites/20629/access/modules/38"
      },
      "accessID":38,
      "moduleName":"Activities Builder",
      "functionName":"Activities Builder"
    },
    {
      "links":{
        "users":"https://devsandbox.targetsolutions.com/v1/sites/20629/access/modules/16/users/",
        "resourcelink":"https://devsandbox.targetsolutions.com/v1/sites/20629/access/modules/16"
      },
      "accessID":16,
      "moduleName":"Assignments",
      "functionName":"Create New Assignments"
    }
  ]

No Results Set

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

Access Denied Set

{
  "httpcode":401,
  "moreinfo":"https://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"
}