Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Latest commit

 

History

History
204 lines (172 loc) · 3.73 KB

sites.md

File metadata and controls

204 lines (172 loc) · 3.73 KB

The list of all sites available via the WCMS site

GET /resources/sites.{format}

Description

This method returns a list of all the sites available from the UWaterloo WCMS site

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1523 Enabled Yes
Service Name resources Service ID 229
Information Steward SSO Data Type Direct feed
Update Frequency As new sites are created by the WCMS team Cache Time 0 seconds

Notes

  • Usage won't increase if there is no data returned
  • Any value can be null

Sources

Parameters

GET /resources/sites.{format}
Parameter Type Required Description
key filter yes Your API key
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /resources/sites.{format}

Response

Field Name Type Value Description
name string Official name of WCMS site
slug string URL Slug (part of a URL identifying the page using human-readable keywords)
url string Complete Link to WCMS site
group_code string Unit's parent group
unit_code string Organizational Unit code
unit_short_name string Organizational Units short name
owner_type string

Any value can be null

Output

JSON

{
  "meta": {
    "requests": 1330,
    "timestamp": 1476569686,
    "status": 200,
    "message": "Request successful",
    "method_id": 1523,
    "method": {
      
    }
  },
  "data": [
    {
      "name": "3D Print Centre",
      "slug": "3d-print-centre",
      "url": "https://uwaterloo.ca/3d-print-centre",
      "group_code": "ENG",
      "unit_code": "ENG",
      "unit_short_name": "Engineering",
      "owner_type": "service-it"
    },
    {
      "name": "About Waterloo",
      "slug": "about",
      "url": "https://uwaterloo.ca/about",
      "group_code": null,
      "unit_code": "VP-UREL",
      "unit_short_name": "Vice-President University Relations",
      "owner_type": null
    },
    {
      "name": "Academic Integrity",
      "slug": "academic-integrity",
      "url": "https://uwaterloo.ca/academic-integrity",
      "group_code": null,
      "unit_code": "AP-RESO",
      "unit_short_name": "Associate Provost, Resources",
      "owner_type": "service-academic"
    }
  ]
}