Category Archives: Web Services

SWS v5.4.1 Released 01/25/2017

Hello SWS Users,
The SWS team has completed a number of new features that have now been deployed to production.

  • Name Search and Display
    The SWS team recently integrated the UW Preferred name into all resources within the SWS. Real world usage has enumerated the need for additional capabilities to be integrated to allow more directed usage of Preferred or Registered name based on use cases of downstream business systems.
  • Search
    For those systems who utilize SWS for student searching, both the Legal and Preferred name will now be targeted for search by default.  Use of the named_search_source query parameter may be added to target specific name types for searching. Using the values of ‘registered’ or ‘preferred’ will target specific name types. The default being to search both simultaneously.
  • Display
    For those systems who utilize SWS to display name values. By default the value that is displayed is a roll-up of Preferred or Registered name.  Use of the name name_display_source query parameter may be added to the SWS Person search to allow a downstream system to selectively use one name value or another. By default the ‘Display’ source is used. However the ability to use ‘display‘ or ‘registered‘ can be used discretely to change the default behavior to use registered over display.  It is the policy to use Preferred/Display in all cases unless needed for legal or conflicting policy requirements.
  • Online Learning Type
    A new field ‘OnlineLearningType’ has been added to the Section resource. This field will be used by the underlying SDB system to indicate the type of online learning offered. The field is currently being populated and will not be indicated for all sections.
  • Section Search by Building and Room
    A new search capability has been added to the Section Search resource. The ability to search by Building and Room have been added. Systems can request access to the Space Web Service for additional information about a specific location.
  • Section Search by SLN
    A late breaking addition to the 5.4.1 release. A new search capability has been added to the Section Search resource. Search by SLN within a given Year and Quarter is now available.


IDCardWS Release v1.2.3 on 03/01/2017

IDCard Web Service v1.2.3 was released on 03/01/2017 with the following changes:

  • Card Search Resource – The Card resource represents a UW Husky Card identity.  The RegID of the card holder is returned in the results of the search. If a card is found but is not active and no other active cards exist for the user a 410 error will be returned; if another active card is available a 302 moved will be given and the request will be redirected to the active card returning the RegID. See the client documentation here for more details.

Since the changes were all additions rather than modifications of existing elements, we kept the major version at v1.

SWS 2014 Release Plan

We wanted to give you a heads-up on some changes coming for SWS in 2014.

We are currently developing an exciting new Web API infrastructure based on Elasticsearch to deliver fast and low-latency student data. When we release this new infrastructure, targeted for late December, you will see fast, fresh responses from the section, registration, enrollment, and course resources.

In the meantime, there are various API changes we need to make in order to help get us there. These changes, summarized below, will reduce code debt and allow us to release faster.

June 3

v5.0 in evaluation environment, ready for testing. Documentation made available.

June 24

  • v5.0 released
    • New data: notices, enrollment minors, person finance
    • Xhtml contracts will change; Xhtml is no longer supported as an API in v5 (except grade roster), but will be available for browser use; applications encouraged to migrate to v5 JSON, though XML is supported.
    • No more ‘public’ resources; all access requires some kind of access token e.g. X509 certificate. We have decided to require an access token for all users so that we can better track usage and better communicate service changes.
    • A handful of other minor contract breaking changes. Mostly, we are making some of the data types more consistent across resources.
  • v4 deprecated, to be retired in December.
  • v3 retired (there are no longer any users)

Late December (Target)

  • v5 “ES” released
    • No API contract breaking changes
    • Elasticsearch search index integration for fast query for section, course, enrollment, and registration resources
    • EOS non-credit course data integration
  • v4 retired

As always, please contact us if you have questions, concerns, or ideas.

New SWS Service Level Agreement

We have published an SWS SLA.  A couple of important differences from the previous service policy documentation:

  • We will provide at least a six month notice before we retire any interface. Interfaces (v3, v4, etc) pass through different life cycle stages: in evaluation, released, deprecated, retired
  • We have also published our cache policy.

Take a look at the Service Level Agreement (SLA).

SWS Section Status by Course

We released a new build of SWS last week which adds a new resource, Section Status by Course. You can now get Add Code Requirements, Space Available, Section Status (open/closed), and more for all of the sections in a given course.

Single section:,summer,ANTH,322/A/status

All sections in a given course:,summer,ANTH,322/status

This resource requires a separate authorization from the Office of the Registrar. Write to sws-support to request access.

Last week’s deployment also included enhancements to the Degree Audit resources and numerous bug fixes. See Production Release Log for more details.

SWS Section Updates

Updated today, blogging today!

We released an update to Student Web Service this morning.  It fixes several bugs and adds attributes to the Section resource, including Final Exam information, Section Start and End dates, Institute Name, and Student Credit Hours.

SWS adds Degree Audit and Enhances Section Search

An update to the SWS web service was released on September 10th, 2012. New v5 resources have been added to allow MyPlan and other clients to request degree audits on behalf of students.  It includes updates to the section resource to now display the new fields ‘institute name’ and ‘joint sections’. Course search was modified to have an option to exclude courses that have no sections offered. The ‘search with no quarter’ option in section search was updated so that it can now filter based on the delete flag field in order to show active, withdrawn or suspended sections. Numerous other bug fixes have also been incorporated into this release.

More information is available on the SWS client wiki.

Space Web Service 1.0 has been released

The product of a joint project between UWIT and OPB, this new REST Space Web Service provides near real-time, authoritative data about University facilities and rooms. The data are currently sourced from the Space Inventory Management System (SIMS) and the standard UW Business Web Service formats are available (XML, JSON, XHTML).

Please see the online documentation for information about the API, support policy, and how to get access.

Think about the mashable possibilities with facility center point, room capacity, room square feet, and more!

FWS has been Updated!

Way back in early April we released an update to the Financial Web Service and I volunteered to blog about it. Several reminders later, head hanging in shame, I’m finally getting it done.

We made some exciting additions to the web service. There are new resources for Biennium and Biennium Search. You can search for bienniums (that’s correct, btw, I looked it up, so there) or call biennium/current, biennium/next, or biennium/previous to get the current, next, or previous biennium.

There are new resources for the Account based information in FIN:

  1. Fund
  2. Fund Search
  3. General Ledger Account
  4. General Ledger Account Search
  5. Revenue
  6. Revenue Search
  7. Expenditure
  8. Expenditure Search
  9. Account Search (which returns links to Fund, General Ledger Account, Revenue, and Expenditure resources)

The new resources are all available in xml, json, or xhtml.

We also did a few bug fixes and some more of the enhancements that you requested. For instance, we increased the maximum size of a search result set from 200 to 500.

Since the changes were all additions rather than modifications of existing elements, we kept the major version at v1.

Next time I pledge to blog sooner!