Description

Get all sites

Parameters

Name Type Required Optional Searchable Note
sitename string via search string
coursename numeric via search string
resultsid numeric via search string
a_id[] string via search string

Examples

Example Request

http://devsandbox.targetsolutions.com/v1/sites

Example Request with Search String

http://devsandbox.targetsolutions.com/v1/sites?q={"sitename":"random sitename","coursename":"random coursename","resultsid":"random resultsid","a_id[]":"random a_id[]"}

Example Header

GET /sites HTTP/1.1
Host: http://devsandbox.targetsolutions.com/v1
AccessToken: 6qclRkxyxY5zDtoYKM4WFw==
Cache-Control: no-cache

Possible Results Sets

Results Set

{
  "sites":[
    {
      "links":[
        {
          "resourcelink":"http://devsandbox.targetsolutions.com/v1/sites/1414"
        },
        {
          "profilecategories":"http://devsandbox.targetsolutions.com/v1/sites/1414/categories/profile"
        },
        {
          "credentialcategories":"http://devsandbox.targetsolutions.com/v1/sites/1414/categories/credential"
        },
        {
          "credentials":"http://devsandbox.targetsolutions.com/v1/sites/1414/credentials"
        },
        {
          "users":"http://devsandbox.targetsolutions.com/v1/sites/1414/users"
        },
        {
          "access":"http://devsandbox.targetsolutions.com/v1/sites/1414/access/"
        }
      ],
      "sitename":"BCB",
      "loginpage":"https://app.targetsolutions.com/bcb",
      "siteid":1414
    }
  ],
  "pagination":{
    "next":"http://devsandbox.targetsolutions.com/v1/sites?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"
}