Description

Get all profile categories in a site

Parameters

Name Type Required Optional Searchable Note
siteid numeric REQUIRED, Passed via URI
categoryname string via search string
before datetime via search string
after datetime via search string

Examples

Example Request

http://devsandbox.targetsolutions.com/v1/sites/{siteid}/categories/profile

Example Request with Search String

http://devsandbox.targetsolutions.com/v1/sites/{siteid}/categories/profile?q={"categoryname":"random categoryname","before":"random before","after":"random after"}

Example Header

GET /sites/{siteid}/categories/profile HTTP/1.1
Host: http://devsandbox.targetsolutions.com/v1
AccessToken: GDjsmcPX3zOQrUMFQtBrog==
Cache-Control: no-cache

Possible Results Sets

Results Set

{
  "profilecategories":[
    {
      "links":[
        {
          "resourcelink":"http://devsandbox.targetsolutions.com/v1/sites/12/categories/profile/5467",
          "groups":"http://devsandbox.targetsolutions.com/v1/sites/12/categories/profile/5467/groups"
        }
      ],
      "siteid":12,
      "categoryid":5467,
      "categoryname":"Category Test 2",
      "groupcount":5
    }
  ],
  "pagination":{
    "next":"http://devsandbox.targetsolutions.com/v1/sites/12/categories/profile?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"
}