Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Student Web Service (SWS) Degree Audit API
description: Student Web Service (SWS) provides a RESTful API to access and update central student data. Subscribe to http://mailman.u.washington.edu/mailman/listinfo/sws-client-app-dev to get notifications about planned outages, support and the announcement of new features.
contact:
name: Enterprise Web Services & Events Team
url: https://itconnect.uw.edu/service/enterprise-web-services-and-events/
email: sws-support@uw.edu
version: v5
servers:
- url: /student
tags:
- name: DegreeAudit
paths:
/v5/degreeaudit:
post:
tags:
- DegreeAudit
summary: Create a Degree Audit
description: '{
"DisplayTitle" : "Degree Audit Create",
"ews_guid" : "BE01A04F-C2C3-4589-A499-E6367FE626CB",
"LongDescription" : "Create a degree audit that shows a student''s progress and plan
towards obtaining a degree",
"ShortDescription" : "Create a degree audit",
"OriginatingSchema" : [ { "source":"swssdb" }, { "source":"sdb" }, { "source":"irws" } ],
"Notes" : "This resource requires any of the following ASTRA roles:
- sws:Support
- sws:DegreeAuditSubmitter
This resource supports the following authentication types:
- X.509 Certificate
- NetID ",
"Links" : [ "https://metadata.uw.edu/Catalog/ViewItem/Term/studentdata.degree",
"https://wiki.cac.washington.edu/display/SWS/How+to+use+Degree+Audit+Resources" ],
"Synonyms" : []
}'
operationId: DegreeAuditCreate
responses:
'202':
description: Accepted
'400':
description: http body must not be null | http body length must be greater than zero | unable to parse request to create degree audit
'301':
description: MovedPermanently
'302':
description: Found
'304':
description: NotModified
'401':
description: Identity '{identity}' is not authorized to access this resource.
'405':
description: MethodNotAllowed
'500':
description: InternalServerError
'503':
description: ServiceUnavailable
get:
tags:
- DegreeAudit
summary: Search for Degree Audit for a specific person
description: '{
"DisplayTitle" : "Degree Audit Search",
"ews_guid" : "7B4C6A0F-DA28-4E2E-96BF-F0C619C32462",
"LongDescription" : "Search for degree audits for a specific person that shows a student''s progress and plan
towards obtaining degrees",
"ShortDescription" : "Search for degree audits for a specific person",
"OriginatingSchema" : [ { "source":"sdb" }, { "source":"irws" } ],
"Notes" : "This resource requires any of the following ASTRA roles:
- sws:Support
- sws:DegreeAuditSubmitter
This resource supports the following authentication types:
- X.509 Certificate
- NetID ",
"Links" : [ "https://metadata.uw.edu/Catalog/ViewItem/Term/studentdata.degree",
"https://wiki.cac.washington.edu/display/SWS/How+to+use+Degree+Audit+Resources" ],
"Synonyms" : []
}'
operationId: DegreeAuditSearch
parameters:
- name: reg_id
in: query
description: RegIDs are the authoritative unique IDs guaranteed to identify a UW person permanently. RegIDs are assigned to a person by the Identity Registration Service, the authoritative source for person data reconciled from several data sources which may represent multiple records and accounts for a single person. A given RegID will always refer to the same person, regardless of name, status or affiliation changes.
schema:
type: string
default: ''
responses:
'400':
description: 'Invalid arg: regid ID | invalid system key'
'404':
description: No degree audits found.
'200':
description: OK
content:
text/html:
schema:
$ref: '#/components/schemas/DegreeAuditSearchViewModel'
application/xml:
schema:
$ref: '#/components/schemas/DegreeAuditSearchViewModel'
text/xml:
schema:
$ref: '#/components/schemas/DegreeAuditSearchViewModel'
text/plain:
schema:
$ref: '#/components/schemas/DegreeAuditSearchViewModel'
application/json:
schema:
$ref: '#/components/schemas/DegreeAuditSearchViewModel'
text/json:
schema:
$ref: '#/components/schemas/DegreeAuditSearchViewModel'
'202':
description: Accepted
'301':
description: MovedPermanently
'302':
description: Found
'304':
description: NotModified
'401':
description: Identity '{identity}' is not authorized to access this resource.
'405':
description: MethodNotAllowed
'500':
description: InternalServerError
'503':
description: ServiceUnavailable
/v5/degreeaudit/{campus},{majorabbreviation},{pathway},{degreelevel},{degreetype},{regid}:
get:
tags:
- DegreeAudit
summary: Get a specific Degree Audit
description: '{
"DisplayTitle" : "Degree Audit",
"ews_guid" : "38D7E02F-66EA-42E8-990B-AAB6F53FA10C",
"LongDescription" : "Retrieve a specific degree audit that shows a student''s progress and plan
towards obtaining a degree",
"ShortDescription" : "Retrieve a degree audit",
"OriginatingSchema" : [ { "source":"swssdb" }, { "source":"sdb" }, { "source":"irws" } ],
"Notes" : "This resource requires any of the following ASTRA roles:
- sws:Support
- sws:DegreeAuditSubmitter
This resource supports the following authentication types:
- X.509 Certificate
- NetID
For information on programs of study to populate the parameters see the degree audit program resource.",
"Links" : [ "https://metadata.uw.edu/Catalog/ViewItem/Term/studentdata.degree",
"https://wiki.cac.washington.edu/display/SWS/How+to+use+Degree+Audit+Resources" ],
"Synonyms" : []
}'
operationId: GetDegreeAudit
parameters:
- name: campus
in: path
description: ''
required: true
schema:
type: string
- name: majorAbbreviation
in: path
description: ''
required: true
schema:
type: string
- name: pathway
in: path
description: ''
required: true
schema:
type: string
- name: degreeLevel
in: path
description: ''
required: true
schema:
type: string
- name: degreeType
in: path
description: ''
required: true
schema:
type: string
- name: regid
in: path
description: RegIDs are the authoritative unique IDs guaranteed to identify a UW person permanently. RegIDs are assigned to a person by the Identity Registration Service, the authoritative source for person data reconciled from several data sources which may represent multiple records and accounts for a single person. A given RegID will always refer to the same person, regardless of name, status or affiliation changes.
required: true
schema:
maxLength: 32
minLength: 32
type: string
responses:
'400':
description: 'Invalid arg: campus | Invalid arg: majorAbbreviation | Invalid arg: pathway | Invalid arg: degreeLevel | Invalid arg: degreeType | Invalid arg: regid ID'
'404':
description: No degree audit found. | CTC Student audits are not available via SWS DegreeAudit resource. | A pending degree audit was found. Try again later. | Term not found
'200':
description: OK
content:
text/html:
schema:
$ref: '#/components/schemas/DegreeAuditViewModel'
application/xml:
schema:
$ref: '#/components/schemas/DegreeAuditViewModel'
text/xml:
schema:
$ref: '#/components/schemas/DegreeAuditViewModel'
text/plain:
schema:
$ref: '#/components/schemas/DegreeAuditViewModel'
application/json:
schema:
$ref: '#/components/schemas/DegreeAuditViewModel'
text/json:
schema:
$ref: '#/components/schemas/DegreeAuditViewModel'
'202':
description: Accepted
'301':
description: MovedPermanently
'302':
description: Found
'304':
description: NotModified
'401':
description: Identity '{identity}' is not authorized to access this resource.
'405':
description: MethodNotAllowed
'500':
description: InternalServerError
'503':
description: ServiceUnavailable
components:
schemas:
DegreeAuditSearchResultViewModel:
type: object
properties:
DegreeAuditURI:
$ref: '#/components/schemas/DegreeAuditResourceUri'
StudentName:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"IRWS.identity.displayName\" }\n ],\n \"TechnicalDescription\": \"Student name\"\n }\n </pre>"
StudentSystemKey:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"IRWS.identity.uwStudentSystemKey\" }\n ],\n \"TechnicalDescription\": \"Student system key\"\n }\n </pre>"
DatePrepared:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.darpt/rptln\" }\n ],\n \"TechnicalDescription\": \"Listed in PREPARED header tag\"\n }\n </pre>"
additionalProperties: false
description: "{\n \"DisplayTitle\" : \"Degree Audit Search Result Model\",\n \"TargetSchema\" : [{\"target\" : \"SWS.DegreeAudit\"}]\n}"
EntryDateViewModel:
type: object
properties:
Year:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI370.csr/rsp/exe.exdt\" }\n ],\n \"TechnicalDescription\": \"Year\"\n }\n </pre>"
Quarter:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI370.csr/rsp/exe.exdt\" }\n ],\n \"TechnicalDescription\": \"Quarter\"\n }\n </pre>"
additionalProperties: false
description: "{\n \"DisplayTitle\" : \"Entry Date Model\"\n}"
DegreeAuditLine:
type: object
properties:
Line:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.darptlines/ln\" }\n ],\n \"TechnicalDescription\": \"Degree audit report line\"\n }\n </pre>"
Type:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.darptlines/typ\" },\n ],\n \"TechnicalDescription\": \"Type\"\n }\n </pre>"
additionalProperties: false
description: "{\n \"DisplayTitle\" : \"Degree Audit Line\"\n}"
PersonResourceUri:
type: object
properties:
Name:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"IRWS.identity.uwPersonPrefferredName\" },\n { \"source\":\"IRWS.identity.uwPersonRegisteredName\" }\n ],\n \"TechnicalDescription\": \"This field is resource specific\"\n }\n </pre>"
RegID:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"IRWS.identity.regid\" }\n ],\n \"TechnicalDescription\": \"UW Registration ID. This field is resource specific\"\n }\n </pre>"
Pronouns:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"IRWS.identity.uwPersonPronoun\" }\n ],\n \"TechnicalDescription\": \"\"\n }\n </pre>"
Href:
type:
- string
- 'null'
additionalProperties: false
description: "{\n \"DisplayTitle\" : \"Person Resource URI\",\n \"TargetSchema\" : [{\"target\" : \"SWS.Person\"}],\n \"TargetOperationId\" : [\"GetPerson\"]\n}"
DegreeAuditSearchViewModel:
type: object
properties:
TotalCount:
type: integer
format: int32
DegreeAudits:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DegreeAuditSearchResultViewModel'
readOnly: true
Current:
$ref: '#/components/schemas/DegreeAuditSearchResourceUri'
additionalProperties: false
description: "{\n \"DisplayTitle\" : \"Degree Audit Search Model\",\n \"TargetSchema\" : [{\"target\" : \"SWS.DegreeAudit\"}]\n}"
DegreeAuditViewModel:
type: object
properties:
Campus:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/brcd\" }\n ],\n \"TechnicalDescription\": \"Campus\"\n }\n </pre>"
DatePrepared:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/brcd\" }\n ],\n \"TechnicalDescription\": \"Date prepared\"\n }\n </pre>"
DegreeAuditReport:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DegreeAuditLine'
DegreeLevel:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/dlvl\" }\n ],\n \"TechnicalDescription\": \"Degree Level\"\n }\n </pre>"
DegreeType:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/dtyp\" }\n ],\n \"TechnicalDescription\": \"Degree Type\"\n }\n </pre>"
GraduationDate:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.darptlines/typ\" },\n { \"source\":\"SDB.SWI394.darptlines/ln\" }\n ],\n \"TechnicalDescription\": \"Graduation date is pulled from degree audit report header on line marked GRADUATION DATE\"\n }\n </pre>"
MajorAbbreviation:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/mabb\" }\n ],\n \"TechnicalDescription\": \"Major Abbreviation\"\n }\n </pre>"
Pathway:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/pth\" }\n ],\n \"TechnicalDescription\": \"Pathway\"\n }\n </pre>"
Person:
$ref: '#/components/schemas/PersonResourceUri'
ProgramEntry:
$ref: '#/components/schemas/EntryDateViewModel'
ProgramTitle:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.darptlines/typ\" },\n { \"source\":\"SDB.SWI394.darptlines/ln\" }\n ],\n \"TechnicalDescription\": \"Program title is pulled from degree audit report header on line marked PROGRAM\"\n }\n </pre>"
RegID:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/sysk\" }\n ],\n \"TechnicalDescription\": \"UW Registration ID\"\n }\n </pre>"
UWEntry:
$ref: '#/components/schemas/EntryDateViewModel'
additionalProperties: false
description: "{\n \"DisplayTitle\" : \"Degree Audit Model\",\n \"TargetSchema\" : [{\"target\" : \"SWS.DegreeAudit\"}]\n}"
DegreeAuditResourceUri:
type: object
properties:
Campus:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/brcd\" }\n ],\n \"TechnicalDescription\": \"Campus\"\n }\n </pre>"
DegreeLevel:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/dlvl\" }\n ],\n \"TechnicalDescription\": \"Degree Level\"\n }\n </pre>"
DegreeType:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/dtyp\" }\n ],\n \"TechnicalDescription\": \"Degree Type\"\n }\n </pre>"
Href:
type:
- string
- 'null'
MajorAbbreviation:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/mabb\" }\n ],\n \"TechnicalDescription\": \"Major Abbreviation\"\n }\n </pre>"
Pathway:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/pth\" }\n ],\n \"TechnicalDescription\": \"Pathway\"\n }\n </pre>"
RegID:
type:
- string
- 'null'
description: "<pre>\n {\n \"OriginatingSchema\" : [\n { \"source\":\"SDB.SWI394.dgp/sysk\" }\n ],\n \"TechnicalDescription\": \"UW Registration ID\"\n }\n </pre>"
additionalProperties: false
description: "{\n \"DisplayTitle\" : \"Degree Audit Resource URI\",\n \"TargetSchema\" : [{\"target\" : \"SWS.DegreeAudit\"}],\n \"TargetOperationId\" : [\"DegreeAuditSearch\"]\n}"
DegreeAuditSearchResourceUri:
type: object
properties:
Href:
type:
- string
- 'null'
RegID:
type:
- string
- 'null'
additionalProperties: false
description: "{\n \"DisplayTitle\" : \"Degree Audit Search Resource URI\",\n \"TargetSchema\" : [{\"target\" : \"SWS.DegreeAudit\"}],\n \"TargetOperationId\" : [\"DegreeAuditSearch\"]\n}"