Description

Get all credentials in a category

Parameters

Name Type Required Optional Searchable Note
categoryid numeric REQUIRED, Passed via URI
credentialname string via search string

Examples

Example Request

http://devsandbox.targetsolutions.com/v1/sites/categories/credential/{categoryid}/credentials

Example Request with Search String

http://devsandbox.targetsolutions.com/v1/sites/categories/credential/{categoryid}/credentials?q={"credentialname":"random credentialname"}

Example Header

GET /sites/categories/credential/{categoryid}/credentials HTTP/1.1
Host: http://devsandbox.targetsolutions.com/v1
AccessToken: X1JD2nNEVoUgdvMOJBJEZg==
Cache-Control: no-cache

Possible Results Sets

Results Set

{
  "credentials":[
    {
      "requiredstartdate":0,
      "requiredexpirationdate":1,
      "credentialid":10242,
      "link":[
        {
          "assignments":"http://devsandbox.targetsolutions.com/v1/credentials/10242/assignments",
          "resourcelink":"http://devsandbox.targetsolutions.com/v1/credentials/10242"
        }
      ],
      "description":"test",
      "categoryid":3667,
      "credentialname":"ACLS",
      "categoryname":"Credentials",
      "requiredcredentialnum":1,
      "inactiveusercount":5,
      "activeusercount":5,
      "requirements":"Requires expiration date, number"
    }
  ],
  "pagination":{
    "next":"http://devsandbox.targetsolutions.com/v1/credentials?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"
}